3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-04 20:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(cli): output help when no conventional config + no subcommand (#9648)

Browse source
This commit is contained in:
Joshua Chen 2023-12-21 06:28:37 -05:00 • committed by GitHub
parent affca7a9a2
commit 60d62d1d65
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
packages/docusaurus/bin/docusaurus.mjs
View file

@ -218,6 +218,9 @@ cli.arguments('<command>').action((cmd) => {
logger.error` Unknown command name=${cmd}.`;
});
// === The above is the commander configuration ===
// They don't start any code execution yet until cli.parse() is called below
/**
* @param {string | undefined} command
*/
@ -237,12 +240,29 @@ function isInternalCommand(command) {
);
}
if (!isInternalCommand(process.argv.slice(2)[0])) {
await externalCommand(cli);
// process.argv always looks like this:
// [
// '/path/to/node',
// '/path/to/docusaurus.mjs',
// '<subcommand>',
// ...subcommandArgs
// ]
// There is no subcommand
// TODO: can we use commander to handle this case?
if (process.argv.length < 3 || process.argv[2]?.startsWith('--')) {
cli.outputHelp();
process.exit(1);
}
if (!process.argv.slice(2).length) {
cli.outputHelp();
// There is an unrecognized subcommand
// Let plugins extend the CLI before parsing
if (!isInternalCommand(process.argv[2])) {
// TODO: in this step, we must assume default site structure because there's
// no way to know the siteDir/config yet. Maybe the root cli should be
// responsible for parsing these arguments?
// https://github.com/facebook/docusaurus/issues/8903
await externalCommand(cli);
}
cli.parse(process.argv);