@ciridae/configs 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ciridae/configs
 
+## 0.4.0
+
+### Minor Changes
+
+- Add `@ciridae/configs/vite` with `versionManifest`, which writes `version.json` for the update prompt, and `sentrySourceMaps`, which uploads production source maps to Sentry when its credentials are set.
+
+## 0.3.0
+
+### Minor Changes
+
+- Keep one ESLint 10 preset with regexp correctness checks and remove copied code-shape, compiler-advisory, and Tailwind lint policy.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -23,3 +23,20 @@ export { default } from "@ciridae/configs/prettier" with { type: "json" }
   "extends": "@ciridae/configs/tsconfig/frontend-app.json"
 }
 ```
+
+## Vite
+
+```ts
+import { sentrySourceMaps, versionManifest } from "@ciridae/configs/vite"
+
+export default defineConfig(({ mode }) => ({
+  plugins: [
+    versionManifest({ buildSha: process.env.VITE_BUILD_SHA ?? "development" }),
+    sentrySourceMaps({ mode }),
+  ],
+}))
+```
+
+`versionManifest` writes `version.json` beside the bundle so an open tab can
+tell a newer build is deployed. `sentrySourceMaps` uploads production source
+maps when `SENTRY_ORG`, `SENTRY_PROJECT`, and `SENTRY_AUTH_TOKEN` are set.

package/eslint.js

@@ -1,26 +1,49 @@
-import { fixupPluginRules } from "@eslint/compat";
 import eslintReact from "@eslint-react/eslint-plugin";
 import js from "@eslint/js";
 import { createNodeResolver, importX } from "eslint-plugin-import-x";
 import globals from "globals";
 import reactHooks from "eslint-plugin-react-hooks";
 import reactRefresh from "eslint-plugin-react-refresh";
-import tailwindcss from "eslint-plugin-tailwindcss";
+import regexpPlugin from "eslint-plugin-regexp";
 import tseslint from "typescript-eslint";
 
-const typeAssertionBan = [
-  {
-    selector:
-      "TSAsExpression:not([typeAnnotation.type='TSTypeReference'][typeAnnotation.typeName.name='const'])",
-    message:
-      "Type assertions are banned. Prefer narrowing, parser/schema validation, or an eslint-disable with justification.",
-  },
-  {
-    selector: "TSTypeAssertion",
-    message:
-      "Type assertions are banned. Prefer narrowing, parser/schema validation, or an eslint-disable with justification.",
-  },
-];
+const reactCompilerAdvisoryRules = {
+  "react-hooks/config": "off",
+  "react-hooks/gating": "off",
+  "react-hooks/globals": "off",
+  "react-hooks/immutability": "off",
+  "react-hooks/incompatible-library": "off",
+  "react-hooks/preserve-manual-memoization": "off",
+  "react-hooks/purity": "off",
+  "react-hooks/refs": "off",
+  "react-hooks/set-state-in-effect": "off",
+  "react-hooks/static-components": "off",
+  "react-hooks/unsupported-syntax": "off",
+  "react-hooks/use-memo": "off",
+};
+
+const recommendedRegexpRules = Object.fromEntries(
+  Object.entries(regexpPlugin.configs["flat/recommended"].rules)
+    .filter(
+      ([ruleName, setting]) =>
+        ruleName.startsWith("regexp/") && setting !== "off" && setting !== 0,
+    )
+    .map(([ruleName, setting]) => [
+      ruleName,
+      Array.isArray(setting) ? ["error", ...setting.slice(1)] : "error",
+    ]),
+);
+
+const regexpRules = {
+  ...recommendedRegexpRules,
+  "no-empty-character-class": "off",
+  "no-invalid-regexp": "off",
+  "no-misleading-character-class": "off",
+  "no-useless-backreference": "off",
+  "prefer-regex-literals": "error",
+  "regexp/no-super-linear-move": "error",
+  "regexp/prefer-escape-replacement-dollar-char": "error",
+};
 
 export function reactAppConfig({ ignores = ["dist"], rules = {} } = {}) {
   return tseslint.config(
@@ -35,9 +58,12 @@ export function reactAppConfig({ ignores = ["dist"], rules = {} } = {}) {
       plugins: {
         "react-hooks": reactHooks,
         "react-refresh": reactRefresh,
+        regexp: regexpPlugin,
       },
       rules: {
         ...reactHooks.configs.recommended.rules,
+        ...reactCompilerAdvisoryRules,
+        ...regexpRules,
         "react-refresh/only-export-components": [
           "warn",
           { allowConstantExport: true },
@@ -57,9 +83,6 @@ function createStrictReactAppConfig(
   {
     ignores = ["dist"],
     tsconfigRootDir,
-    maxLines = 300,
-    maxLinesPerFunction = 80,
-    tailwindCssFiles,
     rules = {},
     settings = {},
     testFiles = ["**/*.test.{ts,tsx}", "**/test/**/*.{ts,tsx}"],
@@ -71,7 +94,7 @@ function createStrictReactAppConfig(
     "import-x": importX,
     "react-hooks": reactHooks,
     "react-refresh": reactRefresh,
-    tailwindcss: fixupPluginRules(tailwindcss),
+    regexp: regexpPlugin,
   };
 
   return tseslint.config(
@@ -93,6 +116,8 @@ function createStrictReactAppConfig(
       plugins,
       rules: {
         ...plugins["react-hooks"].configs.recommended.rules,
+        ...reactCompilerAdvisoryRules,
+        ...regexpRules,
         "@typescript-eslint/no-explicit-any": "error",
         "@typescript-eslint/no-non-null-assertion": "error",
         "@typescript-eslint/no-unnecessary-type-assertion": "error",
@@ -103,25 +128,7 @@ function createStrictReactAppConfig(
         "@typescript-eslint/no-unsafe-member-access": "error",
         "@typescript-eslint/no-unsafe-return": "error",
         "@typescript-eslint/switch-exhaustiveness-check": "error",
-        complexity: ["error", 12],
-        "import-x/no-cycle": "error",
         "import-x/no-self-import": "error",
-        "max-depth": ["error", 3],
-        "max-lines": [
-          "error",
-          { max: maxLines, skipBlankLines: true, skipComments: true },
-        ],
-        "max-lines-per-function": [
-          "error",
-          {
-            max: maxLinesPerFunction,
-            skipBlankLines: true,
-            skipComments: true,
-          },
-        ],
-        "max-nested-callbacks": ["error", 3],
-        "max-params": ["error", 4],
-        "no-restricted-syntax": ["error", ...typeAssertionBan],
         "@eslint-react/no-nested-component-definitions": "error",
         "@eslint-react/no-unstable-context-value": "error",
         "react-refresh/only-export-components": [
@@ -138,14 +145,6 @@ function createStrictReactAppConfig(
         "import-x/resolver-next": [
           createNodeResolver({ extensions: [".js", ".jsx", ".ts", ".tsx"] }),
         ],
-        ...(tailwindCssFiles
-          ? {
-              tailwindcss: {
-                config: {},
-                cssFiles: tailwindCssFiles,
-              },
-            }
-          : {}),
         ...settings,
       },
     },
@@ -159,10 +158,6 @@ function createStrictReactAppConfig(
         "@typescript-eslint/no-unsafe-return": "off",
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-non-null-assertion": "off",
-        "no-restricted-syntax": "off",
-        "max-lines-per-function": "off",
-        "max-lines": "off",
-        "max-nested-callbacks": "off",
       },
     },
     ...overrides,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ciridae/configs",
-  "version": "0.2.0",
-  "description": "Shared ESLint, Prettier, and TypeScript configurations for Ciridae projects.",
+  "version": "0.4.0",
+  "description": "Shared ESLint, Prettier, TypeScript, and Vite configurations for Ciridae projects.",
   "type": "module",
   "engines": {
     "node": ">=22.18"
@@ -16,6 +16,8 @@
     "CHANGELOG.md",
     "eslint.js",
     "prettier.json",
+    "vite.js",
+    "vite.d.ts",
     "tsconfig"
   ],
   "exports": {
@@ -23,23 +25,40 @@
     "./eslint": "./eslint.js",
     "./prettier": "./prettier.json",
     "./tsconfig/frontend-app.json": "./tsconfig/frontend-app.json",
-    "./tsconfig/frontend-node.json": "./tsconfig/frontend-node.json"
+    "./tsconfig/frontend-node.json": "./tsconfig/frontend-node.json",
+    "./vite": {
+      "types": "./vite.d.ts",
+      "default": "./vite.js"
+    }
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@eslint/compat": "^2.1.0",
     "@eslint-react/eslint-plugin": "^5.14.6",
     "@eslint/js": "^10.0.1",
     "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-react-refresh": "^0.5.3",
-    "eslint-plugin-tailwindcss": "4.0.5",
+    "eslint-plugin-regexp": "^3.1.1",
     "globals": "^17.7.0",
     "typescript-eslint": "^8.63.0"
   },
   "peerDependencies": {
-    "eslint": "^10.7.0"
+    "eslint": "^10.7.0",
+    "vite": ">=8",
+    "@sentry/vite-plugin": ">=5"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    },
+    "@sentry/vite-plugin": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@sentry/vite-plugin": "^5.2.1",
+    "vite": "catalog:frontend8"
   }
 }

package/vite.d.ts

@@ -0,0 +1,8 @@
+import type { Plugin, PluginOption } from "vite";
+
+export function versionManifest(options: {
+  buildSha: string;
+  deployedBuildSha?: string;
+}): Plugin[];
+
+export function sentrySourceMaps(options: { mode: string }): PluginOption;

package/vite.js

@@ -0,0 +1,63 @@
+/**
+ * Writes `version.json` beside the bundle so an open tab can tell the deployment moved on
+ * without it. In development it serves the same file, and a `deployedBuildSha` other than
+ * `buildSha` exercises the update prompt.
+ *
+ * @param {{ buildSha: string, deployedBuildSha?: string }} options
+ * @returns {import("vite").Plugin[]}
+ */
+export function versionManifest({ buildSha, deployedBuildSha = buildSha }) {
+  return [
+    {
+      name: "ciridae-version-manifest",
+      apply: "build",
+      generateBundle() {
+        this.emitFile({
+          type: "asset",
+          fileName: "version.json",
+          source: `${JSON.stringify({ buildSha })}\n`,
+        });
+      },
+    },
+    {
+      name: "ciridae-dev-version-manifest",
+      apply: "serve",
+      configureServer(server) {
+        server.middlewares.use("/version.json", (_request, response) => {
+          response.setHeader("Content-Type", "application/json");
+          response.end(`${JSON.stringify({ buildSha: deployedBuildSha })}\n`);
+        });
+      },
+    },
+  ];
+}
+
+/**
+ * Uploads production source maps to Sentry, then deletes them from the output, when the build
+ * has `SENTRY_ORG`, `SENTRY_PROJECT`, and `SENTRY_AUTH_TOKEN`. Otherwise it adds nothing.
+ *
+ * @param {{ mode: string }} options
+ * @returns {import("vite").PluginOption}
+ */
+export function sentrySourceMaps({ mode }) {
+  const {
+    SENTRY_ORG: org,
+    SENTRY_PROJECT: project,
+    SENTRY_AUTH_TOKEN: authToken,
+  } = process.env;
+  if (mode !== "production" || !org || !project || !authToken) return [];
+  return [
+    {
+      name: "ciridae-sentry-source-maps",
+      config: () => ({ build: { sourcemap: "hidden" } }),
+    },
+    import("@sentry/vite-plugin").then(({ sentryVitePlugin }) =>
+      sentryVitePlugin({
+        org,
+        project,
+        authToken,
+        sourcemaps: { filesToDeleteAfterUpload: ["dist/**/*.js.map"] },
+      }),
+    ),
+  ];
+}