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.
we should exclude also .js files? Or the library just parses .ts files?
There was a problem hiding this comment.
No needed. Also, we don't have any tests in ts, so this won't affect anything. I'll clean it up anyways.
webpack-bot
added
PR: review-outdated
and removed
PR: reviewed-changes-requested
labels
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; | |||
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 | |||
manual/webpack.config.js
Outdated
| @@ -0,0 +1,16 @@ | |||
| const ExtractTextPlugin = require("extract-text-webpack-plugin"); | |||
typedoc.js
Outdated
| name: "webpack-cli", | ||
| mode: "modules", | ||
| out: "docs", | ||
| theme: "default", |
There was a problem hiding this comment.
if the theme is default, can't we discard the prop?
webpack-bot
added
PR: reviewed-changes-requested
and removed
PR: review-outdated
labels
webpack-bot
added
PR: review-outdated
and removed
PR: reviewed-changes-requested
labels
|
@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.
more descriptive here please
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