The Oxidation Compiler is creating a suite of high-performance tools for the JavaScript / TypeScript language re-written in Rust:
- AST - See docs.rs
- Parser (acorn) - See docs.rs, @oxidation-compiler/napi
- Linter (ESLint) - Prototype - Try it out!
npx oxlint@latest path
- Formatter (prettier)
- Transpiler (babel)
- Minifier (terser) - Prototype
- Resolver (enhanced-resolve)
- Type Checker - See ezno, available via
npx oxidation-compiler@latest check path
Philosophy
This project follows philosophies from the Rome and Ruff projects.
- JavaScript tooling could be rewritten in a more performant language
- An integrated toolchain can tap into efficiencies that are not available to a disparate set of tools
Milestone
This project currently has a fully working parser, a prototype for the linter as well as the minifier.
The current objectives are:
- Publish the linter as a product
- Finish the minifier
Contributing
This project is an invitation for you to come and learn Rust with us, any contributions to this project are appreciated.
To get started, check out some of the good first issues or ask us on Discord.
If you are unable to contribute by code, you can still participate by:
- star and watch this project
- test the linter by running
npx oxlint@latest .
in your own projects - join us on Discord
- follow me on twitter
- provide your wisdom in discussions
Linter
The linter is fast to the extent that it feels broken.
With 45 rules implemented, testing in the VSCode repo on a Mac M2:
vscode ξ main β― npx oxlint@latest src
Finished in 388ms on 3477 files with 45 rules using 8 threads.
Found 798 warnings.
And also in a huge monorepo using Mac i7:
Finished in 5568ms on 51931 files with 45 rules using 12 threads.
On my Intel i7 6-core, the linter is around 80 times faster than ESLint.
See benchmark for details.
Try it out yourself!
The linter is currently usable and it can potentially catch a few mistakes for you:
npx oxlint@latest path
Parser Conformance
The cargo coverage
command reports the following conformance summary
Test262 Summary:
AST Parsed : 44000/44000 (100.00%)
Positive Passed: 44000/44000 (100.00%)
Negative Passed: 3915/3915 (100.00%)
Babel Summary:
AST Parsed : 2065/2071 (99.71%)
Positive Passed: 2062/2071 (99.57%)
Negative Passed: 1332/1502 (88.68%)
TypeScript Summary:
AST Parsed : 2337/2337 (100.00%)
Positive Passed: 2331/2337 (99.74%)
Negative Passed: 673/2535 (26.55%)
Test262 conformance is complete. TypeScript parsing is complete.
Only unstable stage 3 json-modules
and stage 3 decorators
tests are skipped.
Learning Resources
- My small tutorial on how to write a JavaScript Parser in Rust
- My small article - Pursuit of Performance on Building a JavaScript Compiler
- Crafting Interpreters
- [Create an issue and insert your inspirational learning resources here]
Maintainers
- Project Lead: Boshen
Credits
This project was incubated with the assistance of these exceptional mentors and their projects:
- Rome Tools - @MichaReiser, @ematipico
- Ruff - @charliermarsh
- quick-lint-js - @strager
- elm-review - @jfmengels
- @domonji for contribution to the TypeScript parser
License
Third Party Licenses
Licenses are listed in THIRD-PARTY-LICENSE
This project partially copies code from the following projects: