create-conformal 0.6.2 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # create-conformal
 
+## 0.8.0
+
+### Minor Changes
+
+- 739063e: use isolated installs
+- bf6b0e1: update template to eslint 9
+- 34ed385: support react compiler and bump to react 19
+
+### Patch Changes
+
+- Updated dependencies [739063e]
+- Updated dependencies [bf6b0e1]
+- Updated dependencies [34ed385]
+  - @conformal/create-plugin@0.8.0
+
+## 0.7.0
+
+### Minor Changes
+
+- 2b139f7: Support check-licenses script
+
+### Patch Changes
+
+- Updated dependencies [2b139f7]
+  - @conformal/create-plugin@0.7.0
+
 ## 0.6.2
 
 ### Patch Changes

package/eslint.config.mjs

@@ -0,0 +1,18 @@
+import { defineConfig } from "eslint/config";
+import config from "eslint-config-custom";
+
+export default defineConfig([
+  config,
+  {
+    ignores: ["template/**"],
+  },
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    languageOptions: {
+      parserOptions: {
+        project: ["./tsconfig.json"],
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+]);

package/package.json

@@ -1,22 +1,26 @@
 {
+  "dependencies": {
+    "@conformal/stamp": "^0.3.5",
+    "@conformal/create-plugin": "^0.8.0",
+    "@commander-js/extra-typings": "^12.1.0",
+    "commander": "^12.1.0"
+  },
   "name": "create-conformal",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Project generator script for conformal projects",
   "homepage": "https://russellmcc.github.io/conformal",
   "bugs": "https://github.com/russellmcc/conformal/issues",
   "repository": "github:russellmcc/conformal",
   "license": "ISC",
   "scripts": {
-    "lint": "tsc && eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "tsc && eslint . --max-warnings 0",
     "check-format": "prettier -c .",
     "format": "prettier --write ."
   },
   "bin": "./src/index.ts",
   "type": "module",
-  "dependencies": {
-    "@conformal/stamp": "^0.3.5",
-    "@conformal/create-plugin": "^0.6.0",
-    "@commander-js/extra-typings": "^12.1.0",
-    "commander": "^12.1.0"
+  "devDependencies": {
+    "tmp-promise": "catalog:",
+    "zod": "catalog:"
   }
 }

package/package.json.bak

@@ -1,22 +1,27 @@
 {
+  "dependencies": {
+    "@conformal/stamp": "^0.3.5",
+    "@conformal/create-plugin": "^0.8.0",
+    "@commander-js/extra-typings": "^12.1.0",
+    "commander": "^12.1.0"
+  },
   "name": "create-conformal",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Project generator script for conformal projects",
   "homepage": "https://russellmcc.github.io/conformal",
   "bugs": "https://github.com/russellmcc/conformal/issues",
   "repository": "github:russellmcc/conformal",
   "license": "ISC",
   "scripts": {
-    "lint": "tsc && eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "tsc && eslint . --max-warnings 0",
     "check-format": "prettier -c .",
     "format": "prettier --write ."
   },
   "bin": "./src/index.ts",
   "type": "module",
-  "dependencies": {
-    "@conformal/stamp": "^0.3.5",
-    "@conformal/create-plugin": "^0.6.0",
-    "@commander-js/extra-typings": "^12.1.0",
-    "commander": "^12.1.0"
+  "devDependencies": {
+    "tmp-promise": "catalog:",
+    "eslint-config-custom": "workspace:*",
+    "zod": "catalog:"
   }
-}
+}

package/src/template.test.ts

@@ -6,6 +6,7 @@ import { $ } from "bun";
 import { Config, postBuild } from "./config";
 import { stampTemplate } from "@conformal/stamp";
 import { toEnv } from "@conformal/create-plugin";
+import { z } from "zod";
 
 const TEST_CONFIG: Config = {
   proj_slug: "test",
@@ -17,6 +18,22 @@ const TEST_CONFIG: Config = {
 
 const MINUTE = 60_000;
 
+const packageJsonSchema = z
+  .object({
+    catalog: z.optional(z.record(z.string(), z.string())),
+    dependencies: z.optional(z.record(z.string(), z.string())),
+    devDependencies: z.optional(z.record(z.string(), z.string())),
+    scripts: z.optional(
+      z
+        .object({
+          prepack: z.optional(z.string()),
+          postpack: z.optional(z.string()),
+        })
+        .passthrough(),
+    ),
+  })
+  .passthrough();
+
 describe("create-conformal template", () => {
   test(
     "passes CI",
@@ -31,15 +48,53 @@ describe("create-conformal template", () => {
             "..",
           );
 
-          const rewireDeps = async (dest: string) => {
-            // Note we use perl as a sed replacement because of https://github.com/oven-sh/bun/issues/13197,
-            // which makes sed unusable on macOS.
-            const perl_command = `s!"\\@conformal/([^"]+)": "[^"]+"!"\\@conformal/$1": "file://${tmpDir}/conformal-$1-0.0.0.tgz"!`;
-            await $`perl -pi -e ${perl_command} package.json`.cwd(dest);
+          type RewireDepsOptions = {
+            fixCatalog: boolean;
+          };
+          const rewireDeps = async (
+            dest: string,
+            { fixCatalog }: RewireDepsOptions = { fixCatalog: true },
+          ) => {
+            const rootPackageJson = packageJsonSchema.parse(
+              await Bun.file(`package.json`).json(),
+            );
 
-            // Replace the version with 0.0.0
-            await $`perl -pi -e 's!"version": "[^"]+"!"version": "0.0.0"!' package.json`.cwd(
-              dest,
+            const packageJson = packageJsonSchema.parse(
+              await Bun.file(`${dest}/package.json`).json(),
+            );
+
+            packageJson.version = "0.0.0";
+
+            const cleanupDict = (dict: Record<string, string>) => {
+              for (const [key, version] of Object.entries(dict)) {
+                if (key.startsWith("@conformal/")) {
+                  dict[key] =
+                    `file://${tmpDir}/conformal-${key.split("/")[1]}-0.0.0.tgz`;
+                }
+                if (version === "catalog:" && fixCatalog) {
+                  const catalogVersion = rootPackageJson.catalog?.[key];
+                  if (!catalogVersion) {
+                    throw new Error(
+                      `Catalog dependency ${key} not found in root package.json`,
+                    );
+                  }
+                  dict[key] = catalogVersion;
+                }
+              }
+            };
+            for (const dict of [
+              packageJson.dependencies,
+              packageJson.catalog,
+              packageJson.devDependencies,
+            ]) {
+              if (dict) {
+                cleanupDict(dict);
+              }
+            }
+
+            await Bun.write(
+              `${dest}/package.json`,
+              JSON.stringify(packageJson, null, 2),
             );
           };
 
@@ -76,18 +131,13 @@ describe("create-conformal template", () => {
             await rewireDeps(extractDir);
 
             // Remove any "prepack" and "postpack" scripts as these have already been run
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            const packageJson = await Bun.file(
-              `${extractDir}/package.json`,
-            ).json();
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            const packageJson = packageJsonSchema.parse(
+              await Bun.file(`${extractDir}/package.json`).json(),
+            );
             if (packageJson.scripts?.prepack) {
-              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
               delete packageJson.scripts.prepack;
             }
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             if (packageJson.scripts?.postpack) {
-              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
               delete packageJson.scripts.postpack;
             }
             await Bun.write(
@@ -118,12 +168,13 @@ describe("create-conformal template", () => {
           );
           await postBuild(TEST_CONFIG, env, tmpDir);
 
-          await rewireDeps(dest);
+          // We want to use the catalog from the template
+          await rewireDeps(dest, { fixCatalog: false });
 
           await $`bun install`.cwd(dest);
 
           // Add a synth target
-          await $`bun x conformal-scripts create-plugin --plug_type synth --plug_slug test_synth --vendor_name "Test Vendor" --plug_name "Test Synth"`.cwd(
+          await $`bun run create-plugin --plug_type synth --plug_slug test_synth --vendor_name "Test Vendor" --plug_name "Test Synth"`.cwd(
             dest,
           );
 
@@ -132,6 +183,9 @@ describe("create-conformal template", () => {
             dest,
           );
 
+          // We have to re-install after adding new packages, now that dependencies are isolated.
+          await $`bun install`.cwd(dest);
+
           // In CI, we will have a 0.0.0 version for the conformal crates.
           // Replace these with a link to the local crate
           const createDependencies = ["component", "vst_wrapper", "poly"];

package/template/package.json

@@ -10,6 +10,7 @@
     "check-lfs": "conformal-scripts check-lfs",
     "check-todo": "conformal-scripts check-todo",
     "check-format": "conformal-scripts check-format",
+    "check-licenses": "conformal-scripts check-licenses",
     "create-plugin": "conformal-scripts create-plugin",
     "format": "conformal-scripts format",
     "web-dev": "conformal-scripts web-script -s dev",
@@ -26,23 +27,29 @@
   },
   "devDependencies": {
     "@types/bun": "^1.2.22",
-    "@typescript-eslint/eslint-plugin": "^8.28.0",
-    "@typescript-eslint/parser": "^8.28.0",
-    "@vitejs/plugin-react-swc": "^3.6.0",
-    "@types/react": "^18.2.79",
-    "@types/react-dom": "^18.2.25",
-    "eslint": "^8.57.1",
-    "eslint-plugin-prefer-arrow-functions": "^3.6.2",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-hooks": "^5.2.0",
-    "eslint-plugin-react-refresh": "^0.4.19",
+    "eslint": "^9.39.1",
     "prettier": "^3.2.5",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
     "typescript": "^5.4.5",
-    "vite": "^5.2.9",
     "@conformal/scripts": "^0.3.5",
+    "tsconfig": "workspace:*"
+  },
+  "catalog": {
     "@conformal/plugin": "^0.3.5",
-    "rollup-plugin-license": "^3.4.0"
+    "rollup-plugin-license": "^3.4.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "eslint-plugin-prefer-arrow-functions": "^3.9.1",
+    "typescript-eslint": "^8.46.3",
+    "vite": "^5.2.9",
+    "jotai": "^2.14.0",
+    "globals": "^16.5.0",
+    "@eslint/js": "^9.39.1",
+    "@vitejs/plugin-react": "^5.1.0",
+    "babel-plugin-react-compiler": "^1.0.0"
   }
 }

package/template/web/eslint-config-custom/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { defineConfig } from "eslint/config";
+import config from "eslint-config-custom";
+
+export default defineConfig([config]);

package/template/web/eslint-config-custom/index.mjs

@@ -0,0 +1,81 @@
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import js from "@eslint/js";
+import ts from "typescript-eslint";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import react from "eslint-plugin-react";
+import preferArrowFunctions from "eslint-plugin-prefer-arrow-functions";
+
+export default defineConfig([
+  js.configs.recommended,
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    extends: [
+      ts.configs.recommended,
+      ts.configs.strictTypeChecked,
+      ts.configs.stylisticTypeChecked,
+    ],
+    rules: {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          argsIgnorePattern: "^_",
+        },
+      ],
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/restrict-template-expressions": [
+        "error",
+        { allowNumber: true },
+      ],
+      "@typescript-eslint/no-unnecessary-condition": [
+        "error",
+        { allowConstantLoopConditions: true },
+      ],
+      "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+    },
+  },
+  react.configs.flat.recommended ?? [],
+  react.configs.flat["jsx-runtime"] ?? [],
+  reactHooks.configs.flat.recommended,
+  reactRefresh.configs.recommended,
+  preferArrowFunctions.configs.all,
+  {
+    ignores: ["dist"],
+  },
+  {
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
+    },
+    rules: {
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
+      "react-hooks/exhaustive-deps": "error",
+      "prefer-arrow-functions/prefer-arrow-functions": [
+        "error",
+        {
+          returnStyle: "implicit",
+        },
+      ],
+      "no-warning-comments": "error",
+    },
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+    languageOptions: {
+      ecmaVersion: "latest",
+      globals: {
+        ...globals.browser,
+        __dirname: "readonly",
+      },
+      parserOptions: {
+        sourceType: "module",
+      },
+    },
+  },
+]);

package/template/web/eslint-config-custom/package.json

@@ -1,5 +1,22 @@
 {
   "name": "eslint-config-custom",
-  "main": "config.cjs",
-  "private": true
+  "exports": {
+    ".": {
+      "default": "./index.mjs"
+    }
+  },
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "lint": "eslint . --max-warnings 0"
+  },
+  "dependencies": {
+    "globals": "catalog:",
+    "@eslint/js": "catalog:",
+    "eslint-plugin-react": "catalog:",
+    "eslint-plugin-react-hooks": "catalog:",
+    "eslint-plugin-react-refresh": "catalog:",
+    "eslint-plugin-prefer-arrow-functions": "catalog:",
+    "typescript-eslint": "catalog:"
+  }
 }

package/.eslintrc.cjs

@@ -1,9 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ["eslint-config-custom"],
-  parserOptions: {
-    project: ["./tsconfig.json"],
-    tsconfigRootDir: __dirname,
-  },
-  ignorePatterns: ["template/**"],
-};

package/template/bunfig.toml

@@ -1,2 +0,0 @@
-[install]
-linker = "hoisted"

package/template/web/eslint-config-custom/config.cjs

@@ -1,54 +0,0 @@
-module.exports = {
-  root: true,
-  env: { browser: true, es2020: true },
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/strict-type-checked",
-    "plugin:@typescript-eslint/stylistic-type-checked",
-    "plugin:react-hooks/recommended",
-    "plugin:react/recommended",
-    "plugin:react/jsx-runtime",
-  ],
-  ignorePatterns: ["dist", ".eslintrc.cjs"],
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    ecmaVersion: "latest",
-    sourceType: "module",
-  },
-  plugins: ["react-refresh", "prefer-arrow-functions"],
-  rules: {
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      {
-        argsIgnorePattern: "^_",
-      },
-    ],
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/restrict-template-expressions": [
-      "error",
-      { allowNumber: true },
-    ],
-    "@typescript-eslint/no-unnecessary-condition": [
-      "error",
-      { allowConstantLoopConditions: true },
-    ],
-    "react-refresh/only-export-components": [
-      "warn",
-      { allowConstantExport: true },
-    ],
-    "react-hooks/exhaustive-deps": "error",
-    "prefer-arrow-functions/prefer-arrow-functions": [
-      "error",
-      {
-        returnStyle: "implicit",
-      },
-    ],
-    "@typescript-eslint/consistent-type-definitions": ["error", "type"],
-    "no-warning-comments": "error",
-  },
-  settings: {
-    react: {
-      version: "detect",
-    },
-  },
-};