Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DZakh/rescript-schema

🧬 The fastest parser in the entire JavaScript ecosystem with a focus on small bundle size and top-notch DX
https://github.com/DZakh/rescript-schema

ajv contract json parse rescript schema struct ts typescript typescript-library valibot zod

Last synced: 13 days ago
JSON representation

🧬 The fastest parser in the entire JavaScript ecosystem with a focus on small bundle size and top-notch DX

Host: GitHub
URL: https://github.com/DZakh/rescript-schema
Owner: DZakh
License: mit
Created: 2022-03-19T11:52:49.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-23T20:29:12.000Z (21 days ago)
Last Synced: 2024-10-24T08:12:43.167Z (20 days ago)
Topics: ajv, contract, json, parse, rescript, schema, struct, ts, typescript, typescript-library, valibot, zod
Language: ReScript
Homepage:
Size: 2.18 MB
Stars: 153
Watchers: 5
Forks: 7
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![CI](https://github.com/DZakh/rescript-schema/actions/workflows/ci.yml/badge.svg)](https://github.com/DZakh/rescript-schema/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/DZakh/rescript-schema/branch/main/graph/badge.svg?token=40G6YKKD6J)](https://codecov.io/gh/DZakh/rescript-schema)

[![npm](https://img.shields.io/npm/dm/rescript-schema)](https://www.npmjs.com/package/rescript-schema)

# ReScript Schema 🧬

The fastest parser in the entire JavaScript ecosystem with a focus on small bundle size and top-notch DX.

> ⚠️ Be aware that **rescript-schema** uses `eval` for parsing. It's usually fine but might not work in some environments like Cloudflare Workers or third-party scripts used on pages with the [script-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src) header.

Highlights:

- Works with plain JavaScript, TypeScript, and ReScript. You don't need to use any compiler.

- The **fastest** parsing and validation library in the entire JavaScript ecosystem ([benchmark](https://moltar.github.io/typescript-runtime-type-benchmarks/))

- Small JS footprint & tree-shakable API ([Comparison with Zod and Valibot](#comparison))

- Describe transformations in a schema without a performance loss

- Can reverse transformed values to the initial format (serializing)

- Error messages are detailed and easy to understand

- Support for asynchronous transformations

- Immutable API with both result and exception-based operations

- Easy to create _recursive_ schema

- Opt-in strict mode for object schema to prevent excessive fields. And many more built-in helpers

- Opt-in ReScript PPX to generate schema from type definition

Also, it has declarative API allowing you to use **rescript-schema** as a building block for other tools, such as:

- [rescript-rest](https://github.com/DZakh/rescript-rest) - RPC-like client, contract, and server implementation for a pure REST API

- [rescript-envsafe](https://github.com/DZakh/rescript-envsafe) - Makes sure you don't accidentally deploy apps with missing or invalid environment variables

- [rescript-json-schema](https://github.com/DZakh/rescript-json-schema) - Typesafe JSON schema for ReScript

- Internal form library at [Carla](https://www.carla.se/)

## Documentation

- [For ReScript users](/docs/rescript-usage.md)

- [For PPX users](/packages/rescript-schema-ppx/README.md)

- [For JS/TS users](/docs/js-usage.md)

- [For library maintainers](/docs/integration-guide.md)

## Comparison

Instead of relying on a few large functions with many methods, **rescript-schema** follows [Valibot](https://github.com/fabian-hiller/valibot)'s approach, where API design and source code is based on many small and independent functions, each with just a single task. This modular design has several advantages.

For example, this allows a bundler to use the import statements to remove code that is not needed. This way, only the code that is actually used gets into your production build. This can reduce the bundle size by up to 2 times compared to [Zod](https://github.com/colinhacks/zod).

Besides the individual bundle size, the overall size of the library is also significantly smaller.

At the same time **rescript-schema** is the fastest composable validation library in the entire JavaScript ecosystem. This is achieved because of the JIT approach when an ultra optimized validator is created using `eval`.

|                                          | [email protected] | [email protected]      | [email protected] |

| ---------------------------------------- | --------------------- | --------------- | -------------- |

| **Total size** (minified + gzipped)      | 9.71 kB               | 14.6 kB         | 10.4 kB        |

| **Example size** (minified + gzipped)    | 5.48 kB               | 12.9 kB         | 1.22 B         |

| **Parse with the same schema**           | 155,887 ops/ms        | 1,273 ops/ms    | 3,771 ops/ms   |

| **Create schema & parse once**           | 146 ops/ms            | 108 ops/ms      | 2,485 ops/ms   |

| **Eval-free**                            | ❌                    | ✅              | ✅             |

| **Codegen-free** (Doesn't need compiler) | ✅                    | ✅              | ✅             |

| **Ecosystem**                            | ⭐️⭐️                | ⭐️⭐️⭐️⭐️⭐️ | ⭐️⭐️⭐️      |