@univerjs-pro/engine-formula-rust 1.0.0-insiders.20260725-1b9c8d8

package/README.md

@@ -0,0 +1,56 @@
+# @univerjs-pro/engine-formula-rust
+
+TypeScript plugin wrapper for the Rust-backed Univer formula engine.
+
+## Overview
+
+This package replaces the calculation layer (`ICalculateFormulaService`) of `@univerjs/engine-formula`
+with a Rust implementation via NAPI-RS on Node.js. All other services
+(FormulaDataModel, IFunctionService, controllers, etc.) remain in TypeScript.
+
+## Usage
+
+In a Node.js Worker process (e.g. `apps/univer-collaboration-server/src/contrib/apply/worker.ts`):
+
+```typescript
+import { UniverRustFormulaEnginePlugin } from '@univerjs-pro/engine-formula-rust';
+
+// Replace the default engine formula plugin
+univer.registerPlugin(UniverRustFormulaEnginePlugin);
+```
+
+## Architecture
+
+```
+TS side (Worker thread)
+  ├─ UniverRustFormulaEnginePlugin
+  ├─ RustCalculateFormulaService
+  │   ├─ collects data from IFormulaCurrentConfigService
+  │   ├─ JSON serialize → Rust NAPI
+  │   └─ deserialize result → IFormulaRuntimeService
+  └─ All other services remain untouched
+
+Rust side (NAPI / WASM)
+  ├─ FormulaEngine::execute(input)
+  ├─ Lexer → Parser → AST
+  ├─ Dependency Graph → Topological Sort
+  └─ Interpreter → ValueObjects
+```
+
+## Build
+
+```bash
+# Build the Rust native addon
+pnpm run build:native
+
+# Build the TypeScript package
+pnpm run build
+```
+
+## Fallback
+
+Set `useRustEngine: false` in the plugin config to fall back to the pure TypeScript engine:
+
+```typescript
+univer.registerPlugin(UniverRustFormulaEnginePlugin, { useRustEngine: false });
+```