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

Allow calling standard completion function from custom one #1855

Merged
merged 5 commits into from Feb 17, 2021
Merged

Allow calling standard completion function from custom one #1855

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bbfc243
feat: allow calling standard completion function from custom one
tkarls Nov 24, 2017
46c2c6c
fix: improve test coverage for completions
gardenappl Jan 24, 2021
ea18d61
Merge branch 'master' into enable-fallback-to-standard-completion
bcoe Feb 15, 2021
486532d
fix: Refactor completion.ts, properly detect aliases
gardenappl Feb 16, 2021
fe83776
Merge branch 'master' into enable-fallback-to-standard-completion
bcoe Feb 17, 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
174 changes: 103 additions & 71 deletions lib/completion.ts
View file
Open in desktop
Expand Up @@ -34,6 +34,78 @@ export function completion(
const current = args.length ? args[args.length - 1] : '';
const argv = yargs.parse(args, true);
const parentCommands = yargs.getContext().commands;

function defaultCompletion(): Arguments | void {
const handlers = command.getCommandHandlers();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would be tempted to pull each of these major pieces of logic into a helper function within completion.ts:

  • commandCompletions?
  • optionCompletions?
  • customCompletions?

for (let i = 0, ii = args.length; i < ii; ++i) {
if (handlers[args[i]] && handlers[args[i]].builder) {
const builder = handlers[args[i]].builder;
if (isCommandBuilderCallback(builder)) {
const y = yargs.reset();
builder(y);
return y.argv;
}
}
}
if (
!current.match(/^-/) &&
parentCommands[parentCommands.length - 1] !== current
) {
usage.getCommands().forEach(usageCommand => {
const commandName = parseCommand(usageCommand[0]).cmd;
if (args.indexOf(commandName) === -1) {
if (!zshShell) {
completions.push(commandName);
} else {
const desc = usageCommand[1] || '';
completions.push(commandName.replace(/:/g, '\\:') + ':' + desc);
}
}
});
}
if (current.match(/^-/) || (current === '' && completions.length === 0)) {
const descs = usage.getDescriptions();
const options = yargs.getOptions();
Object.keys(options.key).forEach(key => {
const negable =
!!options.configuration['boolean-negation'] &&
options.boolean.includes(key);
// If the key and its aliases aren't in 'args', add the key to 'completions'
let keyAndAliases = [key].concat(aliases[key] || []);
if (negable)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's this block especially where I think we'd benefit from a bit more decomposition. Could completeOptionKey could be pulled out to the top level of the file, along with us breaking apart defaultCompletion into a couple more helpers?

I think if we then add comments to each of the helpers, the completion logic might become easier to consume.

keyAndAliases = keyAndAliases.concat(
keyAndAliases.map(key => `no-${key}`)
);
function completeOptionKey(key: string) {
const notInArgs = keyAndAliases.every(
val => args.indexOf(`--${val}`) === -1
);
if (notInArgs) {
const startsByTwoDashes = (s: string) => /^--/.test(s);
const isShortOption = (s: string) => /^[^0-9]$/.test(s);
const dashes =
!startsByTwoDashes(current) && isShortOption(key) ? '-' : '--';
if (!zshShell) {
completions.push(dashes + key);
} else {
const desc = descs[key] || '';
completions.push(
dashes +
`${key.replace(/:/g, '\\:')}:${desc.replace(
'__yargsString__:',
''
)}`
);
}
}
}
completeOptionKey(key);
if (negable && !!options.default[key]) completeOptionKey(`no-${key}`);
});
}
done(null, completions);
}

// a custom completion function can be provided
// to completion().
function runCompletionFunction(argv: Arguments) {
Expand All @@ -58,9 +130,19 @@ export function completion(
}
// synchronous completion function.
return done(null, result);
} else if (isFallbackCompletionFunction(completionFunction)) {
const fallbackCompletionFunction = completionFunction as FallbackCompletionFunction;
return fallbackCompletionFunction(
current,
argv,
defaultCompletion,
completions => {
done(null, completions);
}
);
} else {
// asynchronous completion function
return completionFunction(current, argv, completions => {
const asyncCompletionFunction = completionFunction as AsyncCompletionFunction;
return asyncCompletionFunction(current, argv, completions => {
done(null, completions);
});
}
Expand All @@ -69,75 +151,9 @@ export function completion(
return isPromise(argv)
? argv.then(runCompletionFunction)
: runCompletionFunction(argv);
} else {
return defaultCompletion();
}
const handlers = command.getCommandHandlers();
for (let i = 0, ii = args.length; i < ii; ++i) {
if (handlers[args[i]] && handlers[args[i]].builder) {
const builder = handlers[args[i]].builder;
if (isCommandBuilderCallback(builder)) {
const y = yargs.reset();
builder(y);
return y.argv;
}
}
}
if (
!current.match(/^-/) &&
parentCommands[parentCommands.length - 1] !== current
) {
usage.getCommands().forEach(usageCommand => {
const commandName = parseCommand(usageCommand[0]).cmd;
if (args.indexOf(commandName) === -1) {
if (!zshShell) {
completions.push(commandName);
} else {
const desc = usageCommand[1] || '';
completions.push(commandName.replace(/:/g, '\\:') + ':' + desc);
}
}
});
}
if (current.match(/^-/) || (current === '' && completions.length === 0)) {
const descs = usage.getDescriptions();
const options = yargs.getOptions();
Object.keys(options.key).forEach(key => {
const negable =
!!options.configuration['boolean-negation'] &&
options.boolean.includes(key);
// If the key and its aliases aren't in 'args', add the key to 'completions'
let keyAndAliases = [key].concat(aliases[key] || []);
if (negable)
keyAndAliases = keyAndAliases.concat(
keyAndAliases.map(key => `no-${key}`)
);
function completeOptionKey(key: string) {
const notInArgs = keyAndAliases.every(
val => args.indexOf(`--${val}`) === -1
);
if (notInArgs) {
const startsByTwoDashes = (s: string) => /^--/.test(s);
const isShortOption = (s: string) => /^[^0-9]$/.test(s);
const dashes =
!startsByTwoDashes(current) && isShortOption(key) ? '-' : '--';
if (!zshShell) {
completions.push(dashes + key);
} else {
const desc = descs[key] || '';
completions.push(
dashes +
`${key.replace(/:/g, '\\:')}:${desc.replace(
'__yargsString__:',
''
)}`
);
}
}
}
completeOptionKey(key);
if (negable && !!options.default[key]) completeOptionKey(`no-${key}`);
});
}
done(null, completions);
};

// generate the completion script to add to your .bashrc.
Expand Down Expand Up @@ -180,7 +196,8 @@ export interface CompletionInstance {

export type CompletionFunction =
| SyncCompletionFunction
| AsyncCompletionFunction;
| AsyncCompletionFunction
| FallbackCompletionFunction;

interface SyncCompletionFunction {
(current: string, argv: Arguments): string[] | Promise<string[]>;
Expand All @@ -190,8 +207,23 @@ interface AsyncCompletionFunction {
(current: string, argv: Arguments, done: (completions: string[]) => any): any;
}

interface FallbackCompletionFunction {
(
current: string,
argv: Arguments,
defaultCompletion: () => any,
done: (completions: string[]) => any
): any;
}

function isSyncCompletionFunction(
completionFunction: CompletionFunction
): completionFunction is SyncCompletionFunction {
return completionFunction.length < 3;
}

function isFallbackCompletionFunction(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the use of type detection here 👍

completionFunction: CompletionFunction
): completionFunction is FallbackCompletionFunction {
return completionFunction.length > 3;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be completionFunction.arguments.length I'm surprised this worked.

}
42 changes: 42 additions & 0 deletions test/completion.cjs
View file
Open in desktop
Expand Up @@ -340,6 +340,48 @@ describe('Completion', () => {
r.logs.should.include('success!');
});

it('allows the custom completion function to use the standard one', done => {
checkUsage(
() => {
yargs(['./completion', '--get-yargs-completions'])
.command('foo', 'bar')
.command('apple', 'banana')
.completion('completion', (current, argv, defaultCompletion, done) => {
defaultCompletion()
})
.parse();
},
null,
(err, r) => {
if (err) throw err;
r.logs.should.include('apple');
r.logs.should.include('foo');
return done();
}
);
});

it('allows calling callback instead of default completion function', done => {
checkUsage(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tests read quite well 👍

() => {
yargs(['./completion', '--get-yargs-completions'])
.command('foo', 'bar')
.command('apple', 'banana')
.completion('completion', (current, argv, defaultCompletion, done) => {
done(['orange'])
})
.parse();
},
null,
(err, r) => {
if (err) throw err;
r.logs.should.include('orange');
r.logs.should.not.include('foo');
return done();
}
);
});

it('if a promise is returned, completions can be asynchronous', done => {
checkUsage(
cb => {
Expand Down