Function getHelp

packages/create-tldraw/src/main.ts:216–294

()

}

function getHelp() {
	const options = [
		{ flags: '-h, --help', description: 'Display this help message.' },
		{ flags: '-t, --template NAME', description: 'Use a specific template.' },
		{ flags: '--no-telemetry', description: 'Disable anonymous usage tracking.' },
	]

	const GAP_SIZE = 2
	const optionPrefix = '   '
	const templatePrefix = ' • '

	const idealIndentSize =
		Math.max(
			...options.map((o) => o.flags.length),
			...TEMPLATES.map((t) => formatTemplateId(t).length)
		) +
		GAP_SIZE +
		templatePrefix.length

	const isNarrow = process.stdout.columns < idealIndentSize + 50

	const lines = [
		picocolors.bold('Usage: create-tldraw [OPTION]... [DIRECTORY]'),
		'',
		'Create a new tldraw project from a starter kit.',
		"With no arguments, you'll be guided through an interactive setup.",
		'',
		picocolors.bold('Options:'),
	]

	if (isNarrow) {
		const indent = ' '.repeat(optionPrefix.length + GAP_SIZE)
		for (const option of options) {
			lines.push(`${optionPrefix}${option.flags}`)
			lines.push(wrapAnsi(`${indent}${option.description}`, process.stdout.columns, { indent }))
		}
	} else {
		const indent = ' '.repeat(idealIndentSize)
		for (const option of options) {
			const start = `${optionPrefix}${option.flags}`.padEnd(idealIndentSize, ' ')
			lines.push(wrapAnsi(`${start}${option.description}`, process.stdout.columns, { indent }))
		}
	}

	lines.push('')
	lines.push(picocolors.bold('Available starter kits:'))

	if (isNarrow) {
		const indent = ' '.repeat(templatePrefix.length + GAP_SIZE)
		for (const template of TEMPLATES) {
			lines.push(`${templatePrefix}${formatTemplateId(template)}`)
			lines.push(
				wrapAnsi(
					`${indent}${template.shortDescription ?? template.description}`,
					process.stdout.columns,
					{ indent }
				)
			)