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

Have the typescript package perform as much processing of the configuration file as possible. #359

Merged
merged 2 commits into from
Dec 19, 2016

Conversation

lddubeau
Copy link
Contributor

This is proposed to fix #326. It may also have an impact on some of the other issues in #301.

This is not a complete PR yet but I'd like some help before moving forward. I quickly discovered while working on this that there is currently no test in the test suite that covers the code I changed. (I know because I had some pretty big errors when I copy-pasted into typedoc's codebase the code from the prototype file I created to figure how I'd load a tsconfig.json outside tsc. The big errors I had did not cause any test failure!) I'm not sure though what kinds of tests are desired. Should I create an Application, and check whether it is seeing the right configuration options? Is there a better way to do this?

(The first commit in this PR is fixing the same problem as in #353. I need it there, otherwise the code does not compile. I'll remove it once #353 is merged.)

Offload as much of the work as possible to the TypeScript API. By doing
things this way, typedoc sees the same configuration as what `tsc`
would, and benefits from TypeScript's interpretation of new features in
the `tsconfig.json` file. For instance, globs in `include` and `exclude`.
@@ -1,6 +1,7 @@
import * as ts from "typescript";
import * as _ts from "../ts-internal";
import * as Path from "path";
import * as _ from "lodash";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to note that this is also a part of #353.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I wrote in the initial submission: "The first commit in this PR is fixing the same problem as in #353. I need it there, otherwise the code does not compile. I'll remove it once #353 is merged."

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.

Typedoc doesn't work with include globs
3 participants