Skip to content

fix(cli): Fix bad docusaurus CLI behavior on for --version, -V, --help, -h #10368

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.

Sign up for GitHub

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

Merged
slorber merged 4 commits into from
Aug 8, 2024
Merged

fix(cli): Fix bad docusaurus CLI behavior on for --version, -V, --help, -h #10368

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fd5b3a
fixed bug npx docusaurus --version incorrect program termination stat…
ashiq-firoz Aug 3, 2024
427c3f2
fix Docusaurus CLI
slorber Aug 8, 2024
c75078a
Fix calling docusaurus CLI with no command
slorber Aug 8, 2024
556df66
add exit(1) for bad command names
slorber Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions packages/docusaurus/bin/docusaurus.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,8 @@ cli

cli.arguments('<command>').action((cmd) => {
cli.outputHelp();
logger.error` Unknown command name=${cmd}.`;
logger.error`Unknown Docusaurus CLI command name=${cmd}.`;
process.exit(1);
});

// === The above is the commander configuration ===
Expand All @@ -247,24 +248,24 @@ function isInternalCommand(command) {
);
}

// process.argv always looks like this:
// [
// '/path/to/node',
// '/path/to/docusaurus.mjs',
// '<subcommand>',
// ...subcommandArgs
// ]
/**
* @param {string | undefined} command
*/
function isExternalCommand(command) {
return !!(command && !isInternalCommand(command) && !command.startsWith('-'));
}

// There is no subcommand
// TODO: can we use commander to handle this case?
if (process.argv.length < 3 || process.argv[2]?.startsWith('--')) {
// No command? We print the help message because Commander doesn't
// Note argv looks like this: ['../node','../docusaurus.mjs','<command>',...rest]
if (process.argv.length < 3) {
cli.outputHelp();
logger.error`Please provide a Docusaurus CLI command.`;
process.exit(1);
}

// There is an unrecognized subcommand
// Let plugins extend the CLI before parsing
if (!isInternalCommand(process.argv[2])) {
if (isExternalCommand(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?
Expand Down