joplin/CliClient/app/autocompletion.js

import { app } from './app.js';
import { Note } from 'lib/models/note.js';
import { Folder } from 'lib/models/folder.js';
import { cliUtils } from './cli-utils.js';
import yargParser from 'yargs-parser';

async function handleAutocompletion(autocompletion) {
	let args = autocompletion.line.slice();
	args.splice(0, 1);
	let current = autocompletion.current - 1;
	const currentWord = args[current];

	// Auto-complete the command name

	if (current == 0) {
		const metadata = await app().commandMetadata();
		let commandNames = [];
		for (let n in metadata) {
			if (!metadata.hasOwnProperty(n)) continue;
			const md = metadata[n];
			if (md.hidden) continue;
			if (currentWord == n) return [n];
			if (n.indexOf(currentWord) === 0) commandNames.push(n);
		}
		return commandNames;
	}

	const commandName = args[0];
	const metadata = await app().commandMetadata();
	const md = metadata[commandName];
	const options = md && md.options ? md.options : [];

	// Auto-complete the command options

	if (!currentWord) return [];

	const includeLongs = currentWord.length == 1 ? currentWord.substr(0, 1) == '-' : currentWord.substr(0, 2) == '--';
	const includeShorts = currentWord.length <= 2 && currentWord.substr(0, 1) == '-' && currentWord.substr(0, 2) != '--';

	if (includeLongs || includeShorts) {			
		const output = [];
		for (let i = 0; i < options.length; i++) {
			const flags = cliUtils.parseFlags(options[i][0]);
			const long = flags.long ? '--' + flags.long : null;
			const short = flags.short ? '-' + flags.short : null;
			if (includeLongs && long && long.indexOf(currentWord) === 0) output.push(long);
			if (includeShorts && short && short.indexOf(currentWord) === 0) output.push(short);
		}
		return output;
	}

	// Auto-complete the command arguments

	let argIndex = -1;
	for (let i = 0; i < args.length; i++) {
		const w = args[i];
		if (i == 0 || w.indexOf('-') == 0) {
			continue;
		}
		argIndex++;
	}

	if (argIndex < 0) return [];

	let cmdUsage = yargParser(md.usage)['_'];
	cmdUsage.splice(0, 1);

	if (cmdUsage.length <= argIndex) return [];

	let argName = cmdUsage[argIndex];
	argName = cliUtils.parseCommandArg(argName).name;

	if (argName == 'note') {
		if (!app().currentFolder()) return [];
		const notes = await Note.previews(app().currentFolder().id, { titlePattern: currentWord + '*' });
		return notes.map((n) => n.title);
	}

	if (argName == 'notebook') {
		const folders = await Folder.search({ titlePattern: currentWord + '*' });
		return folders.map((n) => n.title);
	}

	return [];
}

export { handleAutocompletion };