No description
Find a file
2023-04-17 11:47:47 +08:00
.cargo chore: change cargo lint to deny all warnings 2023-04-16 21:32:00 +08:00
.github ci: cache factory 2023-04-17 11:47:47 +08:00
benchmark chore(benchmark): update rules and add M2 data 2023-03-23 22:21:43 +08:00
crates chore(minifier): add test fixture (#287) 2023-04-17 11:24:58 +08:00
npm/oxc chore(npm): add funding link 2023-04-13 14:54:44 +08:00
tasks refactor(oxc_ast): change SourceType::with_ methods to return Self 2023-04-16 21:32:00 +08:00
.gitignore ci: setup npm publish 2023-03-02 06:55:56 -08:00
.gitmodules chore(tasks): update submodules 2023-02-24 13:08:22 +08:00
.typos.toml chore: rust taplo format 2023-04-15 14:14:11 +08:00
Cargo.lock refactor(allocator): clean up and add unit tests 2023-04-16 12:07:03 +08:00
Cargo.toml chore: rust taplo format 2023-04-15 14:14:11 +08:00
CONTRIBUTING.md docs: Update CONTRIBUTING.md (#288) 2023-04-17 10:12:12 +08:00
justfile chore: change cargo lint to deny all warnings 2023-04-16 21:32:00 +08:00
LICENSE Initial commit 2023-02-09 13:46:52 +08:00
README.md refactor(oxc_ast): clean up doc 2023-04-16 00:39:07 +08:00
rust-toolchain.toml ci: install minimal profile (#253) 2023-04-05 11:50:30 +08:00
rustfmt.toml chore: add rustfmt.toml 2023-02-11 13:11:17 +08:00
SECURITY.md Create SECURITY.md 2023-03-31 15:55:03 +08:00
THIRD-PARTY-LICENSE Minifier Prototype (#215) 2023-03-29 06:51:50 -07:00

OXC Logo

Discord chat Build Status npm version Crates.io Docs.rs

Code Coverage Code Size MIT licensed

The Oxidation Compiler is creating a suite of tools for the JavaScript / TypeScript language:

Goals

The primary objectives for this project include:

  • Create a really fast native program by using the Rust programming language
  • Provide the basic building blocks for creating your own tools by having good API designs
  • Provide good documentation on learning Rust and compiler techniques

Performance issues are considered as bugs in this project.

Contributing

This project is an invitation for you to come and learn Rust with us, We welcome and appreciate all contributions to this project.

To get started, check out CONTRIBUTING.md.

If you are unable to contribute code,, you can still participate by:

Milestone

As of now, Oxc has a fully working parser and a prototype for the linter.

The current objectives are:

  • A MVP (Most Viable Product) for the linter.
  • A prototype for the minifier.

Linter

The linter is fast to the extent that it feels broken.

With a few rules implemented, testing in the VSCode repo:

vscode  main  npx oxidation-compiler@latest lint src
Checked 3479 files in 335ms using 12 cores.
Found 17 errors.

And also in a huge monorepo:

Checked 73660 files in 7415ms using 12 cores.
Found 470 errors.

On my Intel i7 6-core, the linter is around 84 times faster than ESLint. But we'll get slightly slower as we add more features.

See benchmark for details.

Try it out yourself!

The linter is currently usable and it can potentially catch a few mistakes for you:

npx oxidation-compiler@latest lint path

All feedbacks are welcome.

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:
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

Rust cloc

───────────────────────────────────────────────────────────────────────────────
Language    Files       Lines     Blanks    Comments      Code
───────────────────────────────────────────────────────────────────────────────
Rust          160       39747       4286        2693     32768

Credits

This project was incubated with the assistance of these exceptional mentors and their projects:

License

MIT

Third Party Licenses

Licenses are list in THIRD-PARTY-LICENSE

This project partially copies code from the following projects:

Project License
eslint/eslint MIT
typescript-eslint/typescript-eslint MIT
microsoft/TypeScript Apache 2.0
rome/tools MIT
mozilla-spidermonkey/jsparagus MIT Apache 2.0
acorn MIT
miette Apache 2.0
terser BSD