@celsian/vura-compiler 0.2.0 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vura contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,15 +1,40 @@
 # @celsian/vura-compiler
 
-Compiler for Vura — transforms routes, pages, and API endpoints into optimized build output.
+Pure-JS compiler for [Vura](https://vura.io) — regex-based route scanning and JSX transforms.
+
+[![npm version](https://img.shields.io/npm/v/@celsian/vura-compiler)](https://www.npmjs.com/package/@celsian/vura-compiler)
+
+## What it does
+
+`@celsian/vura-compiler` scans route and page source files to extract HTTP methods, route config (`kind`, `schedule`, etc.), and page modes without a full AST parse. It also handles the JSX transform step. This package is the pure-JS path used internally by `@celsian/vura-cli` and `@celsian/vura-vite-plugin` — you do not need to install it directly unless building custom tooling. For projects that need faster scanning, `@celsian/vura-compiler-native` (unpublished prototype) exposes the same API surface using AST-based analysis.
 
 ## Install
 
-```bash
+```sh
 npm install @celsian/vura-compiler
 ```
 
-This package is typically used internally by `@celsian/vura-cli` and `@celsian/vura-vite-plugin`. You don't need to install it directly unless building custom tooling.
+## Minimal example
+
+```ts
+import { scanRoute } from '@celsian/vura-compiler';
+
+const source = `
+  export const route = { kind: 'hot' };
+  export function websocket(peer, req) {}
+`;
+
+const result = scanRoute(source, 'ts');
+// result.kind === 'hot'
+// result.methods === []  (websocket handler, not HTTP methods)
+```
+
+## Documentation
+
+_vura.io docs site launches with v0.5 — until then, see the repo README and CHANGELOG._
+
+- [Compiler internals — /reference/compiler/](https://vura.io/reference/compiler/)
 
 ## License
 
-MIT
+MIT — and [it will stay MIT](https://github.com/CelsianJs/vura/blob/main/GOVERNANCE.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celsian/vura-compiler",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Pure JS compiler fallback for Vura — route scanning and JSX transforms",
   "type": "module",
   "main": "dist/index.js",
@@ -15,11 +15,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "test": "vitest run",
-    "build": "tsc -b",
-    "prepack": "pnpm run build"
-  },
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,5 +36,9 @@
   ],
   "engines": {
     "node": ">=20 <23"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "build": "tsc -b"
   }
-}
+}