Merge branch 'main' of github.com:sveltejs/cli into feat/community-add-on-draft-0

jycouet · jycouet · commit 50bedc8dd866 · 2025-09-05T23:05:55.000+02:00
diff --git a/.changeset/major-moles-cut.md b/.changeset/major-moles-cut.md
diff --git a/.changeset/mighty-papers-hammer.md b/.changeset/mighty-papers-hammer.md
@@ -0,0 +1,5 @@
+---
+'sv': patch
+---
+
+fix: improve add-on option types
diff --git a/packages/addons/drizzle/index.ts b/packages/addons/drizzle/index.ts
@@ -6,14 +6,15 @@ import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
 import { resolveCommand } from 'package-manager-detector/commands';
 import { getNodeTypesVersion } from '../common.ts';
 
-const PORTS = {
+type Database = 'mysql' | 'postgresql' | 'sqlite';
+const PORTS: Record<Database, string> = {
 	mysql: '3306',
 	postgresql: '5432',
 	sqlite: ''
-} as const;
+};
 
-const options = defineAddonOptions({
-	database: {
+const options = defineAddonOptions()
+	.add('database', {
 		question: 'Which database would you like to use?',
 		type: 'select',
 		default: 'sqlite',
@@ -22,8 +23,8 @@ const options = defineAddonOptions({
 			{ value: 'mysql', label: 'MySQL' },
 			{ value: 'sqlite', label: 'SQLite' }
 		]
-	},
-	postgresql: {
+	})
+	.add('postgresql', {
 		question: 'Which PostgreSQL client would you like to use?',
 		type: 'select',
 		group: 'client',
@@ -33,8 +34,8 @@ const options = defineAddonOptions({
 			{ value: 'neon', label: 'Neon', hint: 'popular hosted platform' }
 		],
 		condition: ({ database }) => database === 'postgresql'
-	},
-	mysql: {
+	})
+	.add('mysql', {
 		question: 'Which MySQL client would you like to use?',
 		type: 'select',
 		group: 'client',
@@ -44,8 +45,8 @@ const options = defineAddonOptions({
 			{ value: 'planetscale', label: 'PlanetScale', hint: 'popular hosted platform' }
 		],
 		condition: ({ database }) => database === 'mysql'
-	},
-	sqlite: {
+	})
+	.add('sqlite', {
 		question: 'Which SQLite client would you like to use?',
 		type: 'select',
 		group: 'client',
@@ -56,16 +57,16 @@ const options = defineAddonOptions({
 			{ value: 'turso', label: 'Turso', hint: 'popular hosted platform' }
 		],
 		condition: ({ database }) => database === 'sqlite'
-	},
-	docker: {
+	})
+	.add('docker', {
 		question: 'Do you want to run the database locally with docker-compose?',
 		default: false,
 		type: 'boolean',
 		condition: ({ database, mysql, postgresql }) =>
 			(database === 'mysql' && mysql === 'mysql2') ||
 			(database === 'postgresql' && postgresql === 'postgres.js')
-	}
-});
+	})
+	.build();
 
 export default defineAddon({
 	id: 'drizzle',
@@ -112,7 +113,7 @@ export default defineAddon({
 		if (options.sqlite === 'better-sqlite3') {
 			sv.dependency('better-sqlite3', '^11.8.0');
 			sv.devDependency('@types/better-sqlite3', '^7.6.12');
-			sv.pnpmBuildDependendency('better-sqlite3');
+			sv.pnpmBuildDependency('better-sqlite3');
 		}
 
 		if (options.sqlite === 'libsql' || options.sqlite === 'turso')
diff --git a/packages/addons/lucia/index.ts b/packages/addons/lucia/index.ts
@@ -26,13 +26,13 @@ type Dialect = 'mysql' | 'postgresql' | 'sqlite' | 'turso';
 let drizzleDialect: Dialect;
 let schemaPath: string;
 
-const options = defineAddonOptions({
-	demo: {
+const options = defineAddonOptions()
+	.add('demo', {
 		type: 'boolean',
 		default: true,
 		question: `Do you want to include a demo? ${colors.dim('(includes a login/register page)')}`
-	}
-});
+	})
+	.build();
 
 export default defineAddon({
 	id: 'lucia',
diff --git a/packages/addons/paraglide/index.ts b/packages/addons/paraglide/index.ts
@@ -16,8 +16,8 @@ const DEFAULT_INLANG_PROJECT = {
 	}
 };
 
-const options = defineAddonOptions({
-	languageTags: {
+const options = defineAddonOptions()
+	.add('languageTags', {
 		question: `Which languages would you like to support? ${colors.gray('(e.g. en,de-ch)')}`,
 		type: 'string',
 		default: 'en, es',
@@ -39,13 +39,13 @@ const options = defineAddonOptions({
 
 			return undefined;
 		}
-	},
-	demo: {
+	})
+	.add('demo', {
 		type: 'boolean',
 		default: true,
 		question: 'Do you want to include a demo?'
-	}
-});
+	})
+	.build();
 
 export default defineAddon({
 	id: 'paraglide',
diff --git a/packages/addons/sveltekit-adapter/index.ts b/packages/addons/sveltekit-adapter/index.ts
@@ -2,29 +2,23 @@ import { defineAddon, defineAddonOptions } from '@sveltejs/cli-core';
 import { exports, functions, imports, object, type AstTypes } from '@sveltejs/cli-core/js';
 import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
 
-type Adapter = {
-	id: string;
-	package: string;
-	version: string;
-};
-
-const adapters: Adapter[] = [
+const adapters = [
 	{ id: 'auto', package: '@sveltejs/adapter-auto', version: '^6.0.0' },
 	{ id: 'node', package: '@sveltejs/adapter-node', version: '^5.2.12' },
 	{ id: 'static', package: '@sveltejs/adapter-static', version: '^3.0.8' },
 	{ id: 'vercel', package: '@sveltejs/adapter-vercel', version: '^5.6.3' },
 	{ id: 'cloudflare', package: '@sveltejs/adapter-cloudflare', version: '^7.0.0' },
 	{ id: 'netlify', package: '@sveltejs/adapter-netlify', version: '^5.0.0' }
-];
+] as const;
 
-const options = defineAddonOptions({
-	adapter: {
+const options = defineAddonOptions()
+	.add('adapter', {
 		type: 'select',
 		question: 'Which SvelteKit adapter would you like to use?',
-		options: adapters.map((p) => ({ value: p.id, label: p.id, hint: p.package })),
-		default: 'auto'
-	}
-});
+		default: 'auto',
+		options: adapters.map((p) => ({ value: p.id, label: p.id, hint: p.package }))
+	})
+	.build();
 
 export default defineAddon({
 	id: 'sveltekit-adapter',
diff --git a/packages/addons/tailwindcss/index.ts b/packages/addons/tailwindcss/index.ts
@@ -3,37 +3,28 @@ import { imports, vite } from '@sveltejs/cli-core/js';
 import { parseCss, parseJson, parseScript, parseSvelte } from '@sveltejs/cli-core/parsers';
 import { addSlot } from '@sveltejs/cli-core/html';
 
-type Plugin = {
-	id: string;
-	package: string;
-	version: string;
-	identifier: string;
-};
-
-const plugins: Plugin[] = [
+const plugins = [
 	{
 		id: 'typography',
 		package: '@tailwindcss/typography',
-		version: '^0.5.15',
-		identifier: 'typography'
+		version: '^0.5.15'
 	},
 	{
 		id: 'forms',
 		package: '@tailwindcss/forms',
-		version: '^0.5.9',
-		identifier: 'forms'
+		version: '^0.5.9'
 	}
-];
+] as const;
 
-const options = defineAddonOptions({
-	plugins: {
+const options = defineAddonOptions()
+	.add('plugins', {
 		type: 'multiselect',
 		question: 'Which plugins would you like to add?',
 		options: plugins.map((p) => ({ value: p.id, label: p.id, hint: p.package })),
-		default: [],
+		default: [] as Array<(typeof plugins)[number]['id']>,
 		required: false
-	}
-});
+	})
+	.build();
 
 export default defineAddon({
 	id: 'tailwindcss',
diff --git a/packages/addons/vitest-addon/index.ts b/packages/addons/vitest-addon/index.ts
@@ -2,8 +2,8 @@ import { dedent, defineAddon, defineAddonOptions, log } from '@sveltejs/cli-core
 import { array, exports, functions, object } from '@sveltejs/cli-core/js';
 import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
 
-const options = defineAddonOptions({
-	usages: {
+const options = defineAddonOptions()
+	.add('usages', {
 		question: 'What do you want to use vitest for?',
 		type: 'multiselect',
 		default: ['unit', 'component'],
@@ -12,8 +12,8 @@ const options = defineAddonOptions({
 			{ value: 'component', label: 'component testing' }
 		],
 		required: true
-	}
-});
+	})
+	.build();
 
 export default defineAddon({
 	id: 'vitest',
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,17 @@
 # sv
 
+## 0.9.3
+### Patch Changes
+
+
+- chore(core): change `defineAddonOptions({ /*config */ })` to `defineAddonOptions().add('key', { /*config */ }).build()` in order to provide better type safety. ([#686](https://github.com/sveltejs/cli/pull/686))
+
+
+- fix(migrate): allow `migrate` to run without specifying a migration arg ([#676](https://github.com/sveltejs/cli/pull/676))
+
+
+- fix(add): improve robustness of add-on args parsing ([#681](https://github.com/sveltejs/cli/pull/681))
+
 ## 0.9.2
 ### Patch Changes
 
diff --git a/packages/cli/commands/add/index.ts b/packages/cli/commands/add/index.ts
@@ -59,25 +59,16 @@ export const add = new Command('add')
 			process.exit(1);
 		}
 
-		// occurs when an `=` isn't present (e.g. `sv add foo`)
-		if (optionFlags === undefined) {
-			prev.push({ id: addonId, options: undefined });
-			return prev;
-		}
-
-		// validates that the options are relatively well-formed.
-		// occurs when no <name> or <value> is specified (e.g. `sv add foo=demo`).
-		if (optionFlags.length > 0 && !/.+:.*/.test(optionFlags)) {
-			console.error(
-				`Malformed arguments: An add-on's option in '${value}' is missing it's option name or value (e.g. 'addon=option:value').`
-			);
+		try {
+			const options = common.parseAddonOptions(optionFlags);
+			prev.push({ id: addonId, options });
+		} catch (error) {
+			if (error instanceof Error) {
+				console.error(error.message);
+			}
 			process.exit(1);
 		}
 
-		// parses the option flags into a array of `<name>:<value>` strings
-		const options: string[] = optionFlags.match(/[^+]*:[^:]*(?=\+|$)/g) ?? [];
-
-		prev.push({ id: addonId, options });
 		return prev;
 	})
 	.option('-C, --cwd <path>', 'path to working directory', defaultCwd)
@@ -644,7 +635,7 @@ function getOptionChoices(details: AddonWithoutExplicitArgs) {
 	const choices: string[] = [];
 	const defaults: string[] = [];
 	const groups: Record<string, string[]> = {};
-	const options: Record<string, unknown> = {};
+	const options: OptionValues<any> = {};
 	for (const [id, question] of Object.entries(details.options)) {
 		let values: string[] = [];
 		const applyDefault = question.condition?.(options) !== false;
diff --git a/packages/cli/lib/install.ts b/packages/cli/lib/install.ts
@@ -173,7 +173,7 @@ async function runAddon({ addon, multiple, workspace }: RunAddon) {
 		devDependency: (pkg, version) => {
 			dependencies.push({ pkg, version, dev: true });
 		},
-		pnpmBuildDependendency: (pkg) => {
+		pnpmBuildDependency: (pkg) => {
 			pnpmBuildDependencies.push(pkg);
 		}
 	};
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "sv",
-	"version": "0.9.2",
+	"version": "0.9.3",
 	"type": "module",
 	"description": "A CLI for creating and updating SvelteKit projects",
 	"license": "MIT",
diff --git a/packages/cli/tests/common.ts b/packages/cli/tests/common.ts
@@ -0,0 +1,42 @@
+import { describe, expect, it } from 'vitest';
+import { parseAddonOptions } from '../utils/common.ts';
+
+describe('parseAddonOptions', () => {
+	it('returns undefined on undefined', () => {
+		expect(parseAddonOptions(undefined)).toEqual(undefined);
+	});
+	it('returns undefined on empty string', () => {
+		expect(parseAddonOptions('')).toEqual(undefined);
+	});
+	it('parses options and values', () => {
+		expect(parseAddonOptions('option:value')).toEqual(['option:value']);
+	});
+	it('parses values with empty strings', () => {
+		expect(parseAddonOptions('foo:')).toEqual(['foo:']);
+		expect(parseAddonOptions('foo:+bar:+baz:')).toEqual(['foo:', 'bar:', 'baz:']);
+	});
+	it('parses sentences', () => {
+		expect(parseAddonOptions('foo:the quick brown fox')).toEqual(['foo:the quick brown fox']);
+	});
+	it('parses lists', () => {
+		expect(parseAddonOptions('foo:en,es,de')).toEqual(['foo:en,es,de']);
+	});
+	it('parses values with colons', () => {
+		expect(parseAddonOptions('option:foo:bar:baz')).toEqual(['option:foo:bar:baz']);
+	});
+	it('errors on missing value', () => {
+		expect(() => parseAddonOptions('foo')).toThrowError(
+			"Malformed arguments: The following add-on options: 'foo' are missing their option name or value (e.g. 'addon=option1:value1+option2:value2')."
+		);
+	});
+	it('errors when one of two options is missing a value', () => {
+		expect(() => parseAddonOptions('foo:value1+bar')).toThrowError(
+			"Malformed arguments: The following add-on options: 'bar' are missing their option name or value (e.g. 'addon=option1:value1+option2:value2')."
+		);
+	});
+	it('errors on two missing values', () => {
+		expect(() => parseAddonOptions('foo+bar')).toThrowError(
+			"Malformed arguments: The following add-on options: 'foo', 'bar' are missing their option name or value (e.g. 'addon=option1:value1+option2:value2')."
+		);
+	});
+});
diff --git a/packages/cli/utils/common.ts b/packages/cli/utils/common.ts
@@ -115,3 +115,23 @@ export function forwardExitCode(error: unknown) {
 		process.exit(1);
 	}
 }
+
+export function parseAddonOptions(optionFlags: string | undefined): string[] | undefined {
+	// occurs when an `=` isn't present (e.g. `sv add foo`)
+	if (optionFlags === undefined || optionFlags === '') {
+		return undefined;
+	}
+
+	// Split on + and validate each option individually
+	const options = optionFlags.split('+');
+
+	// Validate that each individual option follows the name:value pattern
+	const malformed = options.filter((option) => !/.+:.*/.test(option));
+
+	if (malformed.length > 0) {
+		const message = `Malformed arguments: The following add-on options: ${malformed.map((o) => `'${o}'`).join(', ')} are missing their option name or value (e.g. 'addon=option1:value1+option2:value2').`;
+		throw new Error(message);
+	}
+
+	return options;
+}
diff --git a/packages/cli/vitest.config.ts b/packages/cli/vitest.config.ts
diff --git a/packages/core/addon/config.ts b/packages/core/addon/config.ts
diff --git a/packages/core/addon/options.ts b/packages/core/addon/options.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'sv': patch
 +---
++
 +fix: improve add-on option types