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

multiple: improved completion for choices #2083

Merged
merged 2 commits into from Dec 29, 2021
Merged

multiple: improved completion for choices #2083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
897156f
Improved completion for choices
Dec 2, 2021
0a8d069
Merge branch 'main' into choices-completion-improvements
bcoe Dec 29, 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
32 changes: 22 additions & 10 deletions lib/completion.ts
View file
Open in desktop
Expand Up @@ -153,21 +153,33 @@ export class Completion implements CompletionInstance {
let previousArg = args[args.length - 1];
let filter = '';
// use second to last argument if the last one is not an option starting with --
if (!previousArg.startsWith('--') && args.length > 1) {
if (!previousArg.startsWith('-') && args.length > 1) {
filter = previousArg; // use last arg as filter for choices
previousArg = args[args.length - 2];
}
if (!previousArg.startsWith('--')) return; // still no valid arg, abort
const previousArgKey = previousArg.replace(/-/g, '');
if (!previousArg.startsWith('-')) return; // still no valid arg, abort
const previousArgKey = previousArg.replace(/^-+/, '');

const options = this.yargs.getOptions();
if (
Object.keys(options.key).some(key => key === previousArgKey) &&
Array.isArray(options.choices[previousArgKey])
) {
return options.choices[previousArgKey].filter(
choice => !filter || choice.startsWith(filter)
);

const possibleAliases = [
previousArgKey,
...(this.yargs.getAliases()[previousArgKey] || []),
];
let choices: string[] | undefined;
// Find choices across all possible aliases
for (const possibleAlias of possibleAliases) {
if (
Object.prototype.hasOwnProperty.call(options.key, possibleAlias) &&
Array.isArray(options.choices[possibleAlias])
) {
choices = options.choices[possibleAlias];
break;
}
}

if (choices) {
return choices.filter(choice => !filter || choice.startsWith(filter));
}
}

Expand Down
80 changes: 80 additions & 0 deletions test/completion.cjs
View file
Open in desktop
Expand Up @@ -373,6 +373,86 @@ describe('Completion', () => {
r.logs.should.not.include('banana');
r.logs.should.not.include('pear');
});

it('completes choices if previous option or one of its aliases requires a choice', () => {
process.env.SHELL = '/bin/bash';
const r = checkUsage(() => {
return yargs([
'./completion',
'--get-yargs-completions',
'./completion',
'-f',
])
.options({
fruit: {
alias: ['f', 'not-a-vegetable'],
describe: 'fruit option',
choices: ['apple', 'banana', 'pear'],
},
amount: {describe: 'amount', type: 'number'},
})
.completion('completion', false).argv;
});

r.logs.should.have.length(3);
r.logs.should.include('apple');
r.logs.should.include('banana');
r.logs.should.include('pear');
});

it('completes choices if previous option or one of its aliases requires a choice and space has been entered', () => {
process.env.SHELL = '/bin/bash';
const r = checkUsage(() => {
return yargs([
'./completion',
'--get-yargs-completions',
'./completion',
'--not-a-vegetable',
'',
])
.options({
fruit: {
alias: ['f', 'not-a-vegetable'],
describe: 'fruit option',
choices: ['apple', 'banana', 'pear'],
},
amount: {describe: 'amount', type: 'number'},
})
.completion('completion', false).argv;
});

r.logs.should.have.length(3);
r.logs.should.include('apple');
r.logs.should.include('banana');
r.logs.should.include('pear');
});

it('completes choices if previous option or one of its aliases requires a choice and a partial choice has been entered', () => {
process.env.SHELL = '/bin/bash';
const r = checkUsage(() => {
return yargs([
'./completion',
'--get-yargs-completions',
'./completion',
'-f',
'ap',
])
.options({
fruit: {
alias: 'f',
describe: 'fruit option',
choices: ['apple', 'banana', 'pear'],
},
amount: {describe: 'amount', type: 'number'},
})
.completion('completion', false).argv;
});

r.logs.should.have.length(1);
r.logs.should.include('apple');
r.logs.should.not.include('banana');
r.logs.should.not.include('pear');
});
});

describe('generateCompletionScript()', () => {
Expand Down