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

Bug Fix: Allow deferring file inclusion to tsconfig.json #714

Closed
wants to merge 2 commits into from

Conversation

fabioberger
Copy link

Currently you must specify a path to your typescript project at the end of the typedoc command. Many projects already define include in their tsconfig.json files, describing which files they wish included on TS compilation. Fixing this bug allows those configs to be used rather then specifying them again from the command-line.

Example include in tsconfig.json taken from 0x.js:

"include": [
        "./src/**/*",
        "./test/**/*",
        "../../node_modules/types-bn/index.d.ts",
        "../../node_modules/types-ethereumjs-util/index.d.ts",
        "../../node_modules/web3-typescript-typings/index.d.ts",
        "../../node_modules/chai-typescript-typings/index.d.ts",
        "../../node_modules/chai-as-promised-typescript-typings/index.d.ts"
    ]

I believe this is just a bug fix since the relevant conditional could never be false given that files is initialized to an empty array.

@aciccarello
Copy link
Collaborator

Hello @fabioberger. I'm likely going to merge #610 which should fix this issue (see the change to arguments.ts. Thanks for your work though. Feel free to create an issue or reach out on gitter so that we can make sure we aren't duplicating effort.

@aciccarello aciccarello closed this Mar 3, 2018
@fabioberger
Copy link
Author

Awesome, #610 should fix my issue as well. Np, hope to contribute more soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants