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

"extends" option not working in TypeDoc config #1272

Closed
WilliamJns opened this issue Apr 19, 2020 · 0 comments · Fixed by #1273
Closed

"extends" option not working in TypeDoc config #1272

WilliamJns opened this issue Apr 19, 2020 · 0 comments · Fixed by #1273
Labels
bug Functionality does not match expectation

Comments

@WilliamJns
Copy link
Contributor

WilliamJns commented Apr 19, 2020

Search terms

In this conversation, the idea of using extends option in the config file was raised and in this pull request was implemented, I wanted to use this feature, but unfortunately, I'm having trouble using this option.

I will present the solution that I have found to solve this problem in a new pull request.

Expected Behavior

Merge all files and options together.

Steps to reproduce the bug

  1. Create a base config file to use in all typedoc configs calling base-typedoc.json.
{
  "name": "Sample Documentation",
  "readme": "./docs/index.md",
  "out": "./build-docs",
  "target": "ES5",
  "mode": "file",
  "media": "./docs/assets",
  "includeDeclarations": false,
  "ignoreCompilerErrors": true,
  "disableOutputCheck": true,
  "logger": "none",
  "theme": "sample"
}
  1. Extend the created base-typedoc.json in original typedoc.json
{
  "extends": "base-typedoc.json",
  "out": "./build-docs"
}
  1. Build the document using typedoc --options typedoc.json.

Environment

  • Typedoc version: 0.17.3
  • TypeScript version: 3.8.3
  • Node.js version: 12.16.1
  • OS: MacOS Catalina 10.15.4
@WilliamJns WilliamJns added the bug Functionality does not match expectation label Apr 19, 2020
@WilliamJns WilliamJns changed the title "extends" option not working in config "extends" option not working in TypeDoc config Apr 19, 2020
Gerrit0 pushed a commit that referenced this issue Apr 25, 2020
Clone typedoc options object after loading file content.

Closes #1272
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant