fix: completion should play well with strip-dashed

yargs · May 10, 2023 · 095fdd8 · 095fdd8
1 parent f9ed905
commit 095fdd8
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 11 deletions.
diff --git a/lib/yargs-factory.ts b/lib/yargs-factory.ts
@@ -2051,7 +2051,16 @@ export class YargsInstance {
  this.#isGlobalContext = false;
 
  const handlerKeys = this.#command.getCommands();
- const requestCompletions = this.#completion!.completionKey in argv;
+
+ const requestCompletions = this.#completion?.completionKey
+ ? [
+ this.#completion?.completionKey,
+ ...(this.getAliases()[this.#completion?.completionKey] ?? []),
+ ].some((key: string) =>
+ Object.prototype.hasOwnProperty.call(argv, key)
+ )
+ : false;
+
  const skipRecommendation = helpOptSet || requestCompletions || helpOnly;
  if (argv._.length) {
  if (handlerKeys.length) {

diff --git a/test/completion.cjs b/test/completion.cjs
@@ -1212,17 +1212,24 @@ describe('Completion', () => {
  });
 
  describe('parser-configuration', () => {
- it('should support strip-dashed', () => {
- process.env.SHELL = '/bin/bash';
+ const configurations = [
+ {'strip-dashed': true},
+ {'camel-case-expansion': true, 'strip-aliased': true},
+ ];
 
- const r = checkUsage(
- () =>
- yargs(['--get-yargs-completions', 'a'])
- .parserConfiguration({'strip-dashed': true})
- .command('apple', 'banana').argv
- );
+ for (const configuration of configurations) {
+ it(`should support ${Object.keys(configuration).join(' ')}`, () => {
+ process.env.SHELL = '/bin/bash';
 
- r.logs.should.include('apple');
- });
+ const r = checkUsage(
+ () =>
+ yargs(['--get-yargs-completions', 'a'])
+ .parserConfiguration(configuration)
+ .command('apple', 'banana').argv
+ );
+
+ r.logs.should.include('apple');
+ });
+ }
  });
 });