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

Author: aspeddro

.github/workflows/pull-request.yml

@@ -2,7 +2,6 @@ name: Test
 on: [pull_request]
 jobs:
   build:
-    name: Test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -12,3 +11,6 @@ jobs:
       - run: npm ci
       - run: npx rescript
       - run: npm test
+
+      - name: Format check
+        run: npx rescript format -check -all

.gitignore

@@ -9,6 +9,11 @@ node_modules/
 .next/
 index_data/*.json
 
+# Generated via test examples script
+_tempFile.cmi
+_tempFile.cmj
+_tempFile.cmt
+
 # these docs are checked in, but we consider them frozen.
 pages/docs/manual/v8.0.0/
 pages/docs/manual/v9.0.0/
@@ -19,3 +24,5 @@ lib/
 .vscode/
 
 .vercel
+
+src/**/*.mjs

CONTRIBUTING.md

@@ -30,17 +30,17 @@ If you need inspiration on what to work on, you can check out issues tagged with
 
 We really appreciate all input from users, community members and potential contributors. Please make sure to consider the other person's opinion and don't assume any common knowledge.
 
-**Most importantly: Keep it professional and be nice to eachother**
+**Most importantly: Keep it professional and be nice to each other**
 
-There might be situations where others don't understand a proposed feature or have different opinions on certain writing styles. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always to stick to the original topic.
+There might be situations where others don't understand a proposed feature or have different opinions on certain writing styles. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always stick to the original topic.
 
 If other contributors disagree with certain proposals and don't change their mind after longer discussions, please don't get discouraged when an issue gets closed / postponed. Everyone tries their best to make the platform better, and to look at it in another perspective: Closed issues are also a highly valuable resource for others to understand technical decisions later on.
 
 ### Communicate your Time Commitment
 
 Open Source development can be a challenge to coordinate, so please make sure to block enough time to work on your tasks and show commitment when taking on some work. Let other contributors know if your time schedule changes significantly, and also let others know if you can't finish a task.
 
-We value your voluntary work, and of course it's fine to step back from a ticket for any reasons (we can also help you if you are getting stuck). Please talk to us in any case, otherwise we might re-assign the ticket to other contributors.
+We value your voluntary work, and of course it's fine to step back from a ticket for any reason (we can also help you if you are getting stuck). Please talk to us in any case, otherwise we might re-assign the ticket to other contributors.
 
 ### Communication Channels
 
@@ -66,7 +66,7 @@ Always check if there are any designs for certain UI components and think about
 ### Technical Writing (Documentation)
 
 - Think and write in a JS friendly mindset when explaining concepts / showing examples.
-- No `foo` examples if somewhat possible. Try to establish practical context in your show case examples.
+- No `foo` examples if somewhat possible. Try to establish practical context in your showcase examples.
 - No references to `OCaml`. ReScript is its own language, and we don't rely on external resources of our host language.
 - If possible, no references to `Reason` examples / external resources. Our goal is to migrate everything to ReScript syntax.
 

Makefile

@@ -0,0 +1,22 @@
+SHELL = /bin/bash
+
+node_modules/.bin/rescript:
+	npm install
+	npm run update-index
+
+build: node_modules/.bin/rescript	
+	node_modules/.bin/rescript
+	npm run update-index
+
+dev: build
+	npm run dev
+
+test: build
+	npm run test
+
+clean:
+	rm -r node_modules lib
+
+.DEFAULT_GOAL := build
+
+.PHONY: clean test

README.md

@@ -6,9 +6,7 @@
 
 This is the official documentation platform for the [ReScript](https://rescript-lang.org) programming language.
 
-**In case you want to report a technical issue, please refer to the appropriate repository:**
-- [rescript-compiler](https://github.com/rescript-lang/rescript-compiler): The compiler and build system
-- [rescript-syntax](https://github.com/rescript-lang/syntax): The ReScript syntax
+**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
@@ -17,21 +15,21 @@ This is the official documentation platform for the [ReScript](https://rescript-
 
 ## System Requirements
 
-- `node@12.22.1` or higher (for ES6 module compat)
-- `npm@7` (package-lock v2)
+- `node@16.x` or higher (for ES6 module compat)
+- `npm@7` or higher (package-lock v2)
 
 ## Setup
 
 ```sh
 # For first time clone / build (install dependencies)
 npm i
 
-# Only needed for initial clone (or content H2 changes)
-npm run update-index
-
 # Initial build
 npx rescript
 
+# Only needed for initial clone (or content H2 changes)
+npm run update-index
+
 # Build the index data
 npm run update-index
 
@@ -91,7 +89,7 @@ We check the validity of our code examples marked with:
 Run the checks with:
 
 ```sh
-node scripts/test-examples.js
+node scripts/test-examples.mjs
 ```
 
 ### Markdown Hyperlink Tests
@@ -117,10 +115,10 @@ Here is an example on how to run the tests:
 
 ```sh
 # Tests all files
-node scripts/test-hrefs.js
+node scripts/test-hrefs.mjs
 
 # Or just a subset (glob pattern)
-node scripts/test-hrefs.js "pages/docs/manual/**/*.mdx"
+node scripts/test-hrefs.mjs "pages/docs/manual/**/*.mdx"
 ```
 
 ### Continous Integration
@@ -153,6 +151,15 @@ NODE_ENV=production npx postcss styles/main.css -o test.css
 
 In case you are a blog author, please refer to our [guide on writing blog posts](https://rescript-lang.org/blogpost-guide).
 
+## How to Add Your Company Logo to Our Front Page
+
+In case your company is a user of ReScript and wants to be displayed on our front page ("Trusted by our users" section), do the following:
+
+- Get your logo as a black / white `.svg` version and use `#979AAD` as a fill color (check out the existing logos on our front page).
+- Put your logo into the [`public/static/lp`](./public/static/lp) folder; the file should be named after your company.
+- Open [src/common/OurUsers.res](./src/common/OurUsers.res) and add your info
+- Commit, push, and open a PR.
+
 ### Contributing
 
 Please make sure to first read and comply to our [Code of Conduct](CODE_OF_CONDUCT.md) and check out our [CONTRIBUTING.md](CONTRIBUTING.md) file to learn how to get started with our contribution process!

_blogposts/2021-02-09-release-9-0.mdx

@@ -17,7 +17,7 @@ ReScript is a robustly typed language that compiles to efficient and human-reada
 Use `npm` to install the newest [9.0.1 release](https://www.npmjs.com/package/bs-platform/v/9.0.1) with the following command:
 
 ```
-npm install bs-platform@9.0.1 --save-dev
+npm install bs-platform@9.0.1
 ```
 
 You can also try our new release in the [Online Playground](/try).

_blogposts/2021-03-03-rescript-association-rebranding.mdx

@@ -45,7 +45,7 @@ Furthermore, we serve as a communication channel for our partners and donors.
 
 High quality, long-term Open Source work doesn’t come from some good words and pats on the back. While we do try to be efficient, past a certain point, big amounts of time and financial resources are needed to keep up the momentum for maintaining and developing the platform. To this end, we regularly raise donations to make sure that the running costs are covered, and Open Source contributors paid.
 
-If your company relies on the ReScript platform for building commercial products, please consider supporting our efforts by [sending a donation](https://rescript-association.org/donate). It’s the best way to future proof your product’s foundation. Alternatively, you can sponsor individual members like [ryyppy](https://github.com/sponsors/ryyppy/) on Github Sponsors.
+If your company relies on the ReScript platform for building commercial products, please consider supporting our efforts by [sending a donation](https://rescript-association.org/donate). It’s the best way to future proof your product’s foundation. Alternatively, you can sponsor individual members like [ryyppy](https://github.com/sponsors/ryyppy/) on GitHub Sponsors.
 
 We want to take this opportunity to thank our previous and active sponsors:
 - [Tezos Foundation](https://tezos.foundation) (2020-21)

_blogposts/2022-08-25-release-10-0-0.mdx

@@ -0,0 +1,91 @@
+---
+author: rescript-team
+date: "2022-08-25"
+previewImg: static/blog/grid_0.jpeg
+title: ReScript 10.0
+badge: release
+description: |
+  The first community powered release.
+---
+
+ReScript version 10 is available! Version 10 is a culmination of over a year's worth of work, bringing faster builds, improving JS interop, and including a bunch of bug fixes. It's also the first fully community powered release, with contributions from over 20 community members.
+
+```
+npm install rescript@10
+```
+
+All changes are listed [here](https://github.com/rescript-lang/rescript-compiler/blob/10.0_release/CHANGELOG.md). Let's take a tour of a few of the features we're extra excited about.
+
+## Faster builds with native M1 support
+Users with M1 chips should see a notable speedup, as the new ReScript version has full native support for M1.
+
+## Better ergonomics with Unicode support in regular strings
+You can now use Unicode characters directly in regular strings. This will now produce what you'd expect:
+```res
+let str = "Σ"
+```
+
+You can also pattern match on Unicode characters:
+```res
+switch someCharacter { 
+  | 'Σ' => "what a fine Unicode char" 
+  | _ => "Unicode is fun" 
+}
+```
+
+## Experimental optional record fields
+Previously, a record would always have to define all its optional fields:
+```res
+type user = {
+  name: string,
+  age: option<int>
+}
+
+let userWithoutAge = {
+  name: "Name",
+  age: None,
+}
+
+let userWithAge = {
+  name: "Name",
+  age: Some(34),
+}
+```
+For small records like the one above, this is typically fine. But for records with many fields, the friction of having to always set all optional fields explicitly adds up. This release has a new experimental feature called optional record fields, allowing you to rewrite the above to this instead:
+
+```res
+type user = {
+  name: string,
+  age?: int
+}
+
+// No need to set `age` unless it should have a value
+let userWithoutAge = {
+  name: "Name",
+}
+
+let userWithAge = {
+  name: "Name",
+  age: 34
+}
+```
+
+Other than drastically improving the experience when working with large records with optional fields, this also has implications for bindings. For example, binding to JS APIs with large configuration objects is now more ergonomic.
+This feature also paves the way for other exciting features coming in the next release, such as a more idiomatic representation of React components.
+
+## What's next
+
+Version 10 brings the building blocks needed for a number of exciting new features that'll be available in the next version. Features ranging from native support for async/await, to a new version of the JSX integration, making it leaner and more flexible. You'll hear more about this soon.
+
+## Upgrade guide
+
+Please see the detailed [changelog](https://github.com/rescript-lang/rescript-compiler/blob/10.0_release/CHANGELOG.md) for a list of breaking changes.
+Each breaking change lists suggestions on how to upgrade your project.
+This can be out of your control in case of dependencies. In that case, please raise issues with the maintainers of those libraries.
+
+One special word for PPXs, in particular for PPX authors: As mentioned in the changelog, some PPXs may give an error `"Attributes not allowed here"`. The solution is to adapt the PPXs following the example of `rescript-relay` in https://github.com/zth/rescript-relay/pull/372.
+
+## Acknowledgements
+
+We would like to thank everyone from the community who volunteered their precious time to suport this project with contributions of any kind, from documentation, to PRs, to discussions in the forum.
+In particular, thank you [@cknitt](https://github.com/cknitt), [@TheSpyder](https://github.com/TheSpyder), [@mattdamon108](https://github.com/mattdamon108), [@DZakh](https://github.com/DZakh), [@fhammerschmidt](https://github.com/fhammerschmidt), [@amiralies](https://github.com/amiralies), [@Minnozz](https://github.com/Minnozz), [@Zeta611](https://github.com/Zeta611), [@jchavarri](https://github.com/jchavarri), [@nkrkv](https://github.com/nkrkv), [@whitchapman](https://github.com/whitchapman), [@ostera](https://github.com/ostera), [@benadamstyles](https://github.com/benadamstyles), [@cannorin](https://github.com/cannorin), [@ClaireNeveu](https://github.com/ClaireNeveu), [@kevinbarabash](https://github.com/kevinbarabash), [@JsonKim](https://github.com/JsonKim), [@Sehun0819](https://github.com/Sehun0819), [@glennsl](https://github.com/glennsl), [@namenu](https://github.com/namenu), [@a-c-sreedhar-reddy](https://github.com/a-c-sreedhar-reddy).