create-quicklook 0.5.0 → 0.7.0

package/README.markdown

@@ -2,15 +2,15 @@
 
 ![License](https://img.shields.io/npm/l/create-quicklook?style=for-the-badge)
 [![Version](https://img.shields.io/npm/v/create-quicklook?style=for-the-badge)](https://www.npmjs.org/package/create-quicklook)
-[![Build](https://img.shields.io/github/actions/workflow/status/idleberg/create-quicklook/ci.yml?style=for-the-badge)](https://github.com/idleberg/create-quicklook/actions)
+[![Build](https://img.shields.io/github/actions/workflow/status/idleberg/quicklook-kit/ci.yml?style=for-the-badge)](https://github.com/idleberg/quicklook-kit/actions)
 
-> Create a macOS Quick Look preview with any Vite-based web framework
+> Create Quick Look previews with Vite-based web frameworks
 
 ```sh
 pnpm create quicklook my-preview
 ```
 
-Asks for a template (SvelteKit, Astro, SolidStart, Nuxt or Analog) and whether to add a GitHub release workflow. Skip the questions with `--template <name>` and `--release` or `--no-release`.
+Asks for a template (SvelteKit, Astro, SolidStart, Nuxt or Analog), the platforms to build for (macOS, Windows or both) and whether to add a GitHub release workflow. Skip the questions with `--template <name>`, `--platform macos` and/or `--platform windows`, and `--release` or `--no-release`.
 
 The project uses [quicklook-kit](https://www.npmjs.com/package/quicklook-kit); see its readme for what to do next.
 

package/dist/index.mjs

@@ -6,8 +6,10 @@ import { basename, relative, resolve } from "node:path";
 import process from "node:process";
 import { fileURLToPath } from "node:url";
 import { parseArgs } from "node:util";
-import { cancel, confirm, intro, isCancel, note, outro, select, text } from "@clack/prompts";
-//#region src/index.ts
+import { cancel, confirm, intro, isCancel, multiselect, note, outro, select, text } from "@clack/prompts";
+// src/index.ts
+const macosGroup = /\tmacos: \{\n[\s\S]*?\n\t\},\n/;
+const windowsGroup = "	windows: { id: 'QuickLook.Plugin.Example', extensions: ['example'] },\n";
 const pkgRoot = fileURLToPath(new URL("..", import.meta.url));
 const templates = (await readdir(`${pkgRoot}/templates`)).toSorted();
 const { values, positionals } = parseArgs({
@@ -18,9 +20,19 @@ const { values, positionals } = parseArgs({
 			type: "string",
 			short: "t"
 		},
+		platform: {
+			type: "string",
+			short: "p",
+			multiple: true
+		},
 		release: { type: "boolean" }
 	}
 });
+const unknownPlatform = values.platform?.find((platform) => !["macos", "windows"].includes(platform));
+if (unknownPlatform) {
+	cancel(`--platform: expected "macos" or "windows", got "${unknownPlatform}"`);
+	process.exit(1);
+}
 /** Exits quietly when a prompt is cancelled with Ctrl+C or Esc. */
 function answer(value) {
 	if (isCancel(value)) {
@@ -43,6 +55,19 @@ const template = values.template && templates.includes(values.template) ? values
 	message: "Template",
 	options: templates.map((value) => ({ value }))
 }));
+const platforms = values.platform ?? answer(await multiselect({
+	message: "Platforms",
+	options: [{
+		value: "macos",
+		label: "macOS",
+		hint: "Quick Look"
+	}, {
+		value: "windows",
+		label: "Windows",
+		hint: "QuickLook by QL-Win"
+	}],
+	initialValues: ["macos"]
+}));
 const release = values.release ?? answer(await confirm({
 	message: "Add a GitHub release workflow?",
 	initialValue: false
@@ -53,6 +78,13 @@ await cp(`${pkgRoot}/files/biome.template.jsonc`, `${dir}/biome.jsonc`);
 await cp(`${pkgRoot}/files/ci.yml`, `${dir}/.github/workflows/ci.yml`);
 await cp(`${pkgRoot}/files/gitignore`, `${dir}/.gitignore`);
 if (release) await cp(`${pkgRoot}/files/release.yml`, `${dir}/.github/workflows/release.yml`);
+const macos = platforms.includes("macos");
+const windows = platforms.includes("windows");
+async function edit(file, change) {
+	await writeFile(file, change(await readFile(file, "utf8")));
+}
+await edit(`${dir}/quicklook.config.ts`, (content) => content.replace(macosGroup, (group) => macos ? group : "").replace("	framework:", (line) => windows ? `${windowsGroup}${line}` : line));
+await edit(`${dir}/mise.toml`, (content) => content.replace("xcodegen = \"latest\"\n", (line) => macos ? line : "").replace("node = \"24\"\n", (line) => windows ? `${line}dotnet = "10"\n` : line));
 const pkg = JSON.parse(await readFile(`${dir}/package.json`, "utf8"));
 pkg.name = basename(dir);
 const pnpm = process.env.npm_config_user_agent?.match(/^pnpm\/(\S+)/)?.[1];
@@ -73,10 +105,9 @@ try {
 }
 note([
 	`cd ${relative(process.cwd(), dir)}`,
-	"mise install    # or: pnpm install, with Xcode and XcodeGen installed",
+	`mise install    # or: pnpm install, with ${new Intl.ListFormat("en").format([...macos ? ["Xcode", "XcodeGen"] : [], ...windows ? ["the .NET SDK"] : []])} installed`,
 	"pnpm dev        # drop a file on the page to preview it",
 	"pnpm register   # build the app and register it with Quick Look"
 ].join("\n"), "Next steps");
 outro(`Created from the ${template} template.`);
-//#endregion
 export {};

package/files/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 permissions:
   contents: write
@@ -26,27 +26,32 @@ jobs:
 
       - uses: jdx/mise-action@v2
 
-      # Release builds are universal (arm64 + x86_64) by default.
+      # Builds every platform in quicklook.config; release builds for macOS are
+      # universal (arm64 + x86_64) by default.
       - run: pnpm install --frozen-lockfile && pnpm run build
         working-directory: ${{ env.PROJECT }}
         env:
           VERSION: ${{ github.ref_name }}
 
-      - name: Package app
-        id: package
+      # <App>-<tag>-macos.zip and <App>-<tag>-windows.qlplugin, for whichever were built.
+      - name: Package
         run: |
-          cd "$PROJECT/.quicklook/build"
-          app=$(ls -d *.app)
-          zip="${app%.app}"
-          zip="${zip// /-}-${GITHUB_REF_NAME}.zip"
-          zip -r -9 -y "$GITHUB_WORKSPACE/$zip" "$app"
-          cd "$GITHUB_WORKSPACE"
-          shasum -a 256 "$zip" > SHA256SUMS
-          echo "zip=$zip" >> "$GITHUB_OUTPUT"
+          mkdir release
+          build="$PROJECT/.quicklook/build"
+          for app in "$build"/macos/*.app; do
+            [ -e "$app" ] || continue
+            name=$(basename "$app" .app)
+            (cd "$build/macos" && zip -r -9 -y "$GITHUB_WORKSPACE/release/${name// /-}-$GITHUB_REF_NAME-macos.zip" "$name.app")
+          done
+          for plugin in "$build"/windows/*.qlplugin; do
+            [ -e "$plugin" ] || continue
+            name=$(basename "$plugin" .qlplugin)
+            cp "$plugin" "release/${name// /-}-$GITHUB_REF_NAME-windows.qlplugin"
+          done
+          cd release
+          shasum -a 256 * > SHA256SUMS
 
       - uses: softprops/action-gh-release@v2
         with:
-          files: |
-            ${{ steps.package.outputs.zip }}
-            SHA256SUMS
+          files: release/*
           generate_release_notes: true

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-quicklook",
-  "version": "0.5.0",
-  "description": "Create a macOS Quick Look preview with any Vite-based web framework",
+  "version": "0.7.0",
+  "description": "Create Quick Look previews with Vite-based web frameworks",
   "license": "MIT",
   "keywords": [
     "quicklook",

package/templates/analog/package.json

@@ -12,18 +12,18 @@
 		"format": "biome check --write"
 	},
 	"devDependencies": {
-		"@analogjs/vite-plugin-angular": "2.8.0",
-		"@angular/build": "22.2.2",
-		"@angular/common": "22.2.2",
-		"@angular/compiler": "22.2.2",
-		"@angular/compiler-cli": "22.2.2",
-		"@angular/core": "22.2.2",
-		"@angular/platform-browser": "22.2.2",
-		"@biomejs/biome": "2.5.15",
-		"quicklook-kit": "^0.5.0",
+		"@analogjs/vite-plugin-angular": "2.9.1",
+		"@angular/build": "22.2.3",
+		"@angular/common": "22.2.3",
+		"@angular/compiler": "22.2.3",
+		"@angular/compiler-cli": "22.2.3",
+		"@angular/core": "22.2.3",
+		"@angular/platform-browser": "22.2.3",
+		"@biomejs/biome": "2.6.2",
+		"quicklook-kit": "^0.7.0",
 		"rxjs": "7.8.2",
 		"tslib": "2.8.1",
 		"typescript": "6.0.3",
-		"vite": "8.3.4"
+		"vite": "8.3.5"
 	}
 }

package/templates/analog/quicklook.config.ts

@@ -2,14 +2,16 @@ import { defineConfig } from 'quicklook-kit';
 
 export default defineConfig({
 	name: 'Quick Look Example',
-	bundleId: 'com.example.QuickLookExample',
-	types: [
-		{
-			id: 'com.example.QuickLookExample.example',
-			description: 'Example File',
-			extensions: ['example'],
-			conformsTo: ['public.plain-text'],
-		},
-	],
+	macos: {
+		bundleId: 'com.example.QuickLookExample',
+		types: [
+			{
+				id: 'com.example.QuickLookExample.example',
+				description: 'Example File',
+				extensions: ['example'],
+				conformsTo: ['public.plain-text'],
+			},
+		],
+	},
 	framework: 'analog',
 });

package/templates/astro/package.json

@@ -12,10 +12,10 @@
 		"format": "biome check --write"
 	},
 	"devDependencies": {
-		"@astrojs/check": "0.9.10",
-		"@biomejs/biome": "2.5.15",
-		"astro": "7.3.8",
-		"quicklook-kit": "^0.5.0",
+		"@astrojs/check": "0.9.12",
+		"@biomejs/biome": "2.6.2",
+		"astro": "7.4.2",
+		"quicklook-kit": "^0.7.0",
 		"typescript": "6.0.3"
 	}
 }

package/templates/astro/quicklook.config.ts

@@ -2,14 +2,16 @@ import { defineConfig } from 'quicklook-kit';
 
 export default defineConfig({
 	name: 'Quick Look Example',
-	bundleId: 'com.example.QuickLookExample',
-	types: [
-		{
-			id: 'com.example.QuickLookExample.example',
-			description: 'Example File',
-			extensions: ['example'],
-			conformsTo: ['public.plain-text'],
-		},
-	],
+	macos: {
+		bundleId: 'com.example.QuickLookExample',
+		types: [
+			{
+				id: 'com.example.QuickLookExample.example',
+				description: 'Example File',
+				extensions: ['example'],
+				conformsTo: ['public.plain-text'],
+			},
+		],
+	},
 	framework: 'astro',
 });

package/templates/nuxt/package.json

@@ -13,11 +13,11 @@
 		"format": "biome check --write"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.5.15",
-		"nuxt": "4.6.1",
-		"quicklook-kit": "^0.5.0",
+		"@biomejs/biome": "2.6.2",
+		"nuxt": "4.6.2",
+		"quicklook-kit": "^0.7.0",
 		"typescript": "6.0.3",
-		"vue": "3.5.43",
+		"vue": "3.5.44",
 		"vue-tsc": "3.3.13"
 	}
 }

package/templates/nuxt/quicklook.config.ts

@@ -2,14 +2,16 @@ import { defineConfig } from 'quicklook-kit';
 
 export default defineConfig({
 	name: 'Quick Look Example',
-	bundleId: 'com.example.QuickLookExample',
-	types: [
-		{
-			id: 'com.example.QuickLookExample.example',
-			description: 'Example File',
-			extensions: ['example'],
-			conformsTo: ['public.plain-text'],
-		},
-	],
+	macos: {
+		bundleId: 'com.example.QuickLookExample',
+		types: [
+			{
+				id: 'com.example.QuickLookExample.example',
+				description: 'Example File',
+				extensions: ['example'],
+				conformsTo: ['public.plain-text'],
+			},
+		],
+	},
 	framework: 'nuxt',
 });

package/templates/solid-start/package.json

@@ -12,13 +12,13 @@
 		"format": "biome check --write"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.5.15",
+		"@biomejs/biome": "2.6.2",
 		"@solidjs/router": "1.0.0",
 		"@solidjs/start": "2.0.6",
 		"nitro": "3.0.260903-beta",
-		"quicklook-kit": "^0.5.0",
+		"quicklook-kit": "^0.7.0",
 		"solid-js": "1.9.17",
 		"typescript": "6.0.3",
-		"vite": "8.3.4"
+		"vite": "8.3.5"
 	}
 }

package/templates/solid-start/quicklook.config.ts

@@ -2,14 +2,16 @@ import { defineConfig } from 'quicklook-kit';
 
 export default defineConfig({
 	name: 'Quick Look Example',
-	bundleId: 'com.example.QuickLookExample',
-	types: [
-		{
-			id: 'com.example.QuickLookExample.example',
-			description: 'Example File',
-			extensions: ['example'],
-			conformsTo: ['public.plain-text'],
-		},
-	],
+	macos: {
+		bundleId: 'com.example.QuickLookExample',
+		types: [
+			{
+				id: 'com.example.QuickLookExample.example',
+				description: 'Example File',
+				extensions: ['example'],
+				conformsTo: ['public.plain-text'],
+			},
+		],
+	},
 	framework: 'solid-start',
 });

package/templates/sveltekit/package.json

@@ -12,14 +12,14 @@
 		"format": "biome check --write"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.5.15",
+		"@biomejs/biome": "2.6.2",
 		"@sveltejs/adapter-static": "4.0.0",
-		"@sveltejs/kit": "3.0.1",
+		"@sveltejs/kit": "3.1.0",
 		"@sveltejs/vite-plugin-svelte": "7.3.1",
-		"quicklook-kit": "^0.5.0",
+		"quicklook-kit": "^0.7.0",
 		"svelte": "5.57.2",
-		"svelte-check": "4.7.6",
+		"svelte-check": "4.7.7",
 		"typescript": "6.0.3",
-		"vite": "8.3.4"
+		"vite": "8.3.5"
 	}
 }

package/templates/sveltekit/quicklook.config.ts

@@ -2,14 +2,16 @@ import { defineConfig } from 'quicklook-kit';
 
 export default defineConfig({
 	name: 'Quick Look Example',
-	bundleId: 'com.example.QuickLookExample',
-	types: [
-		{
-			id: 'com.example.QuickLookExample.example',
-			description: 'Example File',
-			extensions: ['example'],
-			conformsTo: ['public.plain-text'],
-		},
-	],
+	macos: {
+		bundleId: 'com.example.QuickLookExample',
+		types: [
+			{
+				id: 'com.example.QuickLookExample.example',
+				description: 'Example File',
+				extensions: ['example'],
+				conformsTo: ['public.plain-text'],
+			},
+		],
+	},
 	framework: 'sveltekit',
 });