@fervid/napi 0.3.0 → 0.4.0

package/index.d.ts

@@ -55,8 +55,18 @@ export interface FervidCompileOptions {
   id: string
   /** Filename is used for automatic component name inference and self-referential imports */
   filename: string
+  /**
+   * Is the currently compiled file a custom element.
+   * To give more flexibility, this option only accepts a boolean, allowing to compute the value on the JS side,
+   * instead of relying on a hacky RegEx/JS function calls from the Fervid side.
+   */
+  isCustomElement?: boolean
   /** Generate a const instead of default export */
   genDefaultAs?: string
+  /** Enable, disable or error on props destructure */
+  propsDestructure?: boolean | 'error'
+  /** Whether setup bindings need to be serialized */
+  outputSetupBindings?: boolean
 }
 export interface CompileResult {
   code: string
@@ -64,6 +74,7 @@ export interface CompileResult {
   errors: Array<SerializedError>
   customBlocks: Array<CustomBlock>
   sourceMap?: string
+  setupBindings?: Record<string, BindingTypes> | undefined
 }
 export interface Style {
   code: string
@@ -82,6 +93,53 @@ export interface SerializedError {
   hi: number
   message: string
 }
+/**
+ * This is a copied enum from `fervid_core` with `napi` implementation to avoid littering the core crate.
+ *
+ * The type of a binding (or identifier) which is used to show where this binding came from,
+ * e.g. `Data` is for Options API `data()`, `SetupRef` if for `ref`s and `computed`s in Composition API.
+ *
+ * <https://github.com/vuejs/core/blob/020851e57d9a9f727c6ea07e9c1575430af02b73/packages/compiler-core/src/options.ts#L76>
+ */
+export const enum BindingTypes {
+  /** returned from data() */
+  DATA = 0,
+  /** declared as a prop */
+  PROPS = 1,
+  /**
+   * a local alias of a `<script setup>` destructured prop.
+   * the original is stored in __propsAliases of the bindingMetadata object.
+   */
+  PROPS_ALIASED = 2,
+  /** a let binding (may or may not be a ref) */
+  SETUP_LET = 3,
+  /**
+   * a const binding that can never be a ref.
+   * these bindings don't need `unref()` calls when processed in inlined
+   * template expressions.
+   */
+  SETUP_CONST = 4,
+  /** a const binding that does not need `unref()`, but may be mutated. */
+  SETUP_REACTIVE_CONST = 5,
+  /** a const binding that may be a ref */
+  SETUP_MAYBE_REF = 6,
+  /** bindings that are guaranteed to be refs */
+  SETUP_REF = 7,
+  /** declared by other options, e.g. computed, inject */
+  OPTIONS = 8,
+  /** a literal constant, e.g. 'foo', 1, true */
+  LITERAL_CONST = 9,
+  /** a `.vue` import or `defineComponent` call */
+  COMPONENT = 10,
+  /** an import which is not a `.vue` or `from 'vue'` */
+  IMPORTED = 11,
+  /** a variable from the template */
+  TEMPLATE_LOCAL = 12,
+  /** a variable in the global Javascript context, e.g. `Array` or `undefined` */
+  JS_GLOBAL = 13,
+  /** a non-resolved variable, presumably from the global Vue context */
+  UNRESOLVED = 14,
+}
 export type FervidJsCompiler = Compiler
 /** Fervid: a compiler for Vue.js written in Rust */
 export declare class Compiler {

package/index.js

@@ -284,6 +284,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { Compiler } = nativeBinding
+const { Compiler, BindingTypes } = nativeBinding
 
 module.exports.Compiler = Compiler
+module.exports.BindingTypes = BindingTypes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fervid/napi",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "All-in-One Vue compiler written in Rust",
   "main": "index.js",
   "repository": "git@github.com:phoenix-ru/fervid.git",
@@ -45,6 +45,7 @@
   },
   "scripts": {
     "artifacts": "napi artifacts",
+    "dev": "chmod +x watch.sh && cargo watch -w '../../crates' -i '*.js' -i '*.d.ts' -s './watch.sh'",
     "bench": "node -r @swc-node/register benchmark/bench.ts",
     "build": "napi build --platform --release --pipe \"prettier -w\"",
     "build:debug": "napi build --platform --pipe \"prettier -w\"",
@@ -59,28 +60,27 @@
     "version": "napi version"
   },
   "devDependencies": {
-    "@babel/parser": "^7.25.4",
+    "@babel/parser": "^7.27.1",
     "@napi-rs/cli": "^2.18.4",
-    "@swc-node/register": "^1.10.9",
-    "@swc/core": "^1.7.18",
+    "@swc-node/register": "^1.10.10",
+    "@swc/core": "^1.11.24",
     "@taplo/cli": "^0.7.0",
-    "@types/node": "^20.12.7",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
-    "@vue/compiler-sfc": "^3.4.38",
+    "@types/node": "^20.17.32",
+    "@typescript-eslint/eslint-plugin": "^8.31.1",
+    "@typescript-eslint/parser": "^8.31.1",
+    "@vue/compiler-sfc": "^3.5.13",
     "benny": "^3.7.1",
-    "chalk": "^5.3.0",
-    "eslint": "^9.9.1",
+    "chalk": "^5.4.1",
+    "eslint": "^9.25.1",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.2.1",
-    "husky": "^8.0.3",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.6",
+    "husky": "^9.1.7",
     "kleur": "^4.1.5",
-    "lint-staged": "^15.2.7",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.2.5",
+    "lint-staged": "^15.5.1",
+    "prettier": "^3.5.3",
     "typescript": "^5.5.4",
-    "vitest": "^2.0.5"
+    "vitest": "^3.1.2"
   },
   "lint-staged": {
     "*.@(js|ts|tsx)": [
@@ -101,19 +101,19 @@
     "arrowParens": "always"
   },
   "optionalDependencies": {
-    "@fervid/napi-win32-x64-msvc": "0.3.0",
-    "@fervid/napi-darwin-x64": "0.3.0",
-    "@fervid/napi-linux-x64-gnu": "0.3.0",
-    "@fervid/napi-linux-x64-musl": "0.3.0",
-    "@fervid/napi-linux-arm64-gnu": "0.3.0",
-    "@fervid/napi-win32-ia32-msvc": "0.3.0",
-    "@fervid/napi-linux-arm-gnueabihf": "0.3.0",
-    "@fervid/napi-darwin-arm64": "0.3.0",
-    "@fervid/napi-android-arm64": "0.3.0",
-    "@fervid/napi-freebsd-x64": "0.3.0",
-    "@fervid/napi-linux-arm64-musl": "0.3.0",
-    "@fervid/napi-win32-arm64-msvc": "0.3.0",
-    "@fervid/napi-android-arm-eabi": "0.3.0"
+    "@fervid/napi-win32-x64-msvc": "0.4.0",
+    "@fervid/napi-darwin-x64": "0.4.0",
+    "@fervid/napi-linux-x64-gnu": "0.4.0",
+    "@fervid/napi-linux-x64-musl": "0.4.0",
+    "@fervid/napi-linux-arm64-gnu": "0.4.0",
+    "@fervid/napi-win32-ia32-msvc": "0.4.0",
+    "@fervid/napi-linux-arm-gnueabihf": "0.4.0",
+    "@fervid/napi-darwin-arm64": "0.4.0",
+    "@fervid/napi-android-arm64": "0.4.0",
+    "@fervid/napi-freebsd-x64": "0.4.0",
+    "@fervid/napi-linux-arm64-musl": "0.4.0",
+    "@fervid/napi-win32-arm64-msvc": "0.4.0",
+    "@fervid/napi-android-arm-eabi": "0.4.0"
   },
   "packageManager": "yarn@4.4.1",
   "workspaces": [