Merge branch 'main' into add-ons

benmccann · web-flow · commit c77cf933c277 · 2024-10-30T11:31:50.000-07:00
diff --git a/.changeset/dry-cougars-sneeze.md b/.changeset/dry-cougars-sneeze.md
@@ -0,0 +1,5 @@
+---
+'sv': minor
+---
+
+chore: remove routify
diff --git a/.changeset/wise-hotels-cry.md b/.changeset/wise-hotels-cry.md
@@ -0,0 +1,5 @@
+---
+'sv': minor
+---
+
+feat: rename `--check-types <typescript|checkjs|none>` to `--types <ts|js>` with a `--no-types` flag
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -44,4 +44,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_CONFIG_PROVENANCE: true
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Update Template Repo
+        if: steps.changesets.outputs.published == 'true'
+        run: pnpm -F @sveltejs/create update-template-repo
+        env:
           UPDATE_TEMPLATE_SSH_KEY: ${{ secrets.UPDATE_TEMPLATE_SSH_KEY }}
diff --git a/.github/workflows/update-template-repo.yml b/.github/workflows/update-template-repo.yml
@@ -0,0 +1,32 @@
+name: Update Template Repo (manual)
+
+on:
+  workflow_dispatch:
+
+permissions: {}
+jobs:
+  release:
+    # prevents this action from running on forks
+    if: github.repository == 'sveltejs/cli'
+    name: Update template
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: pnpm
+
+      - name: Install
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Run template update script
+        run: pnpm -F @sveltejs/create update-template-repo
+        env:
+          UPDATE_TEMPLATE_SSH_KEY: ${{ secrets.UPDATE_TEMPLATE_SSH_KEY }}
diff --git a/documentation/docs/20-commands/10-sv-create.md b/documentation/docs/20-commands/10-sv-create.md
@@ -12,16 +12,6 @@ npx sv create [options] [path]
 
 ## Options
 
-<!-- TODO this flag should probably just be '--types', and the options should be 'ts' or 'jsdoc' -->
-
-### `--check-types <option>`
-
-Whether and how to add typechecking to the project:
-
-- `typescript` — default to `.ts` files and use `lang="ts"` for `.svelte` components
-- `checkjs` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types
-- `none` — no typechecking. Not recommended!
-
 ### `--template <name>`
 
 Which project template to use:
@@ -30,6 +20,17 @@ Which project template to use:
 - `demo` — showcase app with a word guessing game that works without JavaScript
 - `library` — template for a Svelte library, set up with `svelte-package`
 
+### `--types <option>`
+
+Whether and how to add typechecking to the project:
+
+- `ts` — default to `.ts` files and use `lang="ts"` for `.svelte` components
+- `jsdoc` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types
+
+### `--no-types`
+
+Prevent typechecking from being added. Not recommended!
+
 ### `--no-add-ons`
 
 Run the command without the interactive add-ons prompt
diff --git a/documentation/docs/20-commands/20-sv-add.md b/documentation/docs/20-commands/20-sv-add.md
@@ -33,7 +33,6 @@ You can select multiple space-separated add-ons from [the list below](#Official-
 - `paraglide`
 - `playwright`
 - `prettier`
-- `routify`
 - `storybook`
 - `tailwindcss`
 - `vitest`
diff --git a/packages/adders/_config/official.ts b/packages/adders/_config/official.ts
@@ -7,7 +7,6 @@ import mdsvex from '../mdsvex/index.ts';
 import paraglide from '../paraglide/index.ts';
 import playwright from '../playwright/index.ts';
 import prettier from '../prettier/index.ts';
-import routify from '../routify/index.ts';
 import storybook from '../storybook/index.ts';
 import tailwindcss from '../tailwindcss/index.ts';
 import vitest from '../vitest/index.ts';
@@ -24,8 +23,7 @@ export const officialAdders = [
 	lucia,
 	mdsvex,
 	paraglide,
-	storybook,
-	routify
+	storybook
 ];
 
 export function getAdderDetails(id: string): AdderWithoutExplicitArgs {
diff --git a/packages/adders/routify/index.ts b/packages/adders/routify/index.ts
diff --git a/packages/adders/routify/logo.svg b/packages/adders/routify/logo.svg
diff --git a/packages/adders/routify/tests.ts b/packages/adders/routify/tests.ts
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,11 @@
 # sv
 
+## 0.5.11
+### Patch Changes
+
+
+- fix: revert logging dependency install errors ([#244](https://github.com/sveltejs/cli/pull/244))
+
 ## 0.5.10
 ### Patch Changes
 
diff --git a/packages/cli/commands/add/index.ts b/packages/cli/commands/add/index.ts
@@ -49,8 +49,8 @@ export const add = new Command('add')
 	.description('applies specified add-ons into a project')
 	.argument('[add-on...]', 'add-ons to install')
 	.option('-C, --cwd <path>', 'path to working directory', defaultCwd)
-	.option('--no-install', 'skips installing dependencies')
-	.option('--no-preconditions', 'skips validating preconditions')
+	.option('--no-install', 'skip installing dependencies')
+	.option('--no-preconditions', 'skip validating preconditions')
 	//.option('--community [adder...]', 'community adders to install')
 	.configureHelp(common.helpConfig)
 	.action((adderArgs, opts) => {
@@ -545,10 +545,7 @@ async function runAdders({
 				if (workspace.packageManager === 'npm') args.unshift('--yes');
 
 				try {
-					const { stderr } = await exec(command, args, {
-						nodeOptions: { cwd: workspace.cwd, stdio: script.stdio }
-					});
-					if (stderr) throw new Error(stderr);
+					await exec(command, args, { nodeOptions: { cwd: workspace.cwd, stdio: script.stdio } });
 				} catch (error) {
 					const typedError = error as Error;
 					throw new Error(
diff --git a/packages/cli/commands/create.ts b/packages/cli/commands/create.ts
@@ -15,16 +15,24 @@ import * as common from '../common.js';
 import { runAddCommand } from './add/index.ts';
 import { detectSync, type AgentName } from 'package-manager-detector';
 
-const langs = ['typescript', 'checkjs', 'none'] as const;
+const langs = ['ts', 'jsdoc'] as const;
+const langMap: Record<string, LanguageType | undefined> = {
+	ts: 'typescript',
+	jsdoc: 'checkjs',
+	false: 'none'
+};
 const templateChoices = templates.map((t) => t.name);
-const langOption = new Option('--check-types <lang>', 'add type checking').choices(langs);
+const langOption = new Option('--types <lang>', 'add type checking').choices(langs);
 const templateOption = new Option('--template <type>', 'template to scaffold').choices(
 	templateChoices
 );
 
 const ProjectPathSchema = v.string();
 const OptionsSchema = v.strictObject({
-	checkTypes: v.optional(v.picklist(langs)),
+	types: v.pipe(
+		v.optional(v.union([v.picklist(langs), v.boolean()])),
+		v.transform((lang) => langMap[String(lang)])
+	),
 	addOns: v.boolean(),
 	install: v.boolean(),
 	template: v.optional(v.picklist(templateChoices))
@@ -34,10 +42,11 @@ type Options = v.InferOutput<typeof OptionsSchema>;
 export const create = new Command('create')
 	.description('scaffolds a new SvelteKit project')
 	.argument('[path]', 'where the project will be created', process.cwd())
-	.addOption(langOption)
 	.addOption(templateOption)
+	.addOption(langOption)
+	.option('--no-types')
 	.option('--no-add-ons', 'skips interactive add-on installer')
-	.option('--no-install', 'skips installing dependencies')
+	.option('--no-install', 'skip installing dependencies')
 	.configureHelp(common.helpConfig)
 	.action((projectPath, opts) => {
 		const cwd = v.parse(ProjectPathSchema, projectPath);
@@ -113,7 +122,7 @@ async function createProject(cwd: string, options: Options) {
 				});
 			},
 			language: () => {
-				if (options.checkTypes) return Promise.resolve(options.checkTypes);
+				if (options.types) return Promise.resolve(options.types);
 				return p.select<LanguageType>({
 					message: 'Add type checking with Typescript?',
 					initialValue: 'typescript',
diff --git a/packages/cli/common.ts b/packages/cli/common.ts
@@ -8,9 +8,52 @@ import { COMMANDS, constructCommand, resolveCommand } from 'package-manager-dete
 import type { Argument, HelpConfiguration, Option } from 'commander';
 import type { AdderWithoutExplicitArgs, Precondition } from '@sveltejs/cli-core';
 
+const NO_PREFIX = '--no-';
+let options: readonly Option[] = [];
+
+function getLongFlag(flags: string) {
+	return flags
+		.split(',')
+		.map((f) => f.trim())
+		.find((f) => f.startsWith('--'));
+}
+
 export const helpConfig: HelpConfiguration = {
 	argumentDescription: formatDescription,
-	optionDescription: formatDescription
+	optionDescription: formatDescription,
+	visibleOptions(cmd) {
+		// hack so that we can access existing options in `optionTerm`
+		options = cmd.options;
+
+		const visible = cmd.options.filter((o) => !o.hidden);
+		const show: Option[] = [];
+		// hide any `--no-` flag variants if there's an existing flag of a similar name
+		// e.g. `--types` and `--no-types` will combine into a single `--[no-]types` flag
+		for (const option of visible) {
+			const flag = getLongFlag(option.flags);
+			if (flag?.startsWith(NO_PREFIX)) {
+				const stripped = flag.slice(NO_PREFIX.length);
+				const isNoVariant = visible.some((o) => getLongFlag(o.flags)?.startsWith(`--${stripped}`));
+				if (isNoVariant) continue;
+			}
+			show.push(option);
+		}
+		return show;
+	},
+	optionTerm(option) {
+		const longFlag = getLongFlag(option.flags);
+		const flag = longFlag?.split(' ').at(0);
+		if (!flag || !longFlag) return option.flags;
+
+		// check if there's a `--no-{flag}` variant
+		const noVariant = `--no-${flag.slice(2)}`;
+		const hasVariant = options.some((o) => getLongFlag(o.flags) === noVariant);
+		if (hasVariant) {
+			return `--[no-]${longFlag.slice(2)}`;
+		}
+
+		return option.flags;
+	}
 };
 
 function formatDescription(arg: Option | Argument): string {
@@ -76,8 +119,7 @@ export async function installDependencies(agent: AgentName, cwd: string) {
 	spinner.start('Installing dependencies...');
 	try {
 		const { command, args } = constructCommand(COMMANDS[agent].install, [])!;
-		const { stderr } = await exec(command, args, { nodeOptions: { cwd } });
-		if (stderr) throw new Error(stderr);
+		await exec(command, args, { nodeOptions: { cwd } });
 
 		spinner.stop('Successfully installed dependencies');
 	} catch (error) {
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "sv",
-	"version": "0.5.10",
+	"version": "0.5.11",
 	"type": "module",
 	"description": "A CLI for creating and updating SvelteKit projects",
 	"license": "MIT",
diff --git a/packages/create/package.json b/packages/create/package.json
diff --git a/packages/create/scripts/update-template-repo.sh b/packages/create/scripts/update-template-repo.sh

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'sv': minor
 +---
++
 +chore: remove routify