RolandJansen/intermix.js

View on GitHub
tsconfig.json

Summary

Maintainability
Test Coverage
{
    "$schema": "http://json.schemastore.org/tsconfig",
    "compilerOptions": {
        // Reference:
        // https://www.typescriptlang.org/docs/handbook/compiler-options.html
        // https://www.typescriptlang.org/docs/handbook/tsconfig-json.html

        // 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:
        "outDir": "./build", // redirect output to this relative path
        "module": "ES2020",  // module system used in the output files
        "target": "ES2015",  // ECMA Script target version
        "sourceMap": true,   // generate source map files (*.map)
        "declaration": true, // generate typings (*.d.ts)
        "declarationMap": true // useful for API extractor error messages

        // Not in use but sometimes handy for config tests:
        // "allowSyntheticDefaultImports": true,
        // "declarationDir": "build",
    },
    "files": [
        "./src/index.ts"
    ],
    "typedocOptions": {
        "mode": "modules",
        // "mode": "library",
        // "entryPoint": "src/index.ts",
        "excludePrivate": true,
        "excludeProtected": true,
        "excludeNotExported": true,
        "exclude": [
            "src/fileLoader.ts",
            "src/helper.ts",
            "src/interfaces/*",
            "src/plugins/**/*",
            "src/registry/*",
            "src/seqpart/*",
            "src/store/*"
        ],
        "out": "doc",
        "disableSources": true,
        "readme": "none"
    }
}