@ciridae/configs 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @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

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

@@ -128,7 +128,6 @@ function createStrictReactAppConfig(
         "@typescript-eslint/no-unsafe-member-access": "error",
         "@typescript-eslint/no-unsafe-return": "error",
         "@typescript-eslint/switch-exhaustiveness-check": "error",
-        "import-x/no-cycle": "error",
         "import-x/no-self-import": "error",
         "@eslint-react/no-nested-component-definitions": "error",
         "@eslint-react/no-unstable-context-value": "error",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ciridae/configs",
-  "version": "0.3.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,7 +25,11 @@
     "./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"
@@ -39,6 +45,20 @@
     "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"] },
+      }),
+    ),
+  ];
+}