📝 Sweep doc and formatter drift
README named --experimental-strip-types, which was renamed to --strip-types. Document the current flag only. The extension recommendations list is unchanged, but the VSCode section undercounted it and now matches extensions.json. The per-language formatter blocks in .vscode/settings.json stay (they keep a user's local formatter settings from overriding the project's) and gain the JSX/TSX language ids to match what oxfmt and the lefthook glob cover.
This commit is contained in:
1 parent
1709fbe842
commit
e86709f593
3 files changed
+14
-6
No files matched your search
Vendored
+8
@@ -3,10 +3,18 @@
|
|||||||
"editor.defaultFormatter": "oxc.oxc-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true
|
"editor.formatOnSave": true
|
||||||
},
|
},
|
||||||
|
"[typescriptreact]": {
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
"[javascript]": {
|
"[javascript]": {
|
||||||
"editor.defaultFormatter": "oxc.oxc-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true
|
"editor.formatOnSave": true
|
||||||
},
|
},
|
||||||
|
"[javascriptreact]": {
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
"[json]": {
|
"[json]": {
|
||||||
"editor.defaultFormatter": "oxc.oxc-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true
|
"editor.formatOnSave": true
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ What each tier runs, when it fires and what it costs:
|
|||||||
### Tooling
|
### Tooling
|
||||||
|
|
||||||
- **TypeScript 7** — type checker and build (`tsc`).
|
- **TypeScript 7** — type checker and build (`tsc`).
|
||||||
- **node --test** + `--experimental-strip-types` — test runner (Node 22.6+, flag dropped on Node 24).
|
- **node --test** + `--strip-types` — test runner.
|
||||||
- **c8** — code coverage for `test:ci`.
|
- **c8** — code coverage for `test:ci`.
|
||||||
- **oxlint** — Rust-based linter, with type-aware rules powered by **oxlint-tsgolint** (typescript-go).
|
- **oxlint** — Rust-based linter, with type-aware rules powered by **oxlint-tsgolint** (typescript-go).
|
||||||
- **oxfmt** — Rust-based formatter (Prettier-compatible). Formats JS/TS, JSON/JSONC, YAML, Markdown, MDX, and more; built-in `package.json` key sorting replaces `sort-package-json`.
|
- **oxfmt** — Rust-based formatter (Prettier-compatible). Formats JS/TS, JSON/JSONC, YAML, Markdown, MDX, and more; built-in `package.json` key sorting replaces `sort-package-json`.
|
||||||
@@ -55,9 +55,9 @@ The choice and configuration of each tool above is the result of deliberate trad
|
|||||||
|
|
||||||
## VSCode integration
|
## VSCode integration
|
||||||
|
|
||||||
- Recommended extensions: see `.vscode/extensions.json` (oxc, cspell).
|
- Recommended extensions: see `.vscode/extensions.json` (oxc, cspell, TypeScript native-preview, EditorConfig, todo-tasks).
|
||||||
- TypeScript 7 is used via the `typescriptteam.native-preview` extension.
|
- TypeScript 7 is used via the `typescriptteam.native-preview` extension.
|
||||||
- oxc extension provides oxlint squiggles and oxfmt format-on-save.
|
- oxc extension provides oxlint squiggles and oxfmt format-on-save; `.vscode/settings.json` pins it per language so a user's local `[language]` formatter settings cannot override the project's choice.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -48,9 +48,9 @@ Setup:
|
|||||||
☐ Resolve sourcemap sources for consumers
|
☐ Resolve sourcemap sources for consumers
|
||||||
- `dist/*.map` `sources` are `../src/*.ts`, but `src` is not in `files`, so debuggers get missing sources
|
- `dist/*.map` `sources` are `../src/*.ts`, but `src` is not in `files`, so debuggers get missing sources
|
||||||
☐ Ship `src`, or disable `sourceMap`/`declarationMap` for the published artifact
|
☐ Ship `src`, or disable `sourceMap`/`declarationMap` for the published artifact
|
||||||
☐ Sweep doc/formatter drift before v1.0
|
✔ Sweep doc/formatter drift before v1.0 @done
|
||||||
☐ README says `--experimental-strip-types`; scripts use `--strip-types`
|
✔ README says `--experimental-strip-types`; scripts use `--strip-types` @done
|
||||||
☐ `.vscode/settings.json` bundles `[markdown]`/`[yaml]` oxfmt formatters separately from `.oxfmtrc.json`'s `ignorePatterns` — align
|
✔ `.vscode/settings.json` bundles `[markdown]`/`[yaml]` oxfmt formatters separately from `.oxfmtrc.json`'s `ignorePatterns` — align @done
|
||||||
✔ Document branching model @done
|
✔ Document branching model @done
|
||||||
✔ Describe branching model: when to branch, base branch, naming @done
|
✔ Describe branching model: when to branch, base branch, naming @done
|
||||||
✔ Clarify release workflow: who pushes `main`, CI as post-merge gate, drop PR usage @done (9/8/2026, 2:54:32 PM)
|
✔ Clarify release workflow: who pushes `main`, CI as post-merge gate, drop PR usage @done (9/8/2026, 2:54:32 PM)
|
||||||
|
|||||||
Reference in new issue
Block a user