@effectweb/compiler 0.1.1 → 0.2.1

package/README.md

@@ -4,15 +4,19 @@ Native Rust/Oxc compiler for EffectWeb snapshot JSX.
 
 ```ts
 import { defineConfig } from 'vite';
-import { snapshotCompiler } from '@effectweb/compiler/vite';
+import { effectweb } from '@effectweb/compiler/vite';
 
-export default defineConfig({ plugins: [snapshotCompiler()] });
+export default defineConfig({ plugins: [effectweb()] });
 ```
 
 Install `effectweb` and its required Effect version in the application. Set TypeScript `jsx` to `preserve` and `jsxImportSource` to `effectweb`.
 
-For direct compilation, import `compileSnapshot` from `@effectweb/compiler`; the result contains generated code, a source map, and diagnostics. The Vite plugin reports diagnostics and enables development instrumentation during serve.
+For direct compilation, import `compile` from `@effectweb/compiler`; the result contains generated code, a source map, and diagnostics. The Vite plugin reports diagnostics and enables development instrumentation during serve.
 
 Requires Node.js 22.14+. Optional packages provide binaries for glibc Linux x64/arm64, macOS x64/arm64, and Windows x64. Keep optional dependencies enabled. Installation does not compile Rust. Framework contributors build from source using Rust 1.96+.
 
 See [EffectWeb](https://github.com/DerpyCrabs/EffectWeb) for authoring and development instructions.
+
+For editor and CI diagnostics, add `@effectweb/compiler/oxlint` to Oxlint's `jsPlugins` and enable `effectweb/valid-view` as an error. The optional `effectweb/whole-model-dependency` rule reports coarse dependencies. Both use the compiler's Rust analysis; no second purity implementation is maintained. `diagnose` exposes the same structured view diagnostics for other tooling. Invalid syntax still throws and is handled by the host parser.
+
+The Vite plugin enables plain-data snapshot freezing during development and disables it for production builds. This catches accidental mutation without changing object identity or introducing proxies. See the authoring guide for the readonly type contract, opaque values, and explicit test configuration.

package/dist/compile.d.ts

@@ -0,0 +1,23 @@
+export interface Diagnostic {
+    readonly file: string;
+    readonly line: number;
+    readonly column: number;
+    readonly message: string;
+    readonly severity: 'error' | 'warning';
+}
+export interface CompilerOptions {
+    /** The module exporting view and slot. Defaults to effectweb. */
+    importSource?: string;
+    runtimeModule?: string;
+    development?: boolean;
+    onDiagnostic?: (diagnostic: Diagnostic) => void;
+}
+export interface CompilerResult {
+    readonly code: string;
+    readonly map: string | null;
+    readonly diagnostics: readonly Diagnostic[];
+}
+/** JSX analysis and lowering run in Rust/Oxc; this boundary only transports options and results. */
+export declare function compile(source: string, filename: string, options?: CompilerOptions): CompilerResult;
+/** Run the same view analysis as compilation, collecting one error per invalid view. */
+export declare function diagnose(source: string, filename: string, options?: Omit<CompilerOptions, 'onDiagnostic'>): readonly Diagnostic[];

package/dist/compile.js

@@ -0,0 +1,18 @@
+import { compile as nativeCompile } from '../native.cjs';
+/** JSX analysis and lowering run in Rust/Oxc; this boundary only transports options and results. */
+export function compile(source, filename, options = {}) {
+    const { onDiagnostic, ...nativeOptions } = { importSource: 'effectweb', ...options };
+    const result = JSON.parse(nativeCompile(source, filename, JSON.stringify(nativeOptions)));
+    for (const diagnostic of result.diagnostics)
+        onDiagnostic?.(diagnostic);
+    return result;
+}
+/** Run the same view analysis as compilation, collecting one error per invalid view. */
+export function diagnose(source, filename, options = {}) {
+    return JSON.parse(nativeCompile(source, filename, JSON.stringify({
+        importSource: 'effectweb',
+        ...options,
+        development: true,
+        diagnosticsOnly: true,
+    }))).diagnostics;
+}

package/dist/index.d.ts

@@ -1 +1 @@
-export { compileSnapshot, type SnapshotCompilerOptions, type SnapshotCompilerResult, type SnapshotDiagnostic, } from './snapshotJsx.js';
+export { compile, diagnose, type CompilerOptions, type CompilerResult, type Diagnostic, } from './compile.js';

package/dist/index.js

@@ -1 +1 @@
-export { compileSnapshot, } from './snapshotJsx.js';
+export { compile, diagnose, } from './compile.js';

package/dist/oxlint.d.ts

@@ -0,0 +1,59 @@
+type Source = {
+    text: string;
+};
+type Context = {
+    filename: string;
+    sourceCode: Source;
+    options: readonly {
+        importSource?: string;
+    }[];
+    report: (diagnostic: {
+        loc: {
+            line: number;
+            column: number;
+        };
+        message: string;
+    }) => void;
+};
+declare const _default: {
+    meta: {
+        name: string;
+    };
+    rules: {
+        'valid-view': {
+            meta: {
+                type: "problem" | "suggestion";
+                schema: {
+                    type: string;
+                    properties: {
+                        importSource: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                }[];
+            };
+            create(context: Context): {
+                Program(): void;
+            };
+        };
+        'whole-model-dependency': {
+            meta: {
+                type: "problem" | "suggestion";
+                schema: {
+                    type: string;
+                    properties: {
+                        importSource: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                }[];
+            };
+            create(context: Context): {
+                Program(): void;
+            };
+        };
+    };
+};
+export default _default;

package/dist/oxlint.js

@@ -0,0 +1,62 @@
+import { diagnose } from './compile.js';
+const results = new WeakMap();
+function rule(severity) {
+    return {
+        meta: {
+            type: severity === 'error' ? 'problem' : 'suggestion',
+            schema: [
+                {
+                    type: 'object',
+                    properties: { importSource: { type: 'string' } },
+                    additionalProperties: false,
+                },
+            ],
+        },
+        create(context) {
+            return {
+                Program() {
+                    if (!context.filename.endsWith('.tsx'))
+                        return;
+                    const importSource = context.options[0]?.importSource ?? 'effectweb';
+                    let cached = results.get(context.sourceCode);
+                    if (!cached || cached.text !== context.sourceCode.text) {
+                        cached = { text: context.sourceCode.text, diagnostics: new Map() };
+                        results.set(context.sourceCode, cached);
+                    }
+                    const key = `${context.filename}\0${importSource}`;
+                    let diagnostics = cached.diagnostics.get(key);
+                    if (!diagnostics) {
+                        try {
+                            diagnostics = diagnose(context.sourceCode.text, context.filename, { importSource });
+                        }
+                        catch (error) {
+                            // Parser failures and unavailable native binaries must not silently pass lint.
+                            diagnostics = [
+                                {
+                                    file: context.filename,
+                                    line: 1,
+                                    column: 1,
+                                    severity: 'error',
+                                    message: error instanceof Error ? error.message : String(error),
+                                },
+                            ];
+                        }
+                        cached.diagnostics.set(key, diagnostics);
+                    }
+                    for (const diagnostic of diagnostics) {
+                        if (diagnostic.severity !== severity)
+                            continue;
+                        context.report({
+                            loc: { line: diagnostic.line, column: diagnostic.column - 1 },
+                            message: diagnostic.message,
+                        });
+                    }
+                },
+            };
+        },
+    };
+}
+export default {
+    meta: { name: 'effectweb' },
+    rules: { 'valid-view': rule('error'), 'whole-model-dependency': rule('warning') },
+};

package/dist/vite.d.ts

@@ -1,4 +1,5 @@
 import type { Plugin } from 'vite';
-import { type SnapshotCompilerOptions } from './snapshotJsx.js';
+import { type CompilerOptions } from './compile.js';
 /** Rust/Oxc lowers snapshot JSX before Vite's TypeScript pass. */
-export declare function snapshotCompiler(options?: SnapshotCompilerOptions): Plugin;
+export declare function effectweb(options?: CompilerOptions): Plugin;
+export default effectweb;

package/dist/vite.js

@@ -1,10 +1,13 @@
-import { compileSnapshot } from './snapshotJsx.js';
+import { compile } from './compile.js';
 /** Rust/Oxc lowers snapshot JSX before Vite's TypeScript pass. */
-export function snapshotCompiler(options = {}) {
+export function effectweb(options = {}) {
     let development = false;
     return {
-        config() {
-            return { resolve: { dedupe: ['effect'] } };
+        config(_config, environment) {
+            return {
+                define: { __EFFECTWEB_DEV__: JSON.stringify(environment.command === 'serve') },
+                resolve: { dedupe: ['effect'] },
+            };
         },
         configResolved(config) {
             development = config.command === 'serve';
@@ -15,7 +18,7 @@ export function snapshotCompiler(options = {}) {
             const filename = id.split('?')[0];
             if (!filename?.endsWith('.tsx'))
                 return;
-            const result = compileSnapshot(code, filename, {
+            const result = compile(code, filename, {
                 ...options,
                 development,
                 onDiagnostic: options.onDiagnostic ??
@@ -25,3 +28,4 @@ export function snapshotCompiler(options = {}) {
         },
     };
 }
+export default effectweb;

package/native.cjs

@@ -1,7 +1,7 @@
 const { existsSync } = require('node:fs');
 const { join } = require('node:path');
 const { name } = require('./package.json');
-const local = join(__dirname, 'native', 'snapshot-compiler.node');
+const local = join(__dirname, 'native', 'effectweb-compiler.node');
 let suffix;
 if (existsSync(local)) suffix = 'local';
 else if (process.platform === 'linux') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectweb/compiler",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Native Oxc compiler and Vite plugin for effectweb",
   "homepage": "https://github.com/DerpyCrabs/EffectWeb",
   "bugs": {
@@ -28,6 +28,10 @@
     "./vite": {
       "types": "./dist/vite.d.ts",
       "import": "./dist/vite.js"
+    },
+    "./oxlint": {
+      "types": "./dist/oxlint.d.ts",
+      "import": "./dist/oxlint.js"
     }
   },
   "publishConfig": {
@@ -42,11 +46,11 @@
     }
   },
   "optionalDependencies": {
-    "@effectweb/compiler-darwin-arm64": "0.1.1",
-    "@effectweb/compiler-darwin-x64": "0.1.1",
-    "@effectweb/compiler-linux-arm64-gnu": "0.1.1",
-    "@effectweb/compiler-linux-x64-gnu": "0.1.1",
-    "@effectweb/compiler-win32-x64-msvc": "0.1.1"
+    "@effectweb/compiler-darwin-arm64": "0.2.1",
+    "@effectweb/compiler-darwin-x64": "0.2.1",
+    "@effectweb/compiler-linux-arm64-gnu": "0.2.1",
+    "@effectweb/compiler-linux-x64-gnu": "0.2.1",
+    "@effectweb/compiler-win32-x64-msvc": "0.2.1"
   },
   "engines": {
     "node": ">=22.14"

package/dist/snapshotJsx.d.ts

@@ -1,20 +0,0 @@
-export interface SnapshotDiagnostic {
-    readonly file: string;
-    readonly line: number;
-    readonly column: number;
-    readonly message: string;
-}
-export interface SnapshotCompilerOptions {
-    /** An additional public module exporting view; relative imports ending in /mvu also work. */
-    importSource?: string;
-    runtimeModule?: string;
-    development?: boolean;
-    onDiagnostic?: (diagnostic: SnapshotDiagnostic) => void;
-}
-export interface SnapshotCompilerResult {
-    readonly code: string;
-    readonly map: string | null;
-    readonly diagnostics: readonly SnapshotDiagnostic[];
-}
-/** JSX analysis and lowering run in Rust/Oxc; this boundary only transports options and results. */
-export declare function compileSnapshot(source: string, filename: string, options?: SnapshotCompilerOptions): SnapshotCompilerResult;

package/dist/snapshotJsx.js

@@ -1,9 +0,0 @@
-import { compile } from '../native.cjs';
-/** JSX analysis and lowering run in Rust/Oxc; this boundary only transports options and results. */
-export function compileSnapshot(source, filename, options = {}) {
-    const { onDiagnostic, ...nativeOptions } = { importSource: 'effectweb', ...options };
-    const result = JSON.parse(compile(source, filename, JSON.stringify(nativeOptions)));
-    for (const diagnostic of result.diagnostics)
-        onDiagnostic?.(diagnostic);
-    return result;
-}