vscode/extensions/terminal-suggest/src/test/fig.test.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { testPaths, type ISuiteSpec } from './helpers';
const expectedCompletions = [{ label: 'foo', description: 'Foo' }];
export const figGenericTestSuites: ISuiteSpec[] = [
	{
		name: 'Fig name and description only',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			// Typing a path
			{ input: '|', expectedCompletions, expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } },
			{ input: 'f|', expectedCompletions, expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } },
			{ input: 'fo|', expectedCompletions, expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } },
			{ input: 'foo|', expectedCompletions, expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } },

			// Basic arguments (fallback)
			{ input: 'foo |', expectedCompletions: [], expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } }
		]
	},
	{
		name: 'Fig top-level args files only',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				args: {
					template: 'filepaths',
					isVariadic: true,
				}
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: [], expectedResourceRequests: { type: 'files', cwd: testPaths.cwd } },
		]
	},
	{
		name: 'Fig top-level args folders only',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				args: {
					template: 'folders',
					isVariadic: true,
				}
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: [], expectedResourceRequests: { type: 'folders', cwd: testPaths.cwd } },
		]
	},
	{
		name: 'Fig top-level args files and folders',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				args: {
					template: ['filepaths', 'folders'],
					isVariadic: true,
				}
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: [], expectedResourceRequests: { type: 'both', cwd: testPaths.cwd } },
		]
	},
	{
		name: 'Fig top-level options',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				options: [
					{ name: '--bar', description: 'Bar' },
					{ name: '--baz', description: 'Baz' }
				]
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: ['--bar', '--baz'] },
			{ input: 'foo bar|', expectedCompletions: ['--bar', '--baz'] },
			{ input: 'foo --bar |', expectedCompletions: ['--baz'] },
			{ input: 'foo --baz |', expectedCompletions: ['--bar'] },
		]
	},
	{
		name: 'Fig top-level option values',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				options: [
					{
						name: '--bar',
						description: 'Bar',
						args: {
							name: 'baz',
							suggestions: [
								'a',
								'b',
								'c',
							],
						}
					}
				]
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: ['--bar <baz>'] },
			{ input: 'foo --bar |', expectedCompletions: ['a', 'b', 'c'] },
			{ input: 'foo --bar a|', expectedCompletions: ['a', 'b', 'c'] },
			{ input: 'foo --bar b|', expectedCompletions: ['a', 'b', 'c'] },
			{ input: 'foo --bar c|', expectedCompletions: ['a', 'b', 'c'] },
		]
	},
	{
		name: 'Fig script generator',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				args: {
					name: 'bar',
					generators: [
						{
							script: () => ['echo abcd'],
							postProcess: (out) => out.split('').map(item => {
								return { name: item };
							}).filter(i => !!i)
						}
					]
				}
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: ['e', 'c', 'h', 'o', ' ', 'a', 'b', 'c', 'd'] },
			{ input: 'foo a|', expectedCompletions: ['e', 'c', 'h', 'o', ' ', 'a', 'b', 'c', 'd'] },
			{ input: 'foo b|', expectedCompletions: ['e', 'c', 'h', 'o', ' ', 'a', 'b', 'c', 'd'] },
			{ input: 'foo c|', expectedCompletions: ['e', 'c', 'h', 'o', ' ', 'a', 'b', 'c', 'd'] },
		]
	},
	{
		name: 'Fig custom generator',
		completionSpecs: [
			{
				name: 'foo',
				description: 'Foo',
				args: {
					name: 'bar',
					generators: [
						{
							custom: async (tokens: string[], executeCommand: Fig.ExecuteCommandFunction, generatorContext: Fig.GeneratorContext) => {
								if (tokens.length) {
									return tokens.map(token => ({ name: token }));
								}
								executeCommand({ command: 'echo', args: ['a\tb\nc\td'] });
							}
						}
					]
				}
			}
		],
		availableCommands: 'foo',
		testSpecs: [
			{ input: 'foo |', expectedCompletions: ['foo'] },
			{ input: 'foo a|', expectedCompletions: ['a', 'foo'] },
			{ input: 'foo b|', expectedCompletions: ['b', 'foo'] },
			{ input: 'foo c|', expectedCompletions: ['c', 'foo'] },
		]
	}
];