Skip to content

Commit 5fee579

Browse files
committed
refactor: revert
1 parent 642badb commit 5fee579

1 file changed

Lines changed: 6 additions & 34 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,11 @@ npm install
1616

1717
This table provides a quick overview of the environmental setup, with detailed explanations in the corresponding sections.
1818

19-
| Feature | Local Default | CI Default | Description |
20-
| ------------------------------- | ------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
21-
| `NODE_OPTIONS` **⚙️** | Set in `.env.local` | Set globally in workflows | `--import tsx` - Enables TypeScript execution for local Nx plugins and generators. **Required for development.** |
22-
| `TSX_TSCONFIG_PATH` **⚙️** | Set in `.env.local` | Set globally in workflows | `tsconfig.base.json` - Resolves TypeScript path aliases for local packages. **Required for development.** |
23-
| `env.INCLUDE_SLOW_TESTS` **❗️** | `false` | `true` | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section. |
24-
| `env.CUSTOM_CHROME_PATH` | N/A | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
25-
| Quality Pipeline | Off | On | Runs all plugins against the codebase. |
26-
27-
**⚙️** TypeScript Execution Setup (Required)
28-
29-
This project uses local Nx plugins and generators written in TypeScript. To run them, you need:
30-
31-
1. **Create `.env.local`** (gitignored, local-only):
32-
33-
```sh
34-
cp .env.local.example .env.local
35-
```
36-
37-
2. **The file includes** (already configured in the example):
38-
39-
```sh
40-
NODE_OPTIONS=--import tsx
41-
TSX_TSCONFIG_PATH=tsconfig.base.json
42-
```
43-
44-
3. **Why these are needed**:
45-
- `NODE_OPTIONS` - Allows importing TypeScript files with `.js` extensions (used throughout the repo)
46-
- `TSX_TSCONFIG_PATH` - Enables path aliases like `@code-pushup/models` in generators/executors
47-
48-
4. **CI Configuration**:
49-
- Both variables are set at the **job or step level** in all GitHub Actions workflows
50-
- Applied after `npm ci` to ensure `tsx` is installed before Node tries to import it
51-
- Ensures consistent behavior between local development and CI
19+
| Feature | Local Default | CI Default | Description |
20+
| ------------------------------- | ------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
21+
| `env.INCLUDE_SLOW_TESTS` **❗️** | `false` | `true` | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section. |
22+
| `env.CUSTOM_CHROME_PATH` | N/A | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
23+
| Quality Pipeline | Off | On | Runs all plugins against the codebase. |
5224

5325
**❗️** Test Inclusion Logic
5426

@@ -94,7 +66,7 @@ Some of the plugins have a longer runtime. In order to ensure better DX, longer
9466

9567
You can control the execution of long-running tests over the `INCLUDE_SLOW_TESTS` environment variable.
9668

97-
To change this setup, open your `.env.local` file in the root folder (or copy from `.env.local.example` if it doesn't exist).
69+
To change this setup, open (or create) the `.env` file in the root folder.
9870
Edit or add the environment variable there as follows: `INCLUDE_SLOW_TESTS=true`.
9971

10072
## Git

0 commit comments

Comments
 (0)