tsconfig.json

{
  "compilerOptions": {
    // We use ECMAScript 2017 language features such as async/await. We rely on Babel for transpiling to older
    // JavaScript where necessary.
    "target": "es2017",

    // If we were to use Parcel to transpile our TypeScript assets, see the configuration at:
    // https://github.com/fschopp/project-planning-for-you-track/blob/v0.9.0/tsconfig.json

    // Enable all strict type-checking options.
    "strict": true,

    "declaration": true,
    "declarationMap": true,
    "sourceMap": true,
    "outDir": "target",
    "moduleResolution": "node",

    // Allow to import CommonJS modules using the regular syntax (as opposed to "import = require('module')")
    "esModuleInterop": true,

    "jsx": "preserve",
    "jsxFactory": "Surplus"
  },
  "files": [
    // From https://www.typescriptlang.org/docs/handbook/tsconfig-json.html:
    // "Any files that are referenced by files included via the "files" or "include" properties are also included."
    // It is therefore sufficient to list the main file here.

    // For TypeDoc, any file explicitly listed here is "internal", all other files are "external". That terminology is
    // somewhat confusing -- "internal" in the TypeDoc terminology refers to our own classes, "external" to third-party
    // code. However, by listing only those files here that either (a) contain documentation or (b) contain no
    // documentation but transitively include everything else, we can conveniently exclude documenting those pieces that
    // are not meant to be exported (with option "excludeExternals").
    "src/main/components/alerts/alerts-ctrl.ts",
    "src/main/components/alerts/alerts-model.ts",
    "src/main/components/alerts/alerts-view.tsx",

    "src/main/components/app/app-ctrl.ts",
    "src/main/components/app/app-model.ts",

    "src/main/components/base-views.tsx",

    "src/main/components/contributor/contributor-model.ts",

    "src/main/components/contributors/contributors-ctrl.ts",
    "src/main/components/contributors/contributors-model.ts",
    "src/main/components/contributors/contributors-view.tsx",

    "src/main/components/depends-link-type/depends-link-type-model.ts",
    "src/main/components/depends-link-type/depends-link-type-view.tsx",

    "src/main/components/nav/nav-view.tsx",

    "src/main/components/project-planning-app/project-planning-app-ctrl.ts",
    "src/main/components/project-planning-app/project-planning-app-model.ts",
    "src/main/components/project-planning-app/project-planning-app-view.ts",

    "src/main/components/project-planning-settings/project-planning-settings-ctrl.ts",
    "src/main/components/project-planning-settings/project-planning-settings-model.ts",
    "src/main/components/project-planning-settings/project-planning-settings-view.tsx",

    "src/main/components/router.ts",

    "src/main/components/settings/settings-ctrl.ts",
    "src/main/components/settings/settings-model.ts",
    "src/main/components/settings/settings-view.tsx",

    "src/main/components/warnings/warnings-view.tsx",

    "src/main/components/you-track-base-views.tsx",

    "src/main/components/you-track-metadata/you-track-metadata-ctrl.ts",
    "src/main/components/you-track-metadata/you-track-metadata-model.ts",

    "src/main/index.ts",
    "src/main/utils/counter.ts",
    "src/main/utils/s.ts",
    "src/main/utils/surplus.ts",
    "src/main/utils/typescript.ts",

    // Note that this file should not have any exported symbols, or otherwise TypeDoc would pick those up (see previous
    // comment).
    "src/demo/index.ts"
  ],
  "typedocOptions": {
    "excludePrivate": true,
    "excludeExternals": true,
    "excludeNotExported": true,
    "mode": "file",
    "out": "target/doc"
  }
}