Function checkboxDef

src/lib/item-input/array.ts:214–255

(
		name: string,
		items: CheckboxDefItem<T>[],
		options?: CheckboxDefOptions<T>,
)

export type CheckboxDefItem<T> = T extends string ? string | ComplexCheckboxDefItem<T> : ComplexCheckboxDefItem<T>

export function checkboxDef<T>(
		name: string,
		items: CheckboxDefItem<T>[],
		options?: CheckboxDefOptions<T>,
): InputDefinition<T[]> {
	const editValues = async (values: T[]): Promise<T[] | CancelAction> => {
		// We can't add help to the inquirer `checkbox` so, at least for now, we'll display
		// the help before we display the checkbox.
		if (options?.helpText) {
			console.log(`\n${options.helpText}\n`)
		}
		const choices: CheckboxChoice<T>[] = items.map(item => {
			const value = typeof item === 'string' ? item as T : item.value
			const retVal: CheckboxChoice<T> = typeof item === 'object'
				? { ...item }
				: ({ name: item, value })
			if (values.includes(value)) {
				retVal.checked = true
			}
			return retVal
		})
		const question = {
			message: `Select ${name}.`,
			choices,
			default: finishAction,
			pageSize: inquirerPageSize,
			validate: options?.validate,
		}
		const updatedValues = await checkbox(question)

		return updatedValues as T[]
	}

	const buildFromUserInput = (): Promise<T[] | CancelAction> => editValues(options?.default ?? [])

	const summarizeForEdit = options?.summarizeForEdit
		?? ((value: T[]) => clipToMaximum(value.map(item => stringFromUnknown(item)).join(', '), maxItemValueLength))

	const updateFromUserInput = (original: T[]): Promise<T[] | CancelAction> => editValues(original)

	return { name, buildFromUserInput, summarizeForEdit, updateFromUserInput }
}