Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaleidawave/ezno
A JavaScript compiler and TypeScript checker written in Rust with a focus on static analysis and runtime performance
https://github.com/kaleidawave/ezno
compiler javascript typechecker types typescript
Last synced: 3 days ago
JSON representation
A JavaScript compiler and TypeScript checker written in Rust with a focus on static analysis and runtime performance
- Host: GitHub
- URL: https://github.com/kaleidawave/ezno
- Owner: kaleidawave
- License: mit
- Created: 2023-02-03T19:27:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T11:31:15.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:56:30.028Z (about 1 month ago)
- Topics: compiler, javascript, typechecker, types, typescript
- Language: Rust
- Homepage: https://kaleidawave.github.io/posts/introducing-ezno/
- Size: 4.25 MB
- Stars: 2,452
- Watchers: 20
- Forks: 45
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- jimsghstars - kaleidawave/ezno - A fast and correct TypeScript type checker and compiler with additional experiments (Rust)
README
A fast and correct TypeScript type checker and compiler with additional experiments
> [!IMPORTANT]
> Ezno is in active development and **does not currently support enough features to check existing projects** (see [blocking issues](https://github.com/kaleidawave/ezno/labels/blocking)). Check out the [getting started guide](./checker/documentation/getting-started.md) for experimenting with what it [currently supports](./checker/specification/specification.md).
What Ezno is:
- A type checker for JavaScript usable through a CLI ([with a LSP also in the works](https://github.com/kaleidawave/ezno/issues/22))
- Checks programs with guaranteed type safety (no runtime [`TypeError`s](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError)) (**as long as definitions are sound**)
- Types aimed at soundness and tracing for better static analysis
- A *imperative* type system that tracks and evaluates the side effects of functions and control flow structures. It is similar to an interpreter, but acts with types instead of *values* and does not run IO, side effects, etc.
- A collection of experiments of types. Many are being worked out and are in the prototype stage. Some of the new behaviors benefit JavaScript specifically and others could be applied to other languages
- Written in Rust
- [Fast](https://github.com/kaleidawave/ezno/actions/workflows/performance-and-size.yml) and [Small](https://github.com/kaleidawave/ezno/actions/workflows/lines-of-code.yml)
- Open source! [You can help build Ezno!](https://github.com/kaleidawave/ezno/issues?q=is%3Aopen+label%3Agood-first-issue%2Cfeedback-needed)
- A challenge to the status quo of type checking, optimisations and compilation through deeper static analysis beyond syntax analysis!
What Ezno is not
- **eNZo, the Z is in front of the N** (pronounce as 'Fresno' without the 'fr') 😀
- Be on parity with TSC or 1:1, it has some different behaviors **but** should work in existing projects using TSC. [You can see a full comparison of emitted errors and warnings compared with TSC here](https://kaleidawave.github.io/ezno/comparison)
- Faster as a means to serve large codebases. Cut out bloat and complex code first!
- Smarter as a means to allow more *dynamic patterns*. Keep things simple!
- A binary executable compiler. It takes in JavaScript (or a TypeScript or Ezno superset) and does similar processes to traditional compilers, but at the end emits JavaScript. However, in the future, it *could* generate a lower level format using its event (side-effect) representation.
Read more about Ezno (in chronological order)
- [Introducing Ezno](https://kaleidawave.github.io/posts/introducing-ezno/)
- [Ezno in '23](https://kaleidawave.github.io/posts/ezno-23/)
- [A preview of the checker](https://kaleidawave.github.io/posts/a-preview-of-the-checker/)
- [The quest continues](https://kaleidawave.github.io/posts/the-quest-continues/)
- [Sets, types and type checking](https://kaleidawave.github.io/posts/sets-types-and-type-checking/) (*general post*)
---
This project is a workspace consisting of a few crates:
| Crate | Lines Of Code | Contains |
|---|---|---|
| checker |  | Stores for types and contexts, type checking logic and optional synthesis over the parser AST |
| parser |  | AST definitions, logic for parsing, AST to string and visiting |
## Help contribute
Check out [good first issues]((https://github.com/kaleidawave/ezno/issues?q=is%3Aopen+label%3Agood-first-issue%2Cfeedback-needed)) and comment on discussions! Feel free to ask questions on parts of the code of the checking implementation.
Read [CONTRIBUTING.md](https://github.com/kaleidawave/ezno/blob/main/CONTRIBUTING.md) for information about building and testing.