Skip to content

Commit c3beceb

Browse files
docs(Rest): benefit-focused README rewrite
Replace verbose technical documentation with benefit-focused copy matching the website's goal-oriented direction. Consolidate 150+ lines of detailed architecture explanation into a concise problem/solution format with key value propositions. The new structure leads with the problem ("VS Code's TypeScript build uses tsc with Node.js overhead"), followed by the solution benefit ("2-3x faster"). Key features are reduced to three bullet points emphasizing outcomes: Rust-native compilation, 2-3x speed improvement, and 100% compatibility.
1 parent 8949250 commit c3beceb

1 file changed

Lines changed: 21 additions & 86 deletions

File tree

README.md

Lines changed: 21 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -35,121 +35,56 @@ Land
3535
</tr>
3636
</table>
3737

38+
3839
---
3940

40-
# **Rest** ⛱️
41+
# **Rest**&#x2001;⛱️
42+
43+
> **VS Code's TypeScript build uses tsc with Node.js overhead on every incremental compile. Build times grow linearly with project size. Even alternatives like esbuild still run in a Node.js process.**
4144
42-
The High-Performance TypeScript Compiler for Land 🏞️
45+
_"VS Code's TypeScript build step. 2-3x faster."_
4346

4447
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Rest/tree/Current/LICENSE)
4548
[![Rust Version](https://img.shields.io/badge/Rust-1.75+-orange.svg)](https://www.rust-lang.org/)
4649
[![OXC Version](https://img.shields.io/badge/OXC-0.48-blue.svg)](https://oxc.rs/)
4750

48-
**Rest** is a high-performance TypeScript compiler built with Rust and OXC,
49-
designed for 100% compatibility with VSCode's build process. It replaces
50-
esbuild's TypeScript loader with a Rust-powered compiler that produces
51-
VSCode-compatible output.
52-
53-
**What Rest gives you:**
54-
55-
1. **2-3x faster than esbuild.** OXC parses and transforms TypeScript at native
56-
Rust speed. No Node.js GC pauses, no V8 JIT warmup.
57-
2. **Byte-for-byte VS Code output.** The bundles Rest produces are identical to
58-
VS Code's gulp build. Full compatibility, no surprises.
59-
3. **Deterministic builds.** Rust's ownership model means no GC, no
60-
nondeterministic finalizers. Same input always produces same output.
61-
4. **Latest TypeScript support.** Built on OXC 0.48 with full TypeScript 5.x
62-
syntax coverage.
51+
Rest is an OXC-powered TypeScript compiler implemented in Rust. 100% compatible output at 2-3x the speed of esbuild. Zero Node.js overhead in the build path. Rest processes VS Code's platform code into the bundled artifacts that Cocoon loads at runtime.
6352

6453
📖 **[Rust API Documentation](https://Rust.Documentation.Rest.Editor.Land/)**
6554

6655
---
6756

68-
## Key Features 🔐
69-
70-
- **Full TypeScript 5.x Support**: Complete compatibility with TypeScript 5.x
71-
syntax and features.
72-
- **Decorator Handling**: Proper support for `emitDecoratorMetadata` and
73-
decorator transformations.
74-
- **Class Fields Control**: Configurable `useDefineForClassFields` behavior
75-
(VSCode default: false).
76-
- **Parallel Compilation**: Optional `--Parallel` flag for multi-core
77-
compilation.
78-
- **Directory-Based Compilation**: Process entire directory structures with
79-
preserved layout.
80-
- **Comprehensive Error Reporting**: Detailed error messages with source
81-
location information.
82-
- **Compilation Metrics**: Built-in tracking of compilation count, elapsed time,
83-
and error counts.
84-
- **Source Map Generation**: Planned support for source maps (in progress).
85-
86-
---
87-
88-
## Core Architecture Principles 🏗️
89-
90-
| Principle | Description | Key Components Involved |
91-
| :----------------- | :----------------------------------------------------------------------- | :------------------------------- |
92-
| **Performance** | Rust + OXC delivers 2-3x faster compilation than esbuild. | OXC Parser, Transformer, Codegen |
93-
| **Compatibility** | OXC is used by VSCode internally, ensuring 1:1 output compatibility. | OXC 0.48, VSCode build process |
94-
| **Memory Safety** | No garbage collection, deterministic performance through Rust ownership. | Rust lifetime management |
95-
| **Modern Tooling** | Built on the latest OXC infrastructure for TypeScript compilation. | OXC 0.48+ |
96-
97-
---
98-
99-
## Deep Dive & Component Breakdown 🔬
100-
101-
To understand how `Rest`'s internal components interact to provide
102-
high-performance TypeScript compilation, see the following source files:
103-
104-
- **[`Source/Library.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Library.rs)** -
105-
Binary entry point
106-
- **[`Source/Fn/OXC/Compiler.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Fn/OXC/Compiler.rs)** -
107-
Main compiler orchestration
108-
- **[`Source/Fn/OXC/Parser.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Fn/OXC/Parser.rs)** -
109-
OXC parser wrapper
110-
- **[`Source/Fn/OXC/Transformer.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Fn/OXC/Transformer.rs)** -
111-
AST transformation
112-
- **[`Source/Fn/OXC/Codegen.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Fn/OXC/Codegen.rs)** -
113-
Code generation
114-
- **[`Source/Struct/CompilerConfig.rs`](https://github.com/CodeEditorLand/Rest/tree/Current/Source/Struct/CompilerConfig.rs)** -
115-
Advanced configuration
116-
117-
The source files explain the OXC-based compilation pipeline, decorator handling,
118-
and VSCode compatibility transformations.
119-
120-
---
121-
122-
## `Rest` in the Land Ecosystem ⛱️ + 🏞️
57+
## What It Does&#x2001;🔐
12358

124-
| Component | Role & Key Responsibilities |
125-
| :---------------- | :----------------------------------------------------------- |
126-
| **Rest Compiler** | High-performance TypeScript to JavaScript compilation. |
127-
| **RestPlugin** | esbuild plugin that integrates Rest into the build pipeline. |
128-
| **Build System** | Environment-driven compiler selection (esbuild or Rest). |
59+
- **Rust-native compilation.** OXC parser implemented in Rust. Zero Node.js in the build path.
60+
- **2-3x faster than esbuild.** The same compatible output at significantly higher throughput.
61+
- **100% compatible output.** VS Code platform code compiles without modification.
12962

13063
---
13164

132-
## Changelog 📜
65+
## Development&#x2001;🛠️
13366

134-
See [`CHANGELOG.md`](https://github.com/CodeEditorLand/Rest/tree/Current/) for a
135-
history of changes to this component.
67+
Rest is a component of the Land workspace. Follow the
68+
[Land Repository](https://github.com/CodeEditorLand/Land) instructions to
69+
build and run.
13670

13771
---
13872

139-
## License ⚖️
140-
141-
This project is licensed under Creative Commons CC0.
73+
## License&#x2001;⚖️
14274

143-
See the LICENSE file for details.
75+
CC0 1.0 Universal. Public domain. No restrictions.
76+
[LICENSE](https://github.com/CodeEditorLand/Rest/tree/Current/LICENSE)
14477

14578
---
14679

147-
14880
## See Also
14981

82+
- [Rest Documentation](https://editor.land/Doc/rest)
15083
- [Architecture Overview](https://editor.land/Doc/architecture)
84+
- [Why Rust](https://editor.land/Doc/why-rust)
15185
- [Output](https://github.com/CodeEditorLand/Output)
152-
- [Common](https://github.com/CodeEditorLand/Common)
86+
- [Cocoon](https://github.com/CodeEditorLand/Cocoon)
87+
15388

15489
## Funding & Acknowledgements 🙏🏻
15590

0 commit comments

Comments
 (0)