Merge pull request #360 from sparksuite/allow-accepts-to-be-callback

Allow accepts to be callback

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "waterfall-cli",
-	"version": "1.0.0-alpha.4",
+	"version": "1.0.0-alpha.5",
 	"description": "Effortlessly create CLIs powered by Node.js",
 	"types": "dist/cjs/index.d.ts",
 	"files": [

src/screens/help.test.ts

@@ -169,4 +169,34 @@ describe('#helpScreen()', () => {
 			'What you want to list (required) (accepts: toppings, crusts, two words)'
 		);
 	});
+
+	it('Emits help with dynamic async accepts properties', async () => {
+		process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-async-accepts',
+			'--help',
+		];
+
+		const result = removeFormatting(await helpScreen());
+
+		expect(result).toContain('What type of pizza to order (accepts: a1, b1, c1, d1)');
+		expect(result).toContain('Just used for testing (accepts: a2, b2, c2, d2)');
+	});
+
+	it('Emits help with dynamic sync accepts properties', async () => {
+		process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-sync-accepts',
+			'--help',
+		];
+
+		const result = removeFormatting(await helpScreen());
+
+		expect(result).toContain('What type of pizza to order (accepts: a1, b1, c1, d1)');
+		expect(result).toContain('Just used for testing (accepts: a2, b2, c2, d2)');
+	});
 });

src/screens/help.ts

@@ -115,7 +115,7 @@ export default async function helpScreen(): Promise<string> {
 		table.push(['\nOPTIONS:']);
 
 		// List options
-		Object.entries(mergedSpec.options ?? {}).forEach(([option, details]) => {
+		for (const [option, details] of Object.entries(mergedSpec.options ?? {})) {
 			// Form full description
 			let fullDescription = '';
 
@@ -132,12 +132,15 @@ export default async function helpScreen(): Promise<string> {
 			}
 
 			if (details.accepts) {
-				fullDescription += chalk.gray.italic(` (accepts: ${details.accepts.join(', ')})`);
+				const arrayOrPromise = typeof details.accepts === 'function' ? details.accepts() : details.accepts;
+				const accepts = arrayOrPromise instanceof Promise ? await arrayOrPromise : arrayOrPromise;
+
+				fullDescription += chalk.gray.italic(` (accepts: ${accepts.join(', ')})`);
 			}
 
 			// Add to table
 			table.push([`  --${option}${details.shorthand ? `, -${details.shorthand}` : ''}`, fullDescription]);
-		});
+		}
 	}
 
 	// Add line for commands
@@ -177,7 +180,7 @@ export default async function helpScreen(): Promise<string> {
 			fullDescription += chalk.gray.italic(` (${mergedSpec.data.type})`);
 		}
 
-		if (mergedSpec.data.accepts) {
+		if (mergedSpec.data.accepts && typeof mergedSpec.data.accepts !== 'function') {
 			fullDescription += chalk.gray.italic(` (accepts: ${mergedSpec.data.accepts.join(', ')})`);
 		}
 

src/utils/get-all-program-commands.test.ts

@@ -15,6 +15,8 @@ describe('#getAllProgramCommands()', () => {
 			'order',
 			'order descriptionless-data',
 			'order dine-in',
+			'order dynamic-async-accepts',
+			'order dynamic-sync-accepts',
 			'order float-data',
 			'order integer-data',
 			'order to-go',

src/utils/get-command-spec.ts

@@ -77,9 +77,13 @@ export type CommandSpec<Input extends CommandInput = EmptyCommandInput> = OmitEx
 								: ExcludeMe
 							: ExcludeMe;
 
-						/** A finite array of acceptable option values. Invalid values will be rejected. */
-						accepts: NonNullable<Input['options'][Option]> extends Array<string | number>
-							? Input['options'][Option]
+						/** A finite array of acceptable option values or callback providing same. Invalid values will be rejected. */
+						accepts: NonNullable<Input['options'][Option]> extends
+							| string[]
+							| number[]
+							| (() => string[] | number[])
+							| (() => Promise<string[] | number[]>)
+							? Input['options'][Option] | (() => Promise<Input['options'][Option]>)
 							: ExcludeMe;
 					}>;
 			  }
@@ -103,8 +107,14 @@ export type CommandSpec<Input extends CommandInput = EmptyCommandInput> = OmitEx
 							: ExcludeMe
 						: ExcludeMe;
 
-					/** A finite array of acceptable data values. Invalid data will be rejected. */
-					accepts: NonNullable<Input['data']> extends Array<string | number> ? Input['data'] : ExcludeMe;
+					/** A finite array of acceptable data values or callback providing same. Invalid data will be rejected. */
+					accepts: NonNullable<Input['data']> extends
+						| string[]
+						| number[]
+						| (() => string[] | number[])
+						| (() => Promise<string[] | number[]>)
+						? Input['data'] | (() => Promise<Input['data']>)
+						: ExcludeMe;
 
 					/** Whether to ignore anything that looks like flags/options once data is reached. Useful if you expect your data to contain things that would otherwise appear to be flags/options. */
 					ignoreFlagsAndOptions?: true;
@@ -131,14 +141,14 @@ export interface GenericCommandSpec {
 			shorthand?: string;
 			required?: true;
 			type?: 'integer' | 'float';
-			accepts?: string[] | number[];
+			accepts?: string[] | number[] | (() => string[] | number[]) | (() => Promise<string[] | number[]>);
 		};
 	};
 	data?: {
 		description?: string;
 		required?: true;
 		type?: 'integer' | 'float';
-		accepts?: string[] | number[];
+		accepts?: string[] | number[] | (() => string[] | number[]) | (() => Promise<string[] | number[]>);
 		ignoreFlagsAndOptions?: true;
 	};
 }
@@ -180,8 +190,16 @@ export default async function getCommandSpec(directory: string): Promise<Generic
 
 	// Return
 	try {
-		const spec = (await import(specFilePath)) as { default: GenericCommandSpec } | GenericCommandSpec;
-		return 'default' in spec ? spec.default : spec;
+		let spec = (await import(specFilePath)) as { default: GenericCommandSpec } | GenericCommandSpec;
+
+		spec = 'default' in spec ? spec.default : spec;
+
+		if (spec.data?.accepts && typeof spec.data.accepts === 'function') {
+			const arrayOrPromise = spec.data.accepts();
+			spec.data.accepts = arrayOrPromise instanceof Promise ? await arrayOrPromise : arrayOrPromise;
+		}
+
+		return spec;
 	} catch (error) {
 		throw new PrintableError(
 			`${String(error)}\n\nEncountered this error while importing the spec file at: ${chalk.bold(truncatedPath)}`

src/utils/get-organized-arguments.test.ts

@@ -656,4 +656,72 @@ describe('#getOrganizedArguments()', () => {
 				values: [],
 			});
 	});
+
+	it('Handles having dynamic async option accept values', async () => {
+		(process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-async-accepts',
+			'--test',
+			'a2',
+		]),
+			expect(await getOrganizedArguments()).toStrictEqual({
+				command: 'order dynamic-async-accepts',
+				flags: [],
+				options: ['test'],
+				values: ['a2'],
+			});
+	});
+
+	it('Handles having dynamic sync option accept values', async () => {
+		(process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-sync-accepts',
+			'--test',
+			'a2',
+		]),
+			expect(await getOrganizedArguments()).toStrictEqual({
+				command: 'order dynamic-sync-accepts',
+				flags: [],
+				options: ['test'],
+				values: ['a2'],
+			});
+	});
+
+	it('Handles having dynamic async data accept values', async () => {
+		(process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-async-accepts',
+			'b1',
+		]),
+			expect(await getOrganizedArguments()).toStrictEqual({
+				command: 'order dynamic-async-accepts',
+				flags: [],
+				options: [],
+				values: [],
+				data: 'b1',
+			});
+	});
+
+	it('Handles having dynamic sync data accept values', async () => {
+		(process.argv = [
+			'/path/to/node',
+			path.join(testProjectsPath, 'pizza-ordering', 'cli', 'entry.js'),
+			'order',
+			'dynamic-sync-accepts',
+			'b1',
+		]),
+			expect(await getOrganizedArguments()).toStrictEqual({
+				command: 'order dynamic-sync-accepts',
+				flags: [],
+				options: [],
+				values: [],
+				data: 'b1',
+			});
+	});
 });

src/utils/get-organized-arguments.ts

@@ -160,7 +160,11 @@ export default async function getOrganizedArguments(): Promise<OrganizedArgument
 						// Store details
 						previousOption = argument;
 						nextIsOptionValue = true;
-						nextValueAccepts = details.accepts || undefined;
+
+						const arrayOrPromise =
+							typeof details.accepts === 'function' ? details.accepts() : details.accepts || undefined;
+						nextValueAccepts = arrayOrPromise instanceof Promise ? await arrayOrPromise : arrayOrPromise;
+
 						nextValueType = details.type || undefined;
 						organizedArguments.options.push(option);
 					}
@@ -282,7 +286,7 @@ export default async function getOrganizedArguments(): Promise<OrganizedArgument
 		}
 
 		// Validate data, if necessary
-		if (mergedSpec.data.accepts) {
+		if (mergedSpec.data.accepts && mergedSpec.data.accepts instanceof Array) {
 			// @ts-expect-error: TypeScript is confused here...
 			if (!mergedSpec.data.accepts.includes(organizedArguments.data)) {
 				throw new PrintableError(

test-projects/pizza-ordering/cli/order/dynamic-async-accepts/dynamic-async-accepts.js

@@ -0,0 +1 @@
+module.exports = async function() {};

test-projects/pizza-ordering/cli/order/dynamic-async-accepts/dynamic-async-accepts.spec.js

@@ -0,0 +1,24 @@
+async function dataAllows() {
+	await new Promise((resolve) => setTimeout(resolve, 10));
+	return ['a1', 'b1', 'c1', 'd1'];
+}
+
+async function testAllows() {
+	await new Promise((resolve) => setTimeout(resolve, 10));
+	return ['a2', 'b2', 'c2', 'd2'];
+}
+
+module.exports = {
+	description: 'Just used for testing',
+	data: {
+		description: 'What type of pizza to order',
+		accepts: dataAllows,
+	},
+	options: {
+		test: {
+			description: 'Just used for testing',
+			accepts: testAllows,
+		},
+	},
+	acceptsPassThroughArgs: false,
+};

test-projects/pizza-ordering/cli/order/dynamic-sync-accepts/dynamic-sync-accepts.js

@@ -0,0 +1 @@
+module.exports = async function() {};

test-projects/pizza-ordering/cli/order/dynamic-sync-accepts/dynamic-sync-accepts.spec.js

@@ -0,0 +1,23 @@
+function dataAllows() {
+	return ['a1', 'b1', 'c1', 'd1'];
+}
+
+function testAllows() {
+	return ['a2', 'b2', 'c2', 'd2'];
+}
+
+
+module.exports = {
+	description: 'Just used for testing',
+	data: {
+		description: 'What type of pizza to order',
+		accepts: dataAllows,
+	},
+	options: {
+		test: {
+			description: 'Just used for testing',
+			accepts: testAllows,
+		},
+	},
+	acceptsPassThroughArgs: false,
+};