Skip to content
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

Jump to bottom

.showHelp() and .getHelp() now return same output for commands as --help #1826

Merged
merged 21 commits into from Mar 6, 2021
Merged

.showHelp() and .getHelp() now return same output for commands as --help #1826

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
77752b0
Standardx 7.0.0
OsmanAltun Dec 8, 2020
380782d
Fix help output with default command
OsmanAltun Dec 8, 2020
80edee1
Fix help/version option description not showing
OsmanAltun Dec 8, 2020
ecd0d4a
Fix showhelp calling default command handler
OsmanAltun Dec 8, 2020
f01caa5
Merge branch 'master' into master
OsmanAltun Dec 9, 2020
f8f767a
Added commands function (similar to options function)
OsmanAltun Dec 9, 2020
95653d0
Merge branch 'master' into master
bcoe Jan 4, 2021
7409a06
Merge branch 'master' of https://github.com/yargs/yargs
OsmanAltun Jan 11, 2021
09066a1
Merge branch 'master' into master
bcoe Feb 23, 2021
15357c2
Merge branch 'master' into master
bcoe Feb 23, 2021
6f3d65b
npm run fix
OsmanAltun Feb 24, 2021
2c6e184
Implement feedback and add tests
OsmanAltun Mar 2, 2021
97e5ded
Merge branch 'fix-883'
OsmanAltun Mar 2, 2021
4960f69
Revert "Fix help output with default command"
OsmanAltun Mar 2, 2021
e7464e0
Move freeze to root function
OsmanAltun Mar 3, 2021
2dea21d
Remove boiler
OsmanAltun Mar 3, 2021
5619c9e
Small change
OsmanAltun Mar 3, 2021
2257426
refactor: call unfreeze after reset
bcoe Mar 4, 2021
056d175
test: add a couple test cases; avoid singleton
bcoe Mar 4, 2021
7cd9772
chore: revert unrelated change
bcoe Mar 4, 2021
6e2da35
fix: .argv should use same code path
bcoe Mar 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 31 additions & 18 deletions lib/command.ts
View file
Open in desktop
Expand Up @@ -219,6 +219,9 @@ export function command(
let numFiles = currentContext.files.length;
const parentCommands = currentContext.commands.slice();

const tmpCommands = yargs.getUsageInstance().getCommands();
const tmpUsage = yargs.getUsageInstance().getUsage();

// what does yargs look like after the builder is run?
let innerArgv: Arguments | Promise<Arguments> = parsed.argv;
let positionalMap: Dictionary<string[]> = {};
Expand All @@ -233,15 +236,20 @@ export function command(
const builderOutput = builder(yargs.reset(parsed.aliases));
const innerYargs = isYargsInstance(builderOutput) ? builderOutput : yargs;
if (shouldUpdateUsage(innerYargs)) {
innerYargs
.getUsageInstance()
.usage(
usageFromParentCommandsCommandHandler(
parentCommands,
commandHandler
),
commandHandler.description
);
if (!command) {
tmpCommands.forEach(e => innerYargs.getUsageInstance().command(...e));
tmpUsage.forEach(e => innerYargs.getUsageInstance().usage(...e));
} else {
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
innerYargs
.getUsageInstance()
.usage(
usageFromParentCommandsCommandHandler(
parentCommands,
commandHandler
),
commandHandler.description
);
}
}
innerArgv = innerYargs._parseArgs(null, null, true, commandIndex);
aliases = (innerYargs.parsed as DetailedArguments).aliases;
Expand All @@ -250,15 +258,20 @@ export function command(
// the options that a command takes.
const innerYargs = yargs.reset(parsed.aliases);
if (shouldUpdateUsage(innerYargs)) {
innerYargs
.getUsageInstance()
.usage(
usageFromParentCommandsCommandHandler(
parentCommands,
commandHandler
),
commandHandler.description
);
if (!command) {
tmpCommands.forEach(e => innerYargs.getUsageInstance().command(...e));
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
tmpUsage.forEach(e => innerYargs.getUsageInstance().usage(...e));
} else {
innerYargs
.getUsageInstance()
.usage(
usageFromParentCommandsCommandHandler(
parentCommands,
commandHandler
),
commandHandler.description
);
}
}
Object.keys(commandHandler.builder).forEach(key => {
innerYargs.option(key, builder[key]);
Expand Down
8 changes: 6 additions & 2 deletions lib/usage.ts
View file
Open in desktop
Expand Up @@ -526,10 +526,14 @@ export function usage(yargs: YargsInstance, y18n: Y18N, shim: PlatformShim) {
(Object.keys(options.alias) || []).forEach(key => {
options.alias[key].forEach(alias => {
// copy descriptions.
if (descriptions[alias]) self.describe(key, descriptions[alias]);
if (descriptions[alias])
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
self.describe(key, descriptions[key] || descriptions[alias]);
// copy demanded.
if (alias in demandedOptions)
yargs.demandOption(key, demandedOptions[alias]);
yargs.demandOption(
key,
demandedOptions[key] || demandedOptions[alias]
);
// type messages.
if (~options.boolean.indexOf(alias)) yargs.boolean(key);
if (~options.count.indexOf(alias)) yargs.count(key);
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Expand Up @@ -71,14 +71,14 @@
"rimraf": "^3.0.2",
"rollup": "^2.23.0",
"rollup-plugin-cleanup": "^3.1.1",
"standardx": "^5.0.0",
"standardx": "^7.0.0",
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
"typescript": "^4.0.2",
"which": "^2.0.0",
"yargs-test-extends": "^1.0.1"
},
"scripts": {
"fix": "gts fix && npm run fix:js",
"fix:js": "standardx --fix '**/*.mjs' && standardx --fix '**/*.cjs' && standardx --fix './*.mjs' && standardx --fix './*.cjs'",
"fix:js": "standardx --fix **/*.mjs && standardx --fix **/*.cjs && standardx --fix ./*.mjs && standardx --fix ./*.cjs",
"posttest": "npm run check",
"test": "c8 mocha ./test/*.cjs --require ./test/before.cjs --timeout=12000 --check-leaks",
"test:esm": "c8 mocha ./test/esm/*.mjs --check-leaks",
Expand All @@ -90,7 +90,7 @@
"build:cjs": "rollup -c rollup.config.cjs",
"postbuild:cjs": "rimraf ./build/index.cjs.d.ts",
"check": "gts lint && npm run check:js",
"check:js": "standardx '**/*.mjs' && standardx '**/*.cjs' && standardx './*.mjs' && standardx './*.cjs'",
"check:js": "standardx **/*.mjs && standardx **/*.cjs && standardx ./*.mjs && standardx ./*.cjs",
"clean": "gts clean"
},
"repository": {
Expand Down
7 changes: 4 additions & 3 deletions test/usage.cjs
View file
Open in desktop
Expand Up @@ -2575,13 +2575,14 @@ describe('usage tests', () => {
r.logs[0]
.split('\n')
.should.deep.equal([
'usage',
'usage [command]',
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
'',
'do something',
'Commands:',
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved
' usage do something [default]',
'',
'Options:',
' --version Show version number [boolean]',
' -h, --help Show help [boolean]',
' -h, --help Show help [boolean]'
]);
});
});
Expand Down