# ezno

> A JavaScript compiler and TypeScript checker written in Rust with a focus on static analysis and runtime performance

Latest version **0.0.23** (published 2024-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install ezno
pnpm add ezno
yarn add ezno
bun add ezno
```

Provides the command `ezno`.

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.0.23 |
| Published | 2024-11-13 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2732 |
| Author | Ben |
| Maintainers | kaleidawave |
| Keywords | typescript, checker, type-checker, compiler |

## Links

- npm: https://www.npmjs.com/package/ezno
- Repository: https://github.com/kaleidawave/ezno
- Homepage: https://github.com/kaleidawave/ezno#readme
- Issues: https://github.com/kaleidawave/ezno/issues
- Funding: https://github.com/sponsors/kaleidawave
- npm.io page: https://npm.io/package/ezno

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.23 (latest) — 2024-11-13
- 0.0.22 — 2024-08-29
- 0.0.21 — 2024-05-31
- 0.0.20 — 2024-04-10
- 0.0.19 — 2024-01-03
- 0.0.18 — 2023-12-20
- 0.0.17 — 2023-11-20
- 0.0.15 — 2023-10-20
- 0.0.14 — 2023-09-29
- 0.0.13 — 2023-09-25
- 0.0.8 — 2023-03-21
- 0.0.1 — 2023-03-21
- 0.0.0 — 2022-01-24

## README

# Ezno

This contains a JavaScript edition of [Ezno](https://github.com/kaleidawave/ezno)

## CLI

This package includes a JS & WASM based version of the CLI. You can use as follows

```shell
node dist/cli.cjs info
# or
deno run -A dist/cli.mjs info
```

## Library example

For a environment that supports `node:fs`, you can use a version that initializes the WASM for you

```js
import { check } from 'ezno/initialised';
const fs_handler = (_path) => "const x: string = t ? 4 : 5;";
const output = check("input.ts", fs_handler);
console.dir(output.diagnostics, { depth: 5 });
```

For the web, `init()` is needed to load the WASM before calling any functions.

```js
import { check, init } from 'ezno';

await init();

const fs_handler = (_path) => "const x: string = t ? 4 : 5;";
const output = check("input.ts", fs_handler);
console.dir(output.diagnostics, { depth: 5 });
```

See more usage in the [./test.mjs](./test.mjs) and in the [playground](../playground/main.js).

You can see the Rust definitions of these exports under [../../src/wasm_bindings.rs](../../src/wasm_bindings.rs). Thanks to [#114](https://github.com/kaleidawave/ezno/pull/114) all these exports have associated type definitions.

There also exists more functions such as `check_with_options` which takes an additional `TypeCheckOptions`. For parsing string to AST there is `parse_expression` & `parse_module`. If you find something implemented in Rust, but not exposed to the JS or WASM context: [feel to make a request issue for it to be exposed via the JS API](https://github.com/kaleidawave/ezno/issues/new).

## Commands for building this package

Run this **from this folder, not the root**:

```shell
npm run clean
npm run build
```

See `package.json` for the other building commands.

- It first builds the WASM binary with rustc, `cargo build --lib --target wasm32-unknown-unknown`
- It then binds (builds associate JS library) into the `build` folder with `wasm-bindgen --out-dir build --target web`
- It then bundles (and generates CJS & EJS formats) with some associate JS using `unbuild` into the `dist` folder

---
_Source: https://npm.io/package/ezno · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._