tsconfig-base.json

{
    /**
     * This is the base configuration for typescript.
     * It is extended by
     *     "tsconfig-esm.json" for ES2020 module generation
     *     "tsconfig-cjs.json" for CommonJS module generation
     * References:
     * https://www.typescriptlang.org/docs/handbook/compiler-options.html
     * https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
     */
    "compilerOptions": {
        // Compile behaviour:
        "noEmitOnError": true,   // do not emit outputs if errors were reported
        "strict": true,          // enable all strict type checking options
        "forceConsistentCasingInFileNames": true, // disallow inconsistently-cased references to the same file
        "esModuleInterop": true, // better compatibility with bundlers/transpilers
        "lib": [ "dom", "es7" ], // used to get es7 lang features like [].includes()

        // Input options:
        "moduleResolution": "node", // search for imports in node_modules

        // Output options:
        "target": "ES2015",  // ECMA Script target version
        // "sourceMap": true,   // generate source map files (*.map)
        "declaration": true, // generate typings (*.d.ts)

        // Not in use but sometimes handy for config tests:
        // "declarationMap": true,
        // "declarationDir": "build",
    },
    "files": [
        "./src/index.ts",
    ],
    "typedocOptions": {
        "mode": "modules",
        "out": "doc",
        "excludePrivate": true,
        "excludeProtected": true,
        "json": "data/api.json"
    }
}