Add Linux installation E2E tests across package managers

.github/workflows/ci.yml

@@ -93,8 +93,78 @@ jobs:
           npm i -g ${{ needs.build.outputs.artifact_filename }}
           npx create-rescript-app
 
+  e2e:
+    name: E2E (${{ matrix.manager }})
+    needs: build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 25
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - manager: npm
+            package: ""
+          - manager: pnpm
+            package: pnpm@10.11.0
+          - manager: yarn-classic
+            package: yarn@1.22.22
+          - manager: yarn-berry
+            package: "@yarnpkg/cli-dist@4.9.2"
+          - manager: bun
+            package: ""
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.19.0 # minimum supported version
+
+      - name: Install package manager
+        if: matrix.package != ''
+        env:
+          PACKAGE: ${{ matrix.package }}
+        run: |
+          npm install --prefix "$RUNNER_TEMP/e2e-tools" "$PACKAGE"
+          echo "$RUNNER_TEMP/e2e-tools/node_modules/.bin" >> "$GITHUB_PATH"
+
+      - name: Install Bun
+        if: matrix.manager == 'bun'
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.3.11
+
+      - name: Download packed CLI
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.build.outputs.artifact_filename }}
+
+      - name: Install harness build dependencies
+        run: npm ci
+
+      - name: Install, compile and run real projects
+        env:
+          PACKAGE: ${{ needs.build.outputs.artifact_filename }}
+          MANAGER: ${{ matrix.manager }}
+        run: >-
+          npm run test:e2e --
+          --package "$PACKAGE"
+          --manager "$MANAGER"
+          --logs "$RUNNER_TEMP/cra-e2e-logs"
+
+      - name: Upload failure logs
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-${{ matrix.manager }}-logs
+          path: ${{ runner.temp }}/cra-e2e-logs
+          if-no-files-found: ignore
+
   publish:
-    needs: [build, test]
+    needs: [build, test, e2e]
 
     if: startsWith(github.ref, 'refs/tags/v')
 

AGENTS.md

@@ -6,13 +6,24 @@
 
 ## Coding Style & Naming Conventions
 
-- Make sure to use modern ReScript and not Reason syntax! Read https://rescript-lang.org/llms/manual/llm-small.txt to learn the language syntax.
+- Use ReScript 12 syntax and the built-in standard library, not Reason syntax. Read https://rescript-lang.org/llms/manual/llm-small.txt to learn the language syntax.
+- Prefer `Option`, `Result`, `Array`, `List`, `Dict`, `Set`, `Map`, and `JSON` over `Js.*` or `Belt.*`.
+- Prefer `dict{...}` patterns for known dictionary keys and nested JSON shapes; use `Dict.get` for dynamic keys.
+- Match `Nullable.t` directly with `Value`, `Null`, and `Undefined`, and use `Nullable.getOr` for defaults instead of converting to `option`.
+- Match local style; avoid old BuckleScript/ReScript-era patterns.
+- Write new tests and test helpers in ReScript under `test/`. Prefer records and functions over classes.
+- Reuse existing application types in tests instead of redefining them.
+- Keep parameters mandatory unless callers need to omit them.
+- Do not add redundant parentheses around switch expressions: use `switch value { ... }`. Parentheses required by tuple syntax are fine.
 - Formatting is enforced by `rescript format`; keep 2-space indentation and prefer pattern matching over chained conditionals.
+- Separate multiline `let` bindings (including `let?`) and type definitions from surrounding statements or declarations with a blank line before and after. Keep attached comments and attributes together with the declaration.
 - Prefer `result` values over exceptions for expected failure paths; only raise or throw at clear integration boundaries where the surrounding API requires it.
+- Use `let?` to unwrap and propagate `Option`/`Result` failures where it simplifies the code. `LetUnwrap` is enabled in `rescript.json`.
 - Prefer pattern matching over `if`/`else` chains when branching on the shape or state of the same value; plain comparisons across different values are fine with `if`/`else`.
 - Do not run `rescript`, `npm test`, or `npm run prepack` in parallel; ReScript compiler artifacts are not safe for concurrent builds in this repo.
-- Module files are PascalCase (`Templates.res`), values/functions camelCase, types/variants PascalCase, and records snake_case fields only when matching external JSON.
+- Module files and variant constructors are PascalCase (`Templates.res`), values/functions and type names camelCase, and records use snake_case fields only when matching external JSON.
 - Keep `.resi` signatures accurate and minimal; avoid exposing helpers that are template-specific.
+- Keep raw Node.js bindings in `src/bindings/Node.res`. Put exception-to-result/option wrappers in `src/bindings/NodeSafe.res`, using small concrete helpers.
 - When touching templates, mirror upstream defaults and keep package scripts consistent with the chosen toolchain.
 
 ## Package Manager Support
@@ -40,6 +51,7 @@
 ## Testing and Validation
 
 - **Automated Tests**: Run `npm test` for automated coverage of CLI parsing and related helpers
+- **Installation E2E**: Run `npm pack`, then `npm run test:e2e -- --package <tarball> --manager <manager> --logs <directory>`. Requires Linux, util-linux `script`, and the selected package manager; use the versions in `.github/workflows/ci.yml`.
 - **Manual Testing**: Perform smoke tests by running the CLI into a temp directory
 - **CI Preview Testing**: To test a pkg.pr.new build from CI, run `npm exec --yes --package=https://pkg.pr.new/rescript-lang/create-rescript-app/create-rescript-app@<commit> -- create-rescript-app my-app --template vite` and replace `<commit>` with the SHA from the pkg.pr.new CI comment.
 - **Template Validation**: After changes, test each template type (basic/Next.js/Vite) to ensure templates bootstrap cleanly

package.json

@@ -7,6 +7,7 @@
     "start": "node src/Main.res.mjs",
     "prepack": "rescript && rollup -c",
     "test": "rescript && node --test test/*Test.res.mjs test/*Test.mjs",
+    "test:e2e": "rescript && node test/e2e/E2eMain.res.mjs",
     "format": "rescript format",
     "dev": "rescript -w"
   },
@@ -44,7 +45,7 @@
     "@vitejs/plugin-react": "^6.0.1",
     "compare-versions": "^6.1.0",
     "jsonc-parser": "^3.3.1",
-    "rescript": "^12.0.0",
+    "rescript": "^12.3.1",
     "rollup": "^4.53.3",
     "typescript": "^5.9.3",
     "vite": "^8.0.10"

rescript.json

@@ -15,5 +15,8 @@
     "module": "esmodule",
     "in-source": true
   },
-  "suffix": ".res.mjs"
+  "suffix": ".res.mjs",
+  "experimental-features": {
+    "LetUnwrap": true
+  }
 }

src/NewProjectLocation.res

@@ -32,7 +32,7 @@ let hasDevcontainerDirectory = projectPath =>
   try {
     Path.join2(projectPath, devcontainerDirectoryName)->Fs.statSync->Fs.Stats.isDirectory
   } catch {
-  | Exn.Error(_) => false
+  | JsExn(_) => false
   }
 
 let containsOnlyDevcontainerDirectory = projectPath =>
@@ -42,7 +42,7 @@ let containsOnlyDevcontainerDirectory = projectPath =>
     | _ => false
     }
   } catch {
-  | Exn.Error(_) => false
+  | JsExn(_) => false
   }
 
 let isAllowedCurrentDirectoryEntry = (~cwd, entry) => {

src/NpmRegistry.res

@@ -14,7 +14,7 @@ let defaultRegistryUrl = "https://registry.npmjs.org"
 
 let getNpmRegistry = () =>
   npm_config_registry
-  ->Option.flatMap(registry => registry->Node.Url.make)
+  ->Option.flatMap(registry => registry->NodeSafe.Url.make)
   ->Option.mapOr(defaultRegistryUrl, url => url->Node.Url.href)
 
 type fetchError =