@rsvelte/compiler 0.7.13 → 0.7.16

package/README.md

@@ -1,86 +1,80 @@
-# rsvelte_lint
+# @rsvelte/compiler
 
-A fast, native Svelte linter built directly on the [rsvelte](../../) compiler —
-no second ESTree parse, no Node.js in the hot path. See
-[`docs/svelte-lint-design.md`](../../docs/svelte-lint-design.md) for the full
-architecture & decision record.
+A high-performance Rust implementation of the [Svelte](https://svelte.dev) 5
+compiler, shipped as WebAssembly. Part of the
+[rsvelte](https://github.com/baseballyama/rsvelte) project — a port of the
+official Svelte compiler to Rust, aiming for byte-identical output and a large
+speedup over the JavaScript compiler.
 
-It combines two diagnostic sources:
+The whole compile pipeline — parse, analyze, transform — for client, SSR and
+hydration, with output that matches the official compiler across the in-scope
+test suite.
 
-1. **Validator wrap** — the rsvelte compiler already emits ~70 warning codes,
-   ~145 error codes, and 42 `a11y_*` rules during analysis. We surface those as
-   lint diagnostics with near-zero rule code (the "single biggest lever").
-2. **Native rule engine** — a single shared DFS over the template AST that
-   dispatches to `Rule` hooks, porting the proven `vize_patina` structure.
+> **⚠️ Early stage.** The API surface is stabilising. Output is verified
+> byte-for-byte against the official compiler across the in-scope Svelte test
+> suite, but treat this as experimental for production use.
 
-## Try it
+## Install
 
 ```bash
-cargo run -p rsvelte_lint -- crates/rsvelte_lint/demo/Demo.svelte
+npm install @rsvelte/compiler
+# pnpm add @rsvelte/compiler
+# yarn add @rsvelte/compiler
 ```
 
-See [`demo/README.md`](demo/README.md) for the expected output and the opt-in /
-autofix / SARIF variants.
+The package is a `wasm-pack` (`--target web`) module — the WebAssembly binary
+ships with the package, so it runs anywhere WebAssembly does (modern browsers,
+Node.js, Deno, Bun) with no native binaries and no `optionalDependencies`.
 
 ## Usage
 
-```bash
-cargo run -p rsvelte_lint -- src/                 # lint a directory
-cargo run -p rsvelte_lint -- --fix src/           # autofix in place
-cargo run -p rsvelte_lint -- --format sarif src/  # SARIF for CI code-scanning
-cargo run -p rsvelte_lint -- --list-rules         # list the native rules
-cargo run -p rsvelte_lint -- --print-eslint-config > eslint.rsvelte.json
-```
+```js
+import init, {
+  parse_svelte,
+  compile_client,
+  compile_server,
+  version,
+} from '@rsvelte/compiler';
+
+// Initialise the WebAssembly module once before calling any export.
+await init();
+
+const source = `<h1>Hello {name}</h1>`;
+
+// Compile for the client.
+const client = compile_client(source, 'App');
+console.log(client.js);  // generated JavaScript
+console.log(client.css); // scoped styles
 
-Key flags: `--config <file>` (auto-discovers `rsvelte-lint.json` upward when
-omitted), `--config-from-eslint <eslint.config.js>` (import `svelte/*`
-severities), `--off`/`--error <rule>`, `--max-warnings <n>`. Output formats:
-`human`, `human-verbose`, `machine`, `machine-verbose`, `github-actions`,
-`sarif`. Exit codes follow ESLint conventions (non-zero on any error or when
-`--max-warnings` is exceeded).
-
-## Config (`rsvelte-lint.json`)
-
-```json
-{
-  "extends": ["recommended"],
-  "rules": {
-    "svelte/no-at-html-tags": "error",
-    "svelte/button-has-type": ["warn", { "submit": true, "reset": false }],
-    "svelte/no-restricted-html-elements": ["error", { "elements": ["marquee"] }]
-  },
-  "files": ["src/**/*.svelte"],
-  "ignores": ["**/generated/**"]
-}
+// Compile for SSR.
+const server = compile_server(source, 'App');
+
+// Parse to the Svelte AST (JSON string, same shape the official parser produces).
+const ast = JSON.parse(parse_svelte(source).ast);
+
+console.log(version()); // the rsvelte compiler version
 ```
 
-A rule value is a severity scalar (`"off"`/`"warn"`/`"error"` or `0`/`1`/`2`) or
-a `[severity, ...options]` pair. `extends: ["none"]` starts from an empty
-baseline.
+## Why it is fast
 
-## Coexisting with ESLint
+- Written in Rust with a memory-efficient AST (`u32` spans, compact strings) and
+  direct phase-to-phase AST passing — no re-parsing between phases.
+- Thread-safe, parallel parsing via [rayon](https://github.com/rayon-rs/rayon).
+- Designed for integration into the [oxc](https://oxc.rs/) ecosystem.
 
-rsvelte-lint ships as a **complement** to ESLint, not (yet) a replacement. Run
-`--print-eslint-config` to generate a flat-config snippet that turns the
-native-owned `svelte/*` rules off in ESLint so each finding fires exactly once.
+## Related packages
 
-## Native rules
+- [`@rsvelte/svelte2tsx`](https://www.npmjs.com/package/@rsvelte/svelte2tsx) — `.svelte` → TSX for type-checking.
+- [`@rsvelte/svelte-check`](https://www.npmjs.com/package/@rsvelte/svelte-check) — a drop-in `svelte-check`.
+- [`@rsvelte/vite-plugin-svelte`](https://www.npmjs.com/package/@rsvelte/vite-plugin-svelte) — the Vite plugin, backed by the Rust compiler.
 
-Default-on (recommended): `no-at-html-tags`, `no-at-debug-tags` (autofix),
-`require-each-key`, `no-dupe-else-if-blocks`, `no-dupe-style-properties`,
-`no-object-in-text-mustaches`. Opt-in (off by default, matching
-eslint-plugin-svelte's `recommended: false`): `button-has-type`,
-`no-restricted-html-elements`. Each is a 1:1 port of the corresponding
-eslint-plugin-svelte rule and validated against that plugin's own fixtures by the
-compat oracle (`tests/eslint_plugin_oracle.rs`). Run `--list-rules` to see
-defaults.
+## License
 
-## Testing
+MIT
 
-```bash
-cargo test -p rsvelte_lint
-cargo clippy -p rsvelte_lint --all-targets --all-features -- -D warnings
-```
+---
 
-The compat oracle reads fixtures from the `eslint-plugin-svelte` reference
-submodule and skips automatically when it isn't checked out.
+> **Maintainers:** `@rsvelte/compiler` is published from the wasm-pack output in
+> the repo-root `pkg/` directory, not from this directory. See
+> [`PUBLISHING.md`](./PUBLISHING.md) for how the version anchor and README
+> overlay work.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@rsvelte/compiler",
   "type": "module",
   "description": "Fast native Svelte linter built on the rsvelte compiler (validator wrap + native rule engine)",
-  "version": "0.7.13",
+  "version": "0.7.16",
   "license": "MIT",
   "files": [
     "rsvelte_lint_bg.wasm",