-
-
Notifications
You must be signed in to change notification settings - Fork 597
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
docs(typedoc): add ts docs #571
Conversation
@ev1stensberg The issue was because typedoc doesn't work with monorepos out-of-the-box. Notice the config file. module.exports = {
name: "webpack-cli",
mode: "modules",
out: "docs",
theme: "default",
exclude: "*.test.ts",
"external-modulemap": ".*packages\/(@webpack-cli\/[^\/]+)\/.*"
}; |
Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon. |
typedoc.js
Outdated
mode: "modules", | ||
out: "docs", | ||
theme: "default", | ||
exclude: "*.test.ts", |
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.
we should exclude also .js files? Or the library just parses .ts files?
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.
No needed. Also, we don't have any tests in ts, so this won't affect anything. I'll clean it up anyways.
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 looks good to me. Apart one thing: we don't want to commit .map files. There's a css.map that we can exclude. After addressed that, we could potentially push.
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.
Cleaned the map files.
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're on a old branch most likely, do a rebase and I'll have another look
bin/prompt-command.js
Outdated
@@ -30,21 +30,21 @@ const runCommand = (command, args) => { | |||
|
|||
module.exports = function promptForInstallation(packages, ...args) { | |||
const nameOfPackage = "@webpack-cli/" + packages; | |||
let packageIsInstalled = false; | |||
let packageIsInstalled = true; |
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.
hmmmm 🇼🇸
bin/prompt-command.js
Outdated
@@ -105,6 +105,6 @@ module.exports = function promptForInstallation(packages, ...args) { | |||
} | |||
}); | |||
} else { | |||
require(pathForCmd).default(...args); // eslint-disable-line | |||
require('../packages/migrate').default(...args); // eslint-disable-line |
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.
🤔
manual/webpack.config.js
Outdated
@@ -0,0 +1,16 @@ | |||
const ExtractTextPlugin = require("extract-text-webpack-plugin"); |
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.
👎
typedoc.js
Outdated
name: "webpack-cli", | ||
mode: "modules", | ||
out: "docs", | ||
theme: "default", |
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.
if the theme is default, can't we discard the prop?
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.
Agreed. Cleaned.
@dhruvdutt Thanks for your update. I labeled the Pull Request so reviewers will review it again. @ev1stensberg Please review the new changes. |
.gitignore
Outdated
@@ -33,3 +33,6 @@ lerna-debug.log | |||
|
|||
# Yarn lock file | |||
yarn.lock | |||
|
|||
# docs map |
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.
more descriptive here please
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.
Looks extremely good overall to me. Fix the comment and it's lgtm. 🍧
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.
Rebased and ready to merge.
What kind of change does this PR introduce?
Docs
Did you add tests for your changes?
If relevant, did you update the documentation?
Yes
Summary
Final piece of the TypeScript migration process. 💯
Does this PR introduce a breaking change?
Other information
Closes #551