Skip to content

Commit f0ba4b2

Browse files
committed
docs: add node16 import convention, Node.js requirement, and missing structure entries
Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent 2764301 commit f0ba4b2

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Patchloom for VS Code is the official VS Code extension for [Patchloom](https://
1313
| `npm run watch` | Watch mode for extension source |
1414
| `npm run test:unit` | Run unit tests (`node --test ./out-test/test/unit/*.test.js`) |
1515
| `npm run test:extension` | Run VS Code extension integration tests |
16+
| `npm run test:ui` | Run ExTester UI tests (downloads VS Code if needed) |
17+
| `npm run test:all` | Compile + unit tests + extension integration tests |
1618
| `npm run test` | Compile + compile-tests + unit tests |
1719
| `npm run package` | Package the `.vsix` using `@vscode/vsce` |
1820
| `npm run check` | Full CI gate: test + package |
@@ -49,6 +51,10 @@ test/
4951
suite/
5052
index.ts VS Code extension integration tests
5153
runExtensionTests.ts Test runner using @vscode/test-electron
54+
ui/
55+
extension.test.ts ExTester UI tests (status bar, command palette)
56+
scripts/
57+
hide-test-vscode.sh macOS: patch test VS Code to suppress window activation
5258
```
5359

5460
## Architecture conventions
@@ -89,4 +95,5 @@ All I/O-dependent functions accept an `inputs` object with injectable callbacks
8995
- Pure helpers with injected I/O for testability.
9096
- Keep `extension.ts` thin. No business logic in the entrypoint.
9197
- `npm run check` is the full gate. Nothing merges unless it passes.
98+
- All relative imports must use `.js` extensions (`from "./foo.js"`, not `from "./foo"`). Required by `moduleResolution: "node16"`.
9299
- All commits require a `Signed-off-by` line (DCO). Use `git commit -s`.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,13 @@ File bugs and feature requests at [patchloom/patchloom-vscode/issues](https://gi
126126

127127
## Contributing
128128

129+
Requires Node.js 20 or newer.
130+
129131
```bash
130132
npm install
131-
npm run compile
132-
npm test
133+
npm run check # full gate: compile + test + package
133134
```
134135

135136
Open the repo in VS Code and press `F5` to launch the Extension Development Host.
136137

137-
Package with `npm run package` (creates a `.vsix` using `@vscode/vsce`).
138+
Run `npm run check` before every commit. It compiles, runs all unit tests, and packages the `.vsix`.

0 commit comments

Comments
 (0)