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

typedoc.json inputFiles property not working as expected #1263

Closed
pchuong opened this issue Apr 8, 2020 · 2 comments · Fixed by #1265
Closed

typedoc.json inputFiles property not working as expected #1263

pchuong opened this issue Apr 8, 2020 · 2 comments · Fixed by #1265
Labels
bug Functionality does not match expectation

Comments

@pchuong
Copy link

pchuong commented Apr 8, 2020

Search terms

typedoc.json inputFiles

Expected Behavior

When I specified the inputFiles option in the typedoc.json file to have an array (or single) of directories such as ["./src/foo/lib", "./src/bar/lib"]. It pickup all the files in the ./src file. I expect it to only search for files in the two lib folders.

Actual Behavior

All files in the ./src folder are parsed and the generated doc contains files in other folder.

Steps to reproduce the bug

typedoc.json
{
"mode": "modules",
"out": "./docs",
"inputFiles": ["./src/foo/lib", "./src/bar/lib"]
}

Case #1: doesn't work
typedoc --options typedoc.json --tsconfig tsconfig.json

Case #2: work (with or without the inputFiles property in the typedoc.json file)
typedoc --options typedoc.json --tsconfig tsconfigjson "./src/foo/lib" "./src/bar/lib"

Environment

  • Typedoc version: 0.17.4
  • TypeScript version: 3.8.3
  • Node.js version: 12.16.1
  • OS: Windows10
@pchuong pchuong added the bug Functionality does not match expectation label Apr 8, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 8, 2020

Ah, good catch. Should be a really simple fix. The tsconfig reader should check if inputFiles is default before setting it.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 12, 2020

There's a fix for this in #1265, but it bumps the required Node version from 8.0 to 9.0 so can't be merged until 0.18 is ready (#1241).

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.

2 participants