@reticlehq/vite-plugin 3.2.0 → 3.4.0

package/dist/stamping.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Which files get a `data-reticle-source` stamp, and how.
+ *
+ * Split out of index.ts when that file crossed the line cap while gaining the per-file opt-out.
+ * This is one concern — a module id comes in, and either a stamper runs on it, nothing does, or the
+ * file has asked to be left alone — and it changes for one reason (the source-pointer feature)
+ * rather than for the dozen the plugin's lifecycle does. The Svelte stamper is its sibling module;
+ * the JSX one is `@reticlehq/babel-plugin`, which also reads the opt-out on its own for the callers
+ * that reach it without Vite.
+ */
+export declare const NODE_MODULES = "node_modules";
+/** A module id we may stamp at all: not virtual, not a dependency. Extension decides which stamper. */
+export declare function stampableId(id: string): string | null;
+export declare function shouldStamp(id: string): boolean;
+/** A `.svelte` single-file component, which needs the Svelte stamper rather than Babel. */
+export declare function shouldStampSvelte(id: string): boolean;
+export declare function stamp(code: string, id: string): {
+    code: string;
+    map: string | null;
+} | null;
+/**
+ * Has this file asked not to be stamped?
+ *
+ * Decided ahead of BOTH stampers, so the Svelte path honours the marker too and so the opt-out is
+ * announced once regardless of which stamper would have run. Only a file one of them would have
+ * touched can opt out — an id that was never stampable has nothing to announce (#853).
+ */
+export declare function optsOutOfStamping(code: string, id: string): boolean;
+/**
+ * The one line said when a file opts out of source stamping with `@reticle-ignore`.
+ *
+ * Not silent, on purpose. An opt-out nobody is told about is an opt-out somebody forgets, and the
+ * `file:line` it would have produced quietly stops resolving months later with nothing to point at
+ * the comment. Said once per file, in the dev-server output where the person who added the comment
+ * will see it. Exported for the test that pins the wording.
+ */
+export declare function ignoredFileNotice(id: string): string;

package/dist/stamping.js

@@ -0,0 +1,99 @@
+/**
+ * Which files get a `data-reticle-source` stamp, and how.
+ *
+ * Split out of index.ts when that file crossed the line cap while gaining the per-file opt-out.
+ * This is one concern — a module id comes in, and either a stamper runs on it, nothing does, or the
+ * file has asked to be left alone — and it changes for one reason (the source-pointer feature)
+ * rather than for the dozen the plugin's lifecycle does. The Svelte stamper is its sibling module;
+ * the JSX one is `@reticlehq/babel-plugin`, which also reads the opt-out on its own for the callers
+ * that reach it without Vite.
+ */
+import { transformSync } from '@babel/core';
+import reticleSource from '@reticlehq/babel-plugin';
+import { isSourceStampingIgnored } from '@reticlehq/babel-plugin/ignore';
+import { RETICLE_IGNORE_MARKER } from '@reticlehq/core';
+import { SVELTE_FILE } from './svelte-source.js';
+/** Files we stamp with source info — JSX/TSX only. */
+const JSX_FILE = /\.[jt]sx$/;
+/** Rollup virtual-module ids start with a NUL byte; never transform those. */
+const VIRTUAL_PREFIX = '\0';
+export const NODE_MODULES = 'node_modules';
+/** A module id we may stamp at all: not virtual, not a dependency. Extension decides which stamper. */
+export function stampableId(id) {
+    if (id.startsWith(VIRTUAL_PREFIX))
+        return null;
+    if (id.includes(NODE_MODULES))
+        return null;
+    // Strip any query suffix (?worker, ?raw,...) before matching the extension.
+    return id.split('?')[0] ?? id;
+}
+/**
+ * A test file, by the names every JS test runner agrees on.
+ *
+ * `.test.`/`.spec.` before the extension, or anywhere under a `__tests__` directory. Anchored to a
+ * path SEGMENT and a dot so `TestBanner.tsx`, `latest.tsx` and `contest.tsx` stay ordinary
+ * components — they are somebody's app, and skipping them would silently cost source mapping.
+ */
+const TEST_FILE = /(?:\.(?:test|spec)\.[^./]+$)|(?:^|\/)__tests__\//;
+export function shouldStamp(id) {
+    const clean = stampableId(id);
+    if (null === clean)
+        return false;
+    /*
+     * A test file is not the app under test.
+     *
+     * Nothing reads `data-reticle-source` on one — an agent inspects the app's DOM, never a test's —
+     * so stamping them is pure cost, charged per file on every run, and reported from the field as
+     * nearly doubling a large jsdom suite and failing a test that passed without instrumentation:
+     * inserting attributes into JSX is exactly what an assertion on rendered output notices (#995).
+     *
+     * Cut on the NAME rather than on "are we under Vitest": `vitest-browser.ts` records what happened
+     * the last time that was cut on the `VITEST` env var, which also reads true when a Vitest suite
+     * boots an app in order to test it. A name check cannot make that mistake.
+     */
+    if (TEST_FILE.test(clean))
+        return false;
+    return JSX_FILE.test(clean);
+}
+/** A `.svelte` single-file component, which needs the Svelte stamper rather than Babel. */
+export function shouldStampSvelte(id) {
+    const clean = stampableId(id);
+    return clean !== null && SVELTE_FILE.test(clean);
+}
+export function stamp(code, id) {
+    const out = transformSync(code, {
+        filename: id,
+        plugins: [reticleSource],
+        parserOpts: { plugins: ['jsx', 'typescript'] },
+        sourceMaps: true,
+        configFile: false,
+        babelrc: false,
+    });
+    if (out?.code === undefined || null === out.code)
+        return null;
+    return {
+        code: out.code,
+        map: out.map === undefined || null === out.map ? null : JSON.stringify(out.map),
+    };
+}
+/**
+ * Has this file asked not to be stamped?
+ *
+ * Decided ahead of BOTH stampers, so the Svelte path honours the marker too and so the opt-out is
+ * announced once regardless of which stamper would have run. Only a file one of them would have
+ * touched can opt out — an id that was never stampable has nothing to announce (#853).
+ */
+export function optsOutOfStamping(code, id) {
+    return (shouldStamp(id) || shouldStampSvelte(id)) && isSourceStampingIgnored(code);
+}
+/**
+ * The one line said when a file opts out of source stamping with `@reticle-ignore`.
+ *
+ * Not silent, on purpose. An opt-out nobody is told about is an opt-out somebody forgets, and the
+ * `file:line` it would have produced quietly stops resolving months later with nothing to point at
+ * the comment. Said once per file, in the dev-server output where the person who added the comment
+ * will see it. Exported for the test that pins the wording.
+ */
+export function ignoredFileNotice(id) {
+    return `[reticle] ${id} opts out of source stamping (${RETICLE_IGNORE_MARKER} on its first line) — elements in it will have no file:line.`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reticlehq/vite-plugin",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "Vite plugin for Reticle: dev-only source-map stamping plus auto-injected reticle.connect(). apply:'serve' guarantees it never ships to production.",
   "type": "module",
   "license": "Apache-2.0",
@@ -41,15 +41,15 @@
   ],
   "dependencies": {
     "@babel/core": "^7.26.0",
-    "@reticlehq/babel-plugin": "3.2.0",
-    "@reticlehq/core": "3.2.0"
+    "@reticlehq/babel-plugin": "3.4.0",
+    "@reticlehq/core": "3.4.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.20.5",
     "esbuild": "^0.28.2",
-    "svelte": "^5.56.10",
+    "svelte": "^5.57.1",
     "vite": "^8",
-    "@reticlehq/react": "3.2.0"
+    "@reticlehq/react": "3.4.0"
   },
   "peerDependencies": {
     "vite": ">=4"