Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support typedoc.json "extends" #493

Closed
DennisJaamann opened this issue May 2, 2017 · 1 comment · Fixed by dbartholomae/redux-dynamic-modules-beacon#25 or gpicron/ssb-subjective-group#1
Labels
enhancement Improved functionality

Comments

@DennisJaamann
Copy link

DennisJaamann commented May 2, 2017

Add support for creating extended typedoc.json files.

This functionality already exists for:

  • TypeScript configs
  • TsLint configs

So why not do the same for typedoc when we want for example a company wide configuration for typedocs with the same theme etc preconfigured.

Example:

node_modules/@somecompany/somelib/typedoc.json

{
  "mode": "file",
  "module": "commonjs",
  "theme": "default",
  "out": "docs",
  "target": "ES5",
  "moduleResolution": "node",
  "includeDeclarations":"false",
  "ignoreCompilerErrors": "true",
  "experimentalDecorators": "true",
  "externalPattern":"**/*.d.ts",
  "excludeExternals":"true",
  "emitDecoratorMetadata": "true",
  "preserveConstEnums": "true",
  "stripInternal": "true",
  "suppressExcessPropertyErrors": "true",
  "suppressImplicitAnyIndexErrors": "true"
}

someprojectusingsomelib/typedoc.json

{
  "extends": "@somecompany/somelib/typedoc.json"
}

Currently, there is a way of achieving this but it feels rather cumbersome / not community standard in comparison with tools such as typescript or tslint.

 "scripts": {
    "docs": "npm run typedoc -- --options node_modules/@somecompany/somelib/typedoc.json ./src/",
    "typedoc": "typedoc"
  },
@aciccarello aciccarello added the enhancement Improved functionality label May 2, 2017
@aciccarello
Copy link
Collaborator

Cool idea. PRs welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
2 participants