Skip to content

Commit dcd21cb

Browse files
committed
重构 README:优化项目定位与核心亮点描述
## 变更内容 ### 项目标语重构 - 根 README(中/英/日)和 compiler-core README(中/英)统一更新项目描述 - 从原有较长的描述改为更简洁有力的「Vue 转 React 编译工具」定位 - 强调「完整编译为纯 React 18+ 代码(非运行时桥接)」的核心能力 ### 核心理念区域重构 - 移除原有的「核心理念 / Core Philosophy / コア哲学」大段描述 - 替换为一句精炼的引用式概述 - 「核心特性 / Core Features」从描述性段落重构为要点列表,更清晰易读 - 保留原有功能要点但重新组织语言:语义级编译、约定优先、渐进迁移、完整特性适配、智能依赖分析、双模式 CLI ### 其他 - 更新 compiler-core 子包的 README 描述以保持一致
1 parent cc5ac81 commit dcd21cb

5 files changed

Lines changed: 28 additions & 55 deletions

File tree

README.en.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Write in Vue 3, compile to React 18+ code.**
88

9-
It is not only suitable for migrating Vue 3 projects to React, but is also committed to seamlessly integrating Vue's excellent mental model with React's ecosystem capabilities, directly producing **maintainable, evolvable, and production-ready** React code from Vue code.
9+
A **Vue-to-React** compiler that **fully compiles** Vue 3 SFC, scripts & styles into **pure React 18+ code** (no runtime bridge), covering core `<script setup>` features.
1010

1111
[![Npm](https://img.shields.io/npm/v/@vureact/compiler-core.svg?label=Npm&style=flat-square)](https://vureact.top/en/)
1212
[![Downloads](https://img.shields.io/npm/dt/@vureact/compiler-core?label=Downloads&style=flat-square&color=red)](https://www.npmjs.com/package/@vureact/compiler-core)
@@ -24,25 +24,16 @@ English | [简体中文](./README.md) | [日本語](./README.ja.md)
2424

2525
---
2626

27-
## 🎯 Core Philosophy
28-
29-
VuReact is not just a simple syntax conversion tool, but a **convention-based intelligent compilation platform**. We adhere to the principle of "controllability over full coverage," providing a **predictable, analyzable, and maintainable** engineering path for Vue to React migration through explicit compilation conventions.
30-
31-
Furthermore, VuReact is not only suitable for migration scenarios but also for development scenarios where developers wish to enjoy **Vue's excellent mental model** while producing **React code**.
27+
*"VuReact seamlessly integrates Vue's mental model with React's ecosystem, directly converting Vue code into **maintainable, evolvable, and production-ready** React code."*
3228

3329
## ✨ Core Features
3430

35-
**🧠 Semantic-aware**:Understand Vue 3 like a compiler, generate maintainable React 18+ like a pro
36-
37-
**⚖️ Incremental Migration**:Start small, scale to full projects—no risky rewrites
38-
39-
**🧭 Convention-driven**:Predictable transforms powered by clear conventions, not guesses
40-
41-
**⚛️ Complete Feature Adaptation**:Vue features, fully mapped to React—zero runtime cost
42-
43-
**⚡ Excellent Developer Experience**:Vue mental model, seamless React dev; CLI build/watch, fast incremental compile, native-like
44-
45-
**🌀 Innovative Exploration**:A new bridge between Vue and React at compile time
31+
- **🧠 Semantic-level compilation, not text replacement**: Analyzes complete semantics of templates, `<script setup>`, Composition API, TS types, etc., generating idiomatic React code.
32+
- **🎯 Convention-first, controllable & maintainable**: Doesn't aim to "convert everything"; follows clear compilation conventions, ensuring predictable and analyzable output.
33+
- **📦 Progressive migration**: Migrates incrementally from single files to entire projects without the need for a full rewrite.
34+
- **⚛️ Full feature adaptation**: Core Vue features (reactivity, lifecycle, built-in components, routing) are fully adapted to React; `scoped`/`module` styles and Less/Sass are processed at compile time with zero runtime overhead.
35+
- **⚡ Intelligent dependency analysis**: Top-level functions automatically get `useCallback`, variable declarations get `useMemo`, and hook dependencies are tracked automatically.
36+
- **🛠️ Dual-mode CLI**: `vureact build` (fast incremental compilation) + `vureact watch` (file watching), offering near-native development experience.
4637

4738
## 🪄 Playground
4839

README.ja.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Vue を書き、保守可能な React を生成する**
88

9-
これは Vue 3 プロジェクトから React への移行に適しているだけでなく、Vue の優れたメンタルモデルと React エコシステムの能力をシームレスに統合し、Vue コードから直接**保守可能・進化可能・プロダクション対応** React コードを生成することに注力しています
9+
**Vue から React への完全コンパイルツール**Vue 3 の SFC・Script・Style を**純粋な React 18+ コンポーネントとコードに完全コンパイル**(ランタイムブリッジ不要)、`<script setup>` のコア全機能に対応
1010

1111
[![Npm](https://img.shields.io/npm/v/@vureact/compiler-core.svg?label=Npm&style=flat-square)](https://vureact.top/)
1212
[![Downloads](https://img.shields.io/npm/dt/@vureact/compiler-core?label=Downloads&style=flat-square&color=red)](https://www.npmjs.com/package/@vureact/compiler-core)
@@ -24,25 +24,16 @@
2424

2525
---
2626

27-
## 🎯 コア哲学
27+
*「 VuReact は構文変換を超え、Vue のメンタルモデルと React のエコシステムを融合し、Vue コードから**保守可能・進化可能・プロダクション対応**の React コードを生成します 」*
2828

29-
VuReact は単なるシンタックス変換ツールではなく、**コンベンションベースのインテリジェントコンパイルプラットフォーム**です。「完全網羅よりも制御可能性」の原則に従い、明確なコンパイル規約を通じて、Vue から React への移行に**予測可能・分析可能・保守可能**なエンジニアリングパスを提供します。
29+
## ✨ 核心機能
3030

31-
さらに VuReact は移行シナリオだけでなく、**Vue の優れたメンタルモデルを享受**しながら**React コードを出力**したい開発シーンにも適しています。
32-
33-
## ✨ コア機能
34-
35-
**🧠 セマンティック認識**:Vue のテンプレートディレクティブ、script setup ロジック、Composition API、TypeScript 型など、構文の完全な意味構造を深く理解し、React のベストプラクティスに沿ったコードをインテリジェントに生成
36-
37-
**⚖️ 段階的移行**:単一ファイルからプロジェクト全体まで制御可能な段階的移行をサポート。大規模な一括変換に伴う技術負債とシステムリスクを回避
38-
39-
**🧭 コンベンション駆動**:ヒューリスティックルールではなく明確な構文規約に基づいてコンパイル。変換動作の決定性・分析可能性・保守性を保証し、モダンな Vue 構文を完全サポート
40-
41-
**⚛️ 完全機能適合**:リアクティブAPI、ライフサイクル、ビルトインコンポーネント、ルーティングなど Vue のコア機能を React に完全適合。scoped/module やスタイル言語の処理はコンパイル段階で完結し、ランタイムオーバーヘッドゼロを実現
42-
43-
**⚡ 優れた開発体験**:Vue のメンタルモデルを継承し、意識せずに React 開発を実現。build/watch デュアルモード CLI は超高速インクリメンタルコンパイルとファイル監視をサポートし、クロスフレームワーク開発の効率と体験をネイティブレベルに
44-
45-
**🌀 革新的探究**:クロスフレームワークコンパイルブリッジパターンを探究。Vue と React のコードをコンパイルレベルで共存させ、「Vue から React への完全コンパイル」の技術的実現可能性を実証
31+
- **🧠 セマンティックレベルでのコンパイル、単なる文字列置換ではありません**:テンプレート、`<script setup>`、Composition API、TS 型などの完全なセマンティクスを分析し、React の慣習に沿ったコードを生成します。
32+
- **🎯 規約優先、制御可能で保守性が高い**:「何でも変換できる」ことを追求せず、明確なコンパイル規約に基づき、変換結果が予測可能かつ分析可能であることを保証します。
33+
- **📦 段階的移行**:単一ファイルからプロジェクト全体まで徐々に進めることができ、一度に全てを書き換える必要はありません。
34+
- **⚛️ 完全な機能アダプテーション**:リアクティブ API、ライフサイクル、組み込みコンポーネント、ルーティングなどの Vue コア機能を React に完全適応。`scoped`/`module` スタイルと Less/Sass はコンパイル段階で処理され、ランタイムオーバーヘッドはゼロです。
35+
- **⚡ スマートな依存関係分析**:トップレベル関数には自動で `useCallback` を注入、変数宣言には自動で `useMemo` を注入、hooks の依存関係を自動追跡します。
36+
- **🛠️ デュアルモード CLI**`vureact build`(超高速インクリメンタルコンパイル)+ `vureact watch`(ファイル監視)により、ネイティブに近い開発体験を提供します。
4637

4738
## 🪄 オンラインデモ
4839

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**写 Vue,生成可维护的 React**
88

9-
它不仅适用于 Vue 3 到 React 项目的迁移,更致力于将 Vue 优秀的心智模型与 React 生态能力无缝融合,用 Vue 代码直接产出**可维护、可演进、生产就绪** React 代码
9+
一个 **Vue React** 编译工具,将 Vue 3 的 SFC、脚本和样式文件**完整编译为纯 React 18+ 组件与代码**(非运行时桥接),覆盖 `<script setup>` 核心全特性
1010

1111
[![Npm](https://img.shields.io/npm/v/@vureact/compiler-core.svg?label=Npm&style=flat-square)](https://vureact.top/)
1212
[![Downloads](https://img.shields.io/npm/dt/@vureact/compiler-core?label=Downloads&style=flat-square&color=red)](https://www.npmjs.com/package/@vureact/compiler-core)
@@ -24,25 +24,16 @@
2424

2525
---
2626

27-
## 🎯 核心理念
27+
*“ VuReact 不是简单的语法转换工具,而是致力于将 Vue 优秀的心智模型与 React 生态能力无缝融合,用 Vue 代码直接产出**可维护、可演进、生产就绪**的 React 代码。”*
2828

29-
VuReact 不是简单的语法转换工具,而是一个**基于约定的智能编译平台**。我们遵循"可控性优先于全覆盖"的原则,通过明确的编译约定,为 Vue 到 React 的迁移提供**可预测、可分析、可维护**的工程路径。
29+
## ✨ 核心亮点
3030

31-
另外,VuReact **不仅适用于迁移场景**,也适用于那些希望**享受 Vue 优秀的心智模型**,同时**产出 React 代码**的开发场景。
32-
33-
## ✨ 核心特性
34-
35-
**🧠 语义感知**:深度理解Vue语法的完整语义结构,包括模板指令、script setup逻辑、组合式API和TypeScript类型等,智能生成符合React最佳实践的代码
36-
37-
**⚖️ 渐进迁移**:支持从单文件到整个项目的可控渐进迁移,规避一次性大规模转换带来的技术债务和系统风险
38-
39-
**🧭 约定驱动**:基于明确的语法约定而非启发式规则进行编译,确保转换行为的确定性、可分析性和可维护性,完整支持现代Vue语法
40-
41-
**⚛️ 完整特性适配**:将响应式 API、生命周期、内置组件、路由等Vue核心特性完整适配到React,编译阶段完全处理scoped、module和样式语言等,实现零运行时开销
42-
43-
**⚡ 优秀的开发体验**:延续 Vue 心智模型实现无感开发 React;提供 build/watch 双模式 CLI,支持极速增量编译与文件监听,让跨框架开发效率与体验达到原生级别
44-
45-
**🌀 创新探索**:探索跨框架编译桥模式,允许Vue和React代码在编译层面共存,验证"Vue到React完整编译"的技术可行性
31+
- **🧠 语义级编译,不是字符替换**:分析模板、`<script setup>`、组合式 API、TS 类型等完整语义,生成符合 React 习惯的代码。
32+
- **🎯 约定优先,可控可维护**:不追求“什么都能转”,基于明确的编译约定,确保转换结果可预测、可分析。
33+
- **📦 渐进迁移**:从单文件到整个项目逐步推进,不需要一次性重写。
34+
- **⚛️ 完整特性适配**:响应式 API、生命周期、内置组件、路由等 Vue 核心特性完整适配到 React;`scoped`/`module` 样式和 Less/Sass 均在编译阶段处理,零运行时开销。
35+
- **⚡ 智能依赖分析**:顶层函数自动注入 `useCallback`,变量声明自动注入 `useMemo`,hooks 依赖自动追踪。
36+
- **🛠️ 双模式 CLI**`vureact build`(极速增量编译)+ `vureact watch`(文件监听),开发体验接近原生。
4637

4738
## 🪄 在线案例演示
4839

packages/compiler-core/README.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Write in Vue 3, compile to React 18+ code.**
44

5-
It is not only suitable for migrating Vue 3 projects to React, but is also committed to seamlessly integrating Vue's excellent mental model with React's ecosystem capabilities, directly producing **maintainable, evolvable, and production-ready** React code from Vue code.
5+
A **Vue-to-React** compiler that **fully compiles** Vue 3 SFC, scripts & styles into **pure React 18+ code** (no runtime bridge), covering core `<script setup>` features.
66

77
[![Npm](https://img.shields.io/npm/v/@vureact/compiler-core.svg?label=Npm&style=flat-square)](https://vureact.top/en/)
88
[![Downloads](https://img.shields.io/npm/dt/@vureact/compiler-core?label=Downloads&style=flat-square)](https://www.npmjs.com/package/@vureact/compiler-core)

packages/compiler-core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**写 Vue,生成可维护的 React**
44

5-
它不仅适用于 Vue 3 到 React 项目的迁移,更致力于将 Vue 优秀的心智模型与 React 生态能力无缝融合,用 Vue 代码直接产出**可维护、可演进、生产就绪** React 代码
5+
一个 **Vue React** 编译工具,将 Vue 3 的 SFC、脚本和样式文件**完整编译为纯 React 18+ 组件与代码**(非运行时桥接),覆盖 `<script setup>` 核心全特性
66

77
[![Npm](https://img.shields.io/npm/v/@vureact/compiler-core.svg?label=Npm&style=flat-square)](https://vureact.top/)
88
[![Downloads](https://img.shields.io/npm/dt/@vureact/compiler-core?label=Downloads&style=flat-square)](https://www.npmjs.com/package/@vureact/compiler-core)

0 commit comments

Comments
 (0)