-
Notifications
You must be signed in to change notification settings - Fork 134
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
Add new package for loading tsdoc-config.json file #196
Conversation
…aining package.json
5aea91f
to
d89d2c5
Compare
@@ -0,0 +1,59 @@ | |||
{ | |||
"name": "@microsoft/tsdoc-config", | |||
"version": "0.12.15", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a weird version. Is this package expected to stay in lockstep with the tsdoc
package?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that would be best, but I'll set up the version policy in a separate PR, since it may alter the CI scripts.
@@ -0,0 +1,2 @@ | |||
registry=https://registry.npmjs.org/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this file necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was just copied from the other projects in the repo. Probably they should all be removed. But let's deal with that in a separate PR.
private static _findConfigPathForFolder(folderPath: string): string { | ||
if (folderPath) { | ||
let foundFolder: string = folderPath; | ||
for (;;) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ew.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Infinite loops are the One True Loop Style! (1TLS) do/while are degenerate special cases. 😊
@@ -0,0 +1,36 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't want to pull RSC into this repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's been useful to have a counterexample of a minimalist toolchain. I'd consider heft, though.
Initial sketch of the tsdoc-config.json feature proposed in RFC #7.
Because the loader relies on NodeJS libraries as well as
resolve
andajv
, I put this code in a separate NPM package@microsoft/tsdoc-config
. That way@microsoft/tsdoc
can remain fully self-contained and portable.@ecraig12345