Merge branch 'master' into test-docstrings-examples

Author: aspeddro

.github/workflows/ci.yml

@@ -144,7 +144,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .nvmrc
 
       - name: Get artifact dir name
         run: node .github/workflows/get_artifact_dir_name.js
@@ -176,7 +176,7 @@ jobs:
           key: ${{ env.opam_cache_key }}
 
       - name: Use OCaml ${{matrix.ocaml_compiler}}
-        uses: ocaml/setup-ocaml@v3.1.4
+        uses: ocaml/setup-ocaml@v3.2.2
         if: steps.cache-opam-env.outputs.cache-hit != 'true'
         with:
           ocaml-compiler: ${{matrix.ocaml_compiler}}
@@ -253,11 +253,6 @@ jobs:
           fi
         shell: bash
 
-      # see https://github.com/ocaml/setup-ocaml/issues/815
-      - name: "Windows: set SHELLOPTS=igncr"
-        if: runner.os == 'Windows'
-        run: echo "SHELLOPTS=igncr" >>"$GITHUB_ENV"
-          
       - name: Build compiler
         if: runner.os != 'Linux'
         run: opam exec -- dune build --display quiet --profile release
@@ -353,7 +348,7 @@ jobs:
         with:
           path: ./tests/benchmark-cache
           key: syntax-benchmark-v1
- 
+
       - name: Create new benchmark data and comment on alert
         # Do not run for PRs created from other repos as those won't be able to write to the pull request
         if: ${{ matrix.benchmarks && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.event.repository.full_name) }}
@@ -374,7 +369,7 @@ jobs:
         with:
           path: ./tests/benchmark-cache
           key: syntax-benchmark-v1
-     
+
       - name: Build playground compiler
         if: matrix.build_playground
         run: |
@@ -411,7 +406,7 @@ jobs:
     needs:
       - build-compiler
       - build-rewatch
-  
+
     runs-on: ubuntu-latest
 
     steps:
@@ -421,7 +416,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .nvmrc
 
       - name: NPM install
         run: npm ci --ignore-scripts
@@ -481,7 +476,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .nvmrc
 
       - name: Download artifacts
         uses: actions/download-artifact@v4
@@ -515,7 +510,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .nvmrc
           registry-url: https://registry.npmjs.org # Needed to make auth work for publishing
 
       - name: Download artifacts

.nvmrc

@@ -0,0 +1 @@
+18

.ocamlformat-ignore

@@ -1,6 +1,5 @@
 compiler/js_parser/**
 compiler/ml/cmt_format.ml
-compiler/ml/pprintast.ml
 compiler/core/js_name_of_module_id.ml
 compiler/core/js_pass_debug.ml
 compiler/core/lam_util.ml

CHANGELOG.md

@@ -10,27 +10,38 @@
 > - :house: [Internal]
 > - :nail_care: [Polish]
 
-# 12.0.0-alpha.6 (Unreleased)
-- Fix exponential notation syntax. https://github.com/rescript-lang/rescript/pull/7174
+# 12.0.0-alpha.7 (Unreleased)
+
+#### :house: Internal
+
+- AST cleanup: use inline record for Pexp_fun. https://github.com/rescript-lang/rescript/pull/7213
+
+# 12.0.0-alpha.6
+
+#### :rocket: New Feature
+
 - Add `Option.all` & `Result.all` helpers. https://github.com/rescript-lang/rescript/pull/7181
-- Add `@react.componentWithProps` that explicitly handles the props with shared props: https://github.com/rescript-lang/rescript/pull/7203
+- Add `@react.componentWithProps` for React component functions taking a props record instead of labeled arguments. https://github.com/rescript-lang/rescript/pull/7203
 
 #### :bug: Bug fix
+
+- Fix exponential notation syntax. https://github.com/rescript-lang/rescript/pull/7174
 - Fix bug where a ref assignment is moved ouside a conditional. https://github.com/rescript-lang/rescript/pull/7176
 - Fix nullable to opt conversion. https://github.com/rescript-lang/rescript/pull/7193
 
 #### :house: Internal
+
 - Use latest compiler for tests. https://github.com/rescript-lang/rescript/pull/7186
 - Added infra to modernise AST: theres' Parsetree, Parsetree0 (legacy), and conversion functions to keep compatibility with PPX. https://github.com/rescript-lang/rescript/pull/7185
-- Ast cleanup: remove exp object and exp unreachable. https://github.com/rescript-lang/rescript/pull/7189
-- Ast cleanup: explicit representation for optional record fields in types. https://github.com/rescript-lang/rescript/pull/7190 https://github.com/rescript-lang/rescript/pull/7191
+- AST cleanup: remove exp object and exp unreachable. https://github.com/rescript-lang/rescript/pull/7189
+- AST cleanup: explicit representation for optional record fields in types. https://github.com/rescript-lang/rescript/pull/7190 https://github.com/rescript-lang/rescript/pull/7191
 - AST cleanup: first-class expression and patterns for records with optional fields. https://github.com/rescript-lang/rescript/pull/7192
 - AST cleanup: Represent the arity of uncurried function definitions directly in the AST. https://github.com/rescript-lang/rescript/pull/7197
 - AST cleanup: Remove Pexp_function from the AST. https://github.com/rescript-lang/rescript/pull/7198
 - Remove unused code from Location and Rescript_cpp modules. https://github.com/rescript-lang/rescript/pull/7150
 - Build with OCaml 5.2.1. https://github.com/rescript-lang/rescript-compiler/pull/7201
 - AST cleanup: Remove `Function$` entirely for function definitions. https://github.com/rescript-lang/rescript/pull/7200
-- AST cleanup: store arity in function type https://github.com/rescript-lang/rescript/pull/7195
+- AST cleanup: store arity in function type. https://github.com/rescript-lang/rescript/pull/7195
 - AST cleanup: remove explicit uses of `function$` in preparation for removing the type entirely. https://github.com/rescript-lang/rescript/pull/7206
 - AST cleanup: remove `function$` entirely. https://github.com/rescript-lang/rescript/pull/7208
 

analysis/README.md

@@ -12,15 +12,89 @@ See main CONTRIBUTING.md's repo structure. Additionally, `examples/` is a conven
 
 ## Usage
 
-At root:
-```sh
-./rescript-editor-analysis.exe --help
-
-# or
-
+```shell
 dune exec -- rescript-editor-analysis --help
 ```
 
 ## History
 
 This project is based on a fork of [Reason Language Server](https://github.com/jaredly/reason-language-server).
+
+## Tests
+
+### Prerequisites
+
+- Ensure the compiler is built (`make build` in the repository root).
+- Ensure the library is built (`make lib` in the repository root).
+
+### Running the Tests
+
+Run `make test` in `tests/analysis_tests/tests`.
+
+### Key Concept
+
+The tests in the `tests/analysis_tests/tests` folder are based on the `dune exec -- rescript-editor-analysis test` command. This special subcommand processes a file and executes specific editor analysis functionality based on special syntax found in code comments.
+
+Consider the following code:
+
+```res
+let a = 5
+// a.
+//   ^com
+```
+
+After building the ReScript project (**⚠️ this is a requirement**), you can execute `dune exec -- rescript-editor-analysis test Sample.res`, and completion will be performed for the cursor position indicated by `^`. The `com` directive requests completion. To see other commands, check out the pattern match in the `test` function in [Commands.ml](./src/Commands.ml).
+
+> [!WARNING]
+> Ensure there are no spaces in the code comments, as the commands are captured by a regular expression that expects spaces and not tabs!
+
+Here’s how it works: once a command is found in a comment, a copy of the source file is created inside a temporary directory, where the line above `^com` is uncommented. The corresponding analysis functionality is then processed, typically with `~debug:true`. With debug enabled, code paths like
+
+```ml
+if Debug.verbose () then
+      print_endline "[complete_typed_value]--> Tfunction #other";
+```
+
+will print to stdout. This is helpful for observing what happens during the analysis.
+
+When you run `make test` (from the `tests/analysis_tests` folder), `dune exec -- rescript-editor-analysis test <file>` will be executed for each `*.res` file in `analysis/tests/src`. The stdout will be compared to the corresponding `analysis/tests/src/expected` file. If `git diff` indicates changes, `make test` will fail, as these differences might be unintentional.
+
+## Testing on Your Own Projects
+
+To use a local version of `rescript-editor-analysis`, the targeted project needs to be compiled with the local compiler.
+
+Install your local ReScript with `npm i /path/to/your-local-rescript-repo`.
+Reinstall the dependencies and run `npx rescript` in your project. This ensures the project is compiled with the same compiler version that the `rescript-editor-analysis` will process.
+
+## Debugging
+
+It is possible to debug `analysis` via [ocamlearlybird](https://github.com/hackwaly/ocamlearlybird).
+
+1. Install `opam install earlybird`.
+2. Install the [earlybird extension](https://marketplace.visualstudio.com/items?itemName=hackwaly.ocamlearlybird).
+3. Create a launch configuration (`.vscode/launch.json`):
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug analysis",
+            "type": "ocaml.earlybird",
+            "request": "launch",
+            "program": "${workspaceFolder}/_build/default/analysis/bin/main.bc",
+            "stopOnEntry": true,
+            "cwd": "/projects/your-project",
+            "env": {
+                "CAML_LD_LIBRARY_PATH": "${workspaceFolder}/_build/default/compiler/ext"
+            },
+            "arguments": [
+                "test",
+                "src/Main.res"
+            ]
+        }
+    ]
+}
+```
+
+The `CAML_LD_LIBRARY_PATH` environment variable is required to tell OCaml where `dllext_stubs.so` can be loaded from.

analysis/src/CompletionFrontEnd.ml

@@ -1318,7 +1318,8 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
             match exprToContextPath lhs with
             | Some contextPath -> setResult (Cpath (CPObj (contextPath, label)))
             | None -> ())
-        | Pexp_fun (lbl, defaultExpOpt, pat, e, _) ->
+        | Pexp_fun
+            {arg_label = lbl; default = defaultExpOpt; lhs = pat; rhs = e} ->
           let oldScope = !scope in
           (match (!processingFun, !currentCtxPath) with
           | None, Some ctxPath -> processingFun := Some (ctxPath, 0)

analysis/src/DumpAst.ml

@@ -213,7 +213,7 @@ and printExprItem expr ~pos ~indentation =
       | None -> ""
       | Some expr -> "," ^ printExprItem expr ~pos ~indentation)
     ^ ")"
-  | Pexp_fun (arg, _maybeDefaultArgExpr, pattern, nextExpr, _) ->
+  | Pexp_fun {arg_label = arg; lhs = pattern; rhs = nextExpr} ->
     "Pexp_fun(\n"
     ^ addIndentation (indentation + 1)
     ^ "arg: "

analysis/src/Hint.ml

@@ -61,7 +61,7 @@ let inlay ~path ~pos ~maxLength ~debug =
            | Pexp_apply _ | Pexp_match _ | Pexp_construct _ | Pexp_ifthenelse _
            | Pexp_array _ | Pexp_ident _ | Pexp_try _ | Pexp_lazy _
            | Pexp_send _ | Pexp_field _ | Pexp_open _
-           | Pexp_fun (_, _, _, _, Some _) );
+           | Pexp_fun {arity = Some _} );
        };
     } ->
       push vb.pvb_pat.ppat_loc Type

analysis/src/Xform.ml

@@ -261,7 +261,7 @@ module AddBracesToFn = struct
         | _ -> false
       in
       (match e.pexp_desc with
-      | Pexp_fun (_, _, _, bodyExpr, _)
+      | Pexp_fun {rhs = bodyExpr}
         when Loc.hasPos ~pos bodyExpr.pexp_loc
              && isBracedExpr bodyExpr = false
              && isFunction bodyExpr = false ->
@@ -303,9 +303,9 @@ module AddTypeAnnotation = struct
     in
     let rec processFunction ~argNum (e : Parsetree.expression) =
       match e.pexp_desc with
-      | Pexp_fun (argLabel, _, pat, e, _) ->
+      | Pexp_fun {arg_label; lhs = pat; rhs = e} ->
         let isUnlabeledOnlyArg =
-          argNum = 1 && argLabel = Nolabel
+          argNum = 1 && arg_label = Nolabel
           &&
           match e.pexp_desc with
           | Pexp_fun _ -> false

compiler/common/bs_version.ml

@@ -21,6 +21,6 @@
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
-let version = "12.0.0-alpha.6"
+let version = "12.0.0-alpha.7"
 let header = "// Generated by ReScript, PLEASE EDIT WITH CARE"
 let package_name = ref "rescript"