Merge pull request #1 from QwikDev/feat/upgrade

feat: v2 migration files

Author: thejackshelton

.planning/STATE.md

@@ -0,0 +1,72 @@
+import MagicString from "magic-string";
+import { parseSync } from "oxc-parser";
+import { readFileSync, writeFileSync } from "node:fs";
+import type { SourceReplacement, TransformFn } from "./types.ts";
+
+/**
+ * Parse-once, fan-out orchestrator for AST-based source transforms.
+ *
+ * Algorithm:
+ * 1. Early return if no transforms provided
+ * 2. Read source from disk once
+ * 3. Parse once with oxc-parser; share ParseResult across all transforms
+ * 4. Fan out: collect SourceReplacement[] from each transform into a flat list
+ * 5. Early return if no replacements collected (file unchanged)
+ * 6. Sort replacements descending by `start` (later offsets first) to prevent
+ *    MagicString offset corruption when applying earlier edits
+ * 7. Apply all replacements via a single MagicString instance
+ * 8. Write back to disk only if content changed
+ *
+ * @param filePath   - Absolute path to the file to transform
+ * @param transforms - Array of transform functions to apply
+ */
+export function applyTransforms(filePath: string, transforms: TransformFn[]): void {
+  // Step 1: Early return for empty transform list
+  if (transforms.length === 0) return;
+
+  // Step 2: Read source once
+  const source = readFileSync(filePath, "utf-8");
+
+  // Step 3: Parse once
+  const parseResult = parseSync(filePath, source, { sourceType: "module" });
+
+  // Step 4: Fan out — collect all replacements
+  const allReplacements: SourceReplacement[] = [];
+  for (const transform of transforms) {
+    const replacements = transform(filePath, source, parseResult);
+    allReplacements.push(...replacements);
+  }
+
+  // Step 5: Early return if nothing to replace
+  if (allReplacements.length === 0) return;
+
+  // Step 6: Sort descending by start so later offsets are applied first
+  allReplacements.sort((a, b) => b.start - a.start);
+
+  // Step 6b: Detect overlapping replacements before applying (magic-string does not
+  // always throw a useful error; we surface a descriptive one instead).
+  // After descending sort, replacement[i].start >= replacement[i+1].start.
+  // A collision occurs when replacement[i+1].end > replacement[i].start.
+  for (let i = 0; i < allReplacements.length - 1; i++) {
+    const curr = allReplacements[i]!;
+    const next = allReplacements[i + 1]!;
+    if (next.end > curr.start) {
+      throw new Error(
+        `applyTransforms: overlapping replacements detected in "${filePath}". ` +
+          `Replacement at [${next.start}, ${next.end}) overlaps with [${curr.start}, ${curr.end}). ` +
+          `Each transform must produce non-overlapping SourceReplacement ranges.`,
+      );
+    }
+  }
+
+  // Step 7: Apply via single MagicString instance
+  const ms = new MagicString(source);
+  for (const { start, end, replacement } of allReplacements) {
+    ms.overwrite(start, end, replacement);
+  }
+
+  // Step 8: Write back only when content changed
+  if (ms.hasChanged()) {
+    writeFileSync(filePath, ms.toString(), "utf-8");
+  }
+}

.planning/quick/11-set-up-ci-github-actions-workflow/11-SUMMARY.md

@@ -1,8 +1,9 @@
 import { extname } from "node:path";
 
 /**
- * Set of known binary file extensions (lowercased, including the dot).
- * Based on the sindresorhus/binary-extensions list.
+ * Pruned set of binary file extensions relevant to Qwik projects (lowercased, including the dot).
+ * Contains ~50 essential entries covering images, fonts, archives, executables, audio, video, and
+ * other common binary formats. Excludes niche formats unlikely to appear in a Qwik project.
  */
 export const BINARY_EXTENSIONS: Set<string> = new Set([
   // Images
@@ -16,42 +17,17 @@ export const BINARY_EXTENSIONS: Set<string> = new Set([
   ".svg",
   ".tiff",
   ".tif",
-  ".psd",
-  ".ai",
-  ".eps",
-  ".raw",
-  ".cr2",
-  ".nef",
-  ".orf",
-  ".sr2",
   ".avif",
   ".heic",
   ".heif",
-  ".jxl",
   ".apng",
-  ".cur",
-  ".ani",
-  ".jfif",
-  ".jp2",
-  ".j2k",
-  ".jpf",
-  ".jpx",
-  ".jpm",
 
-  // Documents
-  ".pdf",
-  ".doc",
-  ".docx",
-  ".xls",
-  ".xlsx",
-  ".ppt",
-  ".pptx",
-  ".odt",
-  ".ods",
-  ".odp",
-  ".pages",
-  ".numbers",
-  ".key",
+  // Fonts
+  ".woff",
+  ".woff2",
+  ".ttf",
+  ".eot",
+  ".otf",
 
   // Archives
   ".zip",
@@ -61,56 +37,16 @@ export const BINARY_EXTENSIONS: Set<string> = new Set([
   ".7z",
   ".bz2",
   ".xz",
-  ".lz",
-  ".lzma",
-  ".z",
   ".tgz",
-  ".tbz",
-  ".tbz2",
-  ".txz",
-  ".tlz",
-  ".cab",
-  ".deb",
-  ".rpm",
-  ".apk",
-  ".ipa",
-  ".crx",
-  ".iso",
-  ".img",
-  ".dmg",
-  ".pkg",
-  ".msi",
 
   // Executables and binaries
   ".exe",
   ".dll",
   ".so",
   ".dylib",
-  ".lib",
   ".a",
   ".o",
-  ".obj",
-  ".pdb",
-  ".com",
-  ".bat",
-  ".cmd",
-  ".scr",
-  ".msc",
   ".bin",
-  ".elf",
-  ".out",
-  ".app",
-
-  // Fonts
-  ".woff",
-  ".woff2",
-  ".ttf",
-  ".eot",
-  ".otf",
-  ".fon",
-  ".fnt",
-  ".pfb",
-  ".pfm",
 
   // Audio
   ".mp3",
@@ -119,122 +55,24 @@ export const BINARY_EXTENSIONS: Set<string> = new Set([
   ".flac",
   ".aac",
   ".m4a",
-  ".wma",
-  ".aiff",
-  ".aif",
-  ".au",
   ".opus",
-  ".mid",
-  ".midi",
-  ".ra",
-  ".ram",
-  ".amr",
 
   // Video
   ".mp4",
   ".avi",
   ".mov",
   ".mkv",
-  ".wmv",
-  ".flv",
   ".webm",
   ".m4v",
-  ".3gp",
-  ".3g2",
-  ".ogv",
-  ".mts",
-  ".m2ts",
-  ".vob",
-  ".mpg",
-  ".mpeg",
-  ".m2v",
-  ".m4p",
-  ".m4b",
-  ".m4r",
-  ".f4v",
-  ".f4a",
-  ".f4b",
-  ".f4p",
-  ".swf",
-  ".asf",
-  ".rm",
-  ".rmvb",
-  ".divx",
-
-  // Java / compiled bytecode
-  ".class",
-  ".jar",
-  ".war",
-  ".ear",
-
-  // Python compiled
-  ".pyc",
-  ".pyo",
-  ".pyd",
 
   // WebAssembly
   ".wasm",
 
-  // Databases / data stores
+  // Documents / data
+  ".pdf",
   ".sqlite",
-  ".sqlite3",
   ".db",
-  ".db3",
-  ".s3db",
-  ".sl3",
-  ".mdb",
-  ".accdb",
-
-  // 3D / game assets
-  ".blend",
-  ".fbx",
-  ".obj",
-  ".dae",
-  ".3ds",
-  ".max",
-  ".ma",
-  ".mb",
-  ".stl",
-  ".glb",
-  ".gltf",
-  ".nif",
-  ".bsa",
-  ".pak",
-  ".unity",
-  ".unitypackage",
-
-  // Flash
-  ".swf",
-  ".fla",
-
-  // Disk images
-  ".vmdk",
-  ".vhd",
-  ".vdi",
-  ".qcow2",
-
-  // Certificates / keys
-  ".der",
-  ".cer",
-  ".crt",
-  ".p12",
-  ".pfx",
-  ".p7b",
-
-  // Other binary formats
-  ".nupkg",
-  ".snupkg",
-  ".rdb",
-  ".ldb",
-  ".lnk",
-  ".DS_Store",
   ".plist",
-  ".xib",
-  ".nib",
-  ".icns",
-  ".dSYM",
-  ".map",
-  ".min",
 ]);
 
 /**