Merge branch 'master' into playgroud-output-result-rebase-aspeddro

Author: aspeddro

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,20 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🚀 rescript-compiler
+    url: https://github.com/rescript-lang/rescript-compiler/issues
+    about: Please report problems about the ReScript compiler and build system here.
+  - name: 💻 rescript-vscode
+    url: https://github.com/rescript-lang/rescript-vscode/issues
+    about: VSCode language support, LSP, tools
+  - name: 📦 create-rescript-app
+    url: https://github.com/rescript-lang/create-rescript-app/issues
+    about: ReScript's project generator
+  - name: ⚛️ rescript-react
+    url: https://github.com/rescript-lang/rescript-react/issues
+    about: ReScript bindings to React.js
+  - name: 🌐 rescript-core
+    url: https://github.com/rescript-association/rescript-core/issues
+    about: New ReScript standard library
+  - name: 💬 ReScript Forum
+    url: https://forum.rescript-lang.org/
+    about: For discussions about ReScript, please visit the official ReScript forum.

.github/ISSUE_TEMPLATE/documentation_issue.md

@@ -0,0 +1,9 @@
+---
+name: 🚨 Documentation issue
+about: Create an issue to help us improve the rescript-lang.org documentation website
+title: ''
+labels: ''
+assignees: ''
+
+---
+

CONTRIBUTING.md

@@ -6,8 +6,8 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
 
 ## Ways to contribute
 
-- Writing docs for the manual (Check for issues that are marked with a [`manual`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"manual") and [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") tag)
-- Joining in discussions on our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues)
+- Writing docs for the manual (Check for issues that are marked with a [`manual`](https://github.com/rescript-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"manual") and [`help wanted`](https://github.com/rescript-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") tag)
+- Joining in discussions on our [issue tracker](https://github.com/rescript-association/rescript-lang.org/issues)
 - Give feedback for improvements (incomplete / missing docs, bad wording,
   search user experience / design, etc.)
 - Advanced: Help building platform features (design system, automatic testing, markdown parsing, etc.)
@@ -16,15 +16,15 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
 
 ### Find an issue
 
-Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues) for any issues or discussions on the topic.
+Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/rescript-association/rescript-lang.org/issues) for any issues or discussions on the topic.
 
 If you can't find any relevant issues, feel free to create a new one to start a discussion. We usually assign issues to a responsible person to prevent confusion and duplicate work, so always double check if an issue is currently being worked on, or talk to the current assignee to take over the task.
 
 **Always make sure to get feedback from the core maintainers before starting any work**
 
 The project follows very specific goals and tries to deliver the highest value with the least amount of resources. Please help us focus on the tasks at hand and don't submit any code / bigger refactorings without any proper discussion on the issue tracker. Otherwise your PR might not be accepted!
 
-If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") or [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted").
+If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/rescript-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") or [`help wanted`](https://github.com/rescript-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted").
 
 ### Discuss an issue
 
@@ -44,7 +44,7 @@ We value your voluntary work, and of course it's fine to step back from a ticket
 
 ### Communication Channels
 
-- [Issue Tracker](https://github.com/reason-association/rescript-lang.org/issues)
+- [Issue Tracker](https://github.com/rescript-association/rescript-lang.org/issues)
 - [ReScript Discourse (General / mostly unrelated discussions)](http://forum.rescript-lang.org)
 
 ## Working on the rescript-lang.org
@@ -55,7 +55,7 @@ We try to keep our contribution guidelines to a minimum. Please keep following r
 
 The less code we write, the better. If there's a way to do rendering on the server, or enhance existing markdown files, we prefer that over client-side rendering and external loading.
 
-We also try to keep our third-party dependencies to a minimum. We use specific frameworks to make things work (`unified`, `remark`, `mdx`, `bs-platform`, etc).  Please try to keep a small JS footprint, especially for client side code (to keep the bundle size small).
+We also try to keep our third-party dependencies to a minimum. We use specific frameworks to make things work (`unified`, `remark`, `mdx`, `bs-platform`, etc). Please try to keep a small JS footprint, especially for client side code (to keep the bundle size small).
 
 ### Think about the target audience & UX
 
@@ -72,7 +72,7 @@ Always check if there are any designs for certain UI components and think about
 
 ### Tailwind for CSS Development
 
-We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check out the [tailwind.config.js](tailwind.config.js) file for configured tailwind features, colors, border-radius values etc..  If you are not familiar with Tailwind, check out existing components for inspiration.
+We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check out the [tailwind.config.js](tailwind.config.js) file for configured tailwind features, colors, border-radius values etc.. If you are not familiar with Tailwind, check out existing components for inspiration.
 
 We sometimes also need to fall back to common css (with tailwind `@apply` directives to enforce our style system). You can find the CSS main entrypoint in [styles/main.css](styles/main.css).
 

README.md

@@ -9,6 +9,7 @@ This is the official documentation platform for the [ReScript](https://rescript-
 **Please report any technical issues with ReScript to the [compiler repository](https://github.com/rescript-lang/rescript-compiler).**
 
 **In case you are missing some specific documentation:**
+
 - Some language / compiler feature may not be documented yet
 - Create an issue to let us know what you are missing
 - In case you want to contribute missing docs, please refer to our [Contribution section](#contributing)
@@ -42,7 +43,7 @@ open localhost:3000
 In case you want to run ReScript in watchmode:
 
 ```sh
-npx rescript build -w
+npx rescript -w
 ```
 
 ## Build Index Data
@@ -82,9 +83,10 @@ build specific pages (file `index_data/x.json` not found).
 ### Markdown Codeblock Tests
 
 We check the validity of our code examples marked with:
-- `` ```res example `` (ReScript code snippet)
-- `` ```res sig `` (signature)
-- `` ```res prelude `` (ReScript code snippet available for all subsequent code snippets)
+
+- ` ```res example ` (ReScript code snippet)
+- ` ```res sig ` (signature)
+- ` ```res prelude ` (ReScript code snippet available for all subsequent code snippets)
 
 Run the checks with:
 

_blogposts/2020-08-10-bucklescript-is-rebranding.mdx

@@ -99,7 +99,7 @@ The ReScript community will comprise of the majority of the old Reason community
 
 **The new changes make me worried about the future support I'm going to receive from the team.**
 
-_Retrospective edit, in 2021_: suffice to day that we've been doing well =).
+_Retrospective edit, in 2021_: suffice to say that we've been doing well =).
 
 ## Conclusion
 

_blogposts/2020-11-17-editor-support-custom-operators-and-more.mdx

@@ -28,7 +28,7 @@ Hongbo continues to improve the compiler experience in monorepo-like setups. Exp
 
 ## Docs
 
-Patrick is [rearranging the React documentation](https://github.com/reason-association/rescript-lang.org/pull/96), and continues to improve the main documentation site with Cheng Lou.
+Patrick is [rearranging the React documentation](https://github.com/rescript-association/rescript-lang.org/pull/96), and continues to improve the main documentation site with Cheng Lou.
 
 ## Syntax
 

_blogposts/2024-01-11-release-11-0-0.mdx

@@ -0,0 +1,152 @@
+---
+author: rescript-team
+date: "2024-01-11"
+previewImg: /static/blog/compiler_release_11_0.jpg
+title: ReScript 11.0
+badge: release
+description: |
+  The ReScript developer experience now goes up to eleven!
+---
+
+Almost a year after the last release, ReScript is available in version 11! It marks the second major community-driven release and we are very thankful that there are so many willing contributors who invested their spare time into improving the compiler and its ecosystem.
+
+Use your favorite package manager to install the new compiler release, e.g:
+
+```sh
+npm install rescript@11
+```
+
+To upgrade your project or to find out if there are any breaking changes that affect you, please follow the [migration guide](/docs/manual/latest/migrate-to-v11).
+
+The complete list of changes can be found [here](https://github.com/rescript-lang/rescript-compiler/blob/v11.0.0/CHANGELOG.md). Let's have a look at the most notable improvements.
+
+## Highlights
+
+**Note**: As this release is packed, please refer to the linked blogposts for a detailed breakdown of each of the main new features.
+
+### Customizable Variants
+
+We are introducing new features that will improve interop with JavaScript/TypeScript, including customizable runtime representation of variants, zero cost bindings to discriminated unions, and unboxed variants that can be used to map to things like heterogenous array items and nullable values.
+
+- Blogpost: [Better interop with customizable variants](/blog/improving-interop)
+
+### Enhanced Ergonomics for Record Types
+
+New enhancements for record types: Record Type Spread and Record Type Coercion. Record Type Spread allows one to share subsets of record fields with other record types, making it easier to work with types with lots of fields. And Record Type Coercion makes it easier to safely to convert between records with the same set of fields (or a subset).
+
+- Blogpost: [Enhanced Ergonomics for Record Types](/blog/enhanced-ergonomics-for-record-types)
+
+### First-class Dynamic Import Support
+
+Another addition is first-class support for dynamic imports, which will allow developers to split up and load parts of the app code on demand as separate JS modules to prevent bundle bloat and reduce initial load times for applications.
+
+- Blogpost: [First-class Dynamic Import Support](/blog/first-class-dynamic-import-support)
+
+### Uncurried Mode
+
+This release is also introducing uncurried mode, which is a new default mode that compiles all dependencies as uncurried, and it aims to make it easier for newcomers to use the language.
+
+- Blogpost: [Uncurried Mode](/blog/uncurried-mode)
+
+### New Standard Library: ReScript Core
+
+[ReScript Core](https://github.com/rescript-association/rescript-core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode.
+
+The latest docs on [rescript-lang.org](/) already use it for the examples. Have a look at the new [RescriptCore API docs](/docs/manual/latest/api/core).
+
+## More Features
+
+Furthermore, there are a lot of smaller improvements of which we want to state only a few here.
+
+### More types eligible for type coercion
+
+The `:>` (type coercion) operator now supports a few more datatypes, check out its [Syntax Lookup](/syntax-lookup#type-coercion) page.
+
+### Build System
+
+The watcher can now be called with just `rescript -w`. Also `rescript build` will always build with dependencies by default so the argument `-with-deps` is not needed anymore.
+
+### rescript.json
+
+The compiler config file has been renamed to `rescript.json`. Since the rebrand from `BuckleScript` to `ReScript`, the `bs-` names make no sense anymore. Later on, we will also rename some of the config attributes, like `bs-dependencies`.
+
+### Relaxed Suffix Rules
+
+You can now freely choose the suffix of the generated JS files. We recommend `.res.js`/`.res.mjs` which is also what our official templates in [`create-rescript-app`](#create-rescript-app) are using.
+
+### Opening files from current project globally
+
+It's now possible to have a module opened by default that is just part of the current project. Previously, this only worked with dependencies or namespaced projects. For example, a file with the path `src/Utils.res` can be added to `bsc-flags` like so:
+
+```json
+{
+  "bsc-flags": ["-open Utils"]
+}
+```
+
+## Ecosystem
+
+### Create-ReScript-App
+
+Previously, the ReScript binary was able to initialize new projects itself. But it was required to have a global npm install to use it. This functionality has been removed.
+
+Going forward, `create-rescript-app` is the new recommended way to setup a new project. It can even be used to quickly add ReScript to an existing project. Have a look at the updated [installation instructions](/docs/manual/latest/installation) for how to use it.
+
+### ReScript-React v0.12
+
+In tandem with the new ReScript release, a new version of ReScript-React is released as well. It brings support for dynamically loading React components via `React.lazy`, and more. Check out the [corresponding docs](/docs/react/latest/installation).
+
+### ReScript Tools / Documentation Extraction
+
+There is a new experimental tool available that is a building block for documentation generation from ReScript files. It can be installed and used as follows:
+
+```sh
+npm install --save-dev @rescript/tools
+npx rescript-tools doc src/MyFile.res > doc.json
+```
+
+The tool generates a JSON structure with all the information you need to generate documentation automatically for your ReScript code. It also comes with ReScript bindings for that JSON. Shortly we'll also have automatic markdown generation, and we're planning a static site generator as well, so getting a nice looking and useful documentation site for your ReScript code is just a command away.
+
+### LSP
+
+Our LSP powers our editor tooling. Historically, it has lived within the VSCode extension. This has been a problem for people who do not use VSCode. So, we've made sure that each new LSP version is [published standalone to NPM](https://www.npmjs.com/package/@rescript/language-server).
+
+This makes using an up-to-date version of the LSP in other editors than VSCode much easier. You can install and use it like so:
+
+```sh
+npm install -g @rescript/language-server
+npx rescript-language-server --stdio
+```
+
+## What's next
+
+As we now finish up the work on v11, we're looking forward to working on the next ReScript version. Here are some of the features we're planning to focus on in upcoming versions:
+
+- Make JSX usable beyond React:
+  - [Generic JSX transform](https://github.com/rescript-lang/rescript-compiler/issues/6408)
+  - [JSX preserve mode](https://github.com/rescript-lang/rescript-compiler/issues/6197)
+- Integrate the Rescript Core standard library into the compiler
+  - remove the OCaml standard library
+  - remove `Belt` but keep it available as external package
+- Make maintaining TS libraries with ReScript a breeze, [thanks to genType](https://github.com/rescript-lang/rescript-compiler/issues/6210)
+- Support [tagged template literals](https://github.com/rescript-lang/rescript-compiler/pull/6250)
+- [Dedicated syntax for creating Dicts](https://github.com/rescript-lang/rescript-compiler/issues/6545)
+- [Array spread syntax](https://github.com/rescript-lang/rescript-compiler/issues/6546)
+- A [new custom build system](https://github.com/rolandpeelen/rewatch) with better support for workspaces / monorepos
+- More improvements to the type system
+
+## Acknowledgements
+
+We want to thank everyone from the community who volunteered their precious time to support this project with contributions of any kind, from documentation, to PRs, to discussions in the forum.
+
+## That's it
+
+We hope you enjoy the newest improvements as much as we do.
+
+In case of issues / problems, make sure to report bugs to one of the following repositories:
+
+- [rescript-lang/rescript-compiler](https://github.com/rescript-lang/rescript-compiler) (language / syntax / jsx)
+- [rescript-lang/rescript-react](https://github.com/rescript-lang/rescript-react) (React bindings)
+- [rescript-lang/rescript-vscode](https://github.com/rescript-lang/rescript-vscode) (VSCode language support, LSP, tools)
+- [rescript-lang/create-rescript-app](https://github.com/rescript-lang/create-rescript-app) (project generator) or
+- [rescript-association/rescript-lang.org](https://github.com/rescript-association/rescript-lang.org) (documentation)

_blogposts/archive/2020-05-11-state-of-reasonml-org-2020-q2-pt2.mdx

@@ -33,7 +33,7 @@ List.head([1, 2, 3]); /* This should actually be Belt.List */
 Running the test with the broken example would produce:
 
 ```sh
-node scripts/test-examples.js "pages/apis/latest/belt/list.mdx"
+node scripts/test-examples.mjs "pages/apis/latest/belt/list.mdx"
 
 Testing example in 'pages/apis/latest/belt/list.mdx' on line 23...
 Testing example in 'pages/apis/latest/belt/list.mdx' on line 43...
@@ -54,7 +54,7 @@ Failed: 1
 Success: 55
 
 Tip: You can also run tests just for specific files / globs:
-`node scripts/test-examples.js "pages/belt_docs/array.mdx"`
+`node scripts/test-examples.mjs "pages/belt_docs/array.mdx"`
 
 -----------
 Error Preview:

_blogposts/archive/2020-07-01-bucklescript-8-1-new-syntax.mdx

@@ -16,7 +16,7 @@ The release of BuckleScript 8.1 contains a new important addition: we've rewritt
 
 The rewrite was done by a community member of ours, [Maxim](https://twitter.com/_binary_search). Maxim was a main contributor to the old Reason repo, and together we've reached the conclusion a while ago that the codebase needed a revamp. After wrestling with it for the longest time, we've settled on a low-key rewrite.
 
-Syntax discussions have always been churny, so we didn't want to prematurity announce something before it's ready for proper critiques. After testing this extensively; we now deem it solid enough for your consumption.
+Syntax discussions have always been churny, so we didn't want to prematurely announce something before it's ready for proper critiques. After testing this extensively, we now deem it solid enough for your consumption.
 
 **Here's what you need to know:**
 - The new syntax comes directly with your BuckleScript >=8.1 installation. You won't have to install anything else. It does not depend on the old `refmt`.

_blogposts/archive/2020-07-06-a-note-on-bucklescripts-future-commitments.mdx

@@ -16,7 +16,7 @@ description: |
 
 Our [new ReScript syntax announcement](/blog/bucklescript-8-1-new-syntax) generated lots of good feedback, but also raised some concerns from community members whose use-cases still align with our goal, but sometimes extend outside of it, and who are worried about further commitments to the ecosystem in the face of new unknowns.
 
-This post is dedicated to answer some commons questions regarding trust, breakages, and future investment.
+This post is dedicated to answer some common questions regarding trust, breakages, and future investment.
 
 ## Q & A
 

compilers/README.md

@@ -2,4 +2,4 @@
 
 This folder is needed to install additional rescript compiler versions for testing our documented source code on multiple compiler versions.
 
-Our `scripts/test-examples.js` script will automatically install all package.json dependencies if it cannot find any compiler versions.
+Our `scripts/test-examples.mjs` script will automatically install all package.json dependencies if it cannot find any compiler versions.