Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 5.91 KB

README.md

File metadata and controls

113 lines (77 loc) · 5.91 KB
Raw

ReScript

Fast, Simple, Fully Typed JavaScript from the Future.

Current npm package version. Current Github Actions workflow status. ReScript is released under the LGPL license. Follow @rescriptlang

Introduction · Installation · Try Online · Forum · Contribute

ReScript is a robustly typed language that compiles to efficient and human-readable JavaScript. It comes with a lightning fast compiler toolchain that scales to any codebase size.

  • Fast and Simple. ReScript cares about a consistent and fast feedback loop for any codebase size. Refactor code, pull complex changes, or switch to feature branches as you please. No sluggish CI builds, stale caches, wrong type hints, or memory hungry language servers that slow you down.
  • A Robust Type System. Every ReScript app is fully typed and provides reliable type information for any given value in your program. We prioritize simpler types over complex types for the sake of clarity and easy debugability. No any, no magic types, no surprise undefined.
  • Seamless Integration. Use any library from JavaScript, export ReScript libraries to JavaScript, automatically generate TypeScript types. It's like you've never left the good parts of JavaScript at all.
  • Tooling that just works out of the box. A builtin pretty printer, memory friendly VSCode & Vim plugins, a stable type system and compiler that doesn't require lots of extra configuration. ReScript brings all the tools you need to build reliable JavaScript, Node and ReactJS applications.
  • Easy to adopt — without any lock-in. ReScript was made with gradual adoption in mind. If you ever want to go back to plain JavaScript, just remove all source files and keep its clean JavaScript output. Tell your coworkers that your project will keep functioning with or without ReScript!

ReScript is used by many companies to ship and maintain mission-critical products and is maintained by the ReScript community.

Contents

🎉 Getting Started

Follow the Installation Guide to set up a new ReScript project or integrate ReScript into your existing JavaScript project.

For more information on building React apps with ReScript, see the rescript-react documentation.

For React Native apps, see the rescript-react-native website.

📖 Documentation

The full documentation for the ReScript language can be found on our website.

The source for the ReScript documentation and website is hosted in a separate repo.

🚀 Upgrading

See the Upgrading Guide for instructions on upgrading to newer ReScript versions.

👏 How to Contribute

Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to ReScript.

Code of Conduct

The ReScript community has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Roadmap

You can learn more about our vision for ReScript in the Roadmap.

Discussions

For discussions on ongoing development, see the Development section of the ReScript forum.

📄 License

ReScript is licensed under LGPL version 3, with relaxed rules about creating and distributing combined work. See the LICENSE file for details.

The ReScript parser (subdirectory compiler/syntax) is licensed under the MIT License.

The ninja subdirectory contains the vendored ninja build system. Refer to its copyright and license notices for information about its licensing.

🏅 Acknowledgments

ReScript was originally created by Hongbo Zhang in 2015.

See CREDITS.md for further acknowledgements and project history.