🔀 Merge chore/prune-backlog-and-upgrade-deps into main

This commit is contained in:
tmu committed 2026-09-28 21:59:57 +00:00
commit 21b628f91d
7 files changed
+396 -391

No files matched your search

+1 -1
View File
@@ -1,3 +1,3 @@
{ {
"packages": ["npm:@spences10/pi-lsp@0.0.46"] "packages": ["npm:@spences10/pi-lsp@0.0.47"]
} }
+6
View File
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
- upgrade dependencies: oxfmt 0.71 (the only range widened), oxlint 1.86,
oxlint-tsgolint 7.0.2003, cspell 10.3.5 and the rest within their existing
ranges; no rule or format fallout
- prune the completed items from the backlog; their rationale already lives in
the README, `development/` and the released changelog entries
## [0.8.2] - 2026-09-25 ## [0.8.2] - 2026-09-25
- write the README's Synopsis and Examples sections - write the README's Synopsis and Examples sections
-24
View File
@@ -7,32 +7,8 @@ Backlog and tracking for tiny-pattern-ts. Managed in vscode-todotasks format.
Setup: Setup:
☐ Split off template into separate package => pi --session 01a07dde-7050-7054-bb36-1606d7eb2bc3 @low ☐ Split off template into separate package => pi --session 01a07dde-7050-7054-bb36-1606d7eb2bc3 @low
v1.0:
✔ API surface is stable and fully typed @done
✔ Finalize public exports in `src/index.ts` @done
✔ Document all exported types and functions @done
✔ Add JSDoc for public APIs @done
✔ Test coverage meets threshold @done
✔ Achieve 100% branch coverage on `src/primitive-union.ts` @done
✔ Achieve 100% branch coverage on `src/index.ts` @done
Matcher:
✔ when using a union type as a property, the current behavior of tagged union matcher is @done
to pass never to handler parameters
→ new matcher function needed or can be fixed in tagged union matcher
✔ optional discriminant (`{ type?: "x" }`) is the same hole: the boolean/nullish change now admits the `undefined` tag, so the factory accepts the key, but `Extract<T, Record<K, V>>` still passes `never` to both the `x` and `undefined` handlers @done
Documentation: Documentation:
✔ Bring README.md back to its previous form — synopsis and examples restored, in the correct place @done
→ previous section order: title, tagline, Synopsis, Description, Requirements, Examples, API, License, Contributing
→ previous Examples order: literal/exhaustive, typeof, structural/discriminated unions, when, any
☐ Create `examples/` directory with runnable snippets ☐ Create `examples/` directory with runnable snippets
✔ Add comparison section vs. other TS pattern-matching libs in Readme.md @done
✔ Why do we do this? => exhaustiveness encoded type safe @done
✔ Why this form? little syntax, data last, very small, autocomplete, strict typing in the handler; for more features use ts-pattern @done
✔ Write migration guide for users coming from discriminated unions @done (9/24/2026, 10:21:17 PM)
✔ Create backlog tasks for implementation @done (9/24/2026, 10:21:16 PM)
✔ Validate code fences in Markdown (start with README.md) — compile the TypeScript examples against `src/` so the docs cannot drift from the API @done
Maintenance: Maintenance:
☐ Serve CI coverage over a tiny self-hosted webserver (replace the zip artifact) @low ☐ Serve CI coverage over a tiny self-hosted webserver (replace the zip artifact) @low
+13 -12
View File
@@ -196,27 +196,28 @@ joining the oxfmt-superseded rules already off.
are part of the public API. are part of the public API.
- The narrower scope keeps the signal high without config-file boilerplate. - The narrower scope keeps the signal high without config-file boilerplate.
### `knip` lists `src/index.ts` as an entry ### `knip` does not list the library entry
#### Decision (2026-09) #### Decision (2026-09)
`knip.json` declares `"entry": ["src/index.ts", "scripts/*.ts"]`. `knip.json` declares `"entry": ["scripts/*.ts"]`; the library entry
`src/index.ts` is not listed.
#### Why #### Why
- Supplying `entry` **replaces** knip's default entry detection, which otherwise - knip derives the public entry from `package.json` `exports` and resolves it to
derives the public entry from `package.json` `exports`. Adding `scripts/*.ts` `src/index.ts` itself, so naming the file is a redundant pattern and
there therefore dropped the library entry, so knip resolved the package through `maintain:knip` reports it as a configuration hint.
its `dist/index.js` output and reported the unreferenced source entry file - Listing `scripts/*.ts` does not switch that derivation off: the scope stays
`src/index.ts` as an unused file. clean with or without `dist/`, and with the barrel's own test removed.
- Naming the source entry restores the link between the public API and the
source graph without pointing knip at build output.
#### Rejected #### Rejected
- `"src/index.ts"` in `entry`: it silenced an `unused files` report for the
barrel, which the derivation above no longer produces; keeping it only adds a
hint.
- `paths` mapping `dist/index.*` back to `src/index.ts`: more config to model a - `paths` mapping `dist/index.*` back to `src/index.ts`: more config to model a
relation the explicit entry states directly, and it would break whenever the relation knip already resolves.
build layout changes.
### `maintain:outdated` ignores `@types/node` ### `maintain:outdated` ignores `@types/node`
@@ -327,7 +328,7 @@ of a hand-rolled JSON-RPC client.
#### Decision (2026-09) #### Decision (2026-09)
`@spences10/pi-lsp` is pinned to `0.0.46` and used read-only. `@spences10/pi-lsp` is pinned to `0.0.47` and used read-only.
#### Why #### Why
+1 -1
View File
@@ -1,5 +1,5 @@
{ {
"$schema": "./node_modules/knip/schema.json", "$schema": "./node_modules/knip/schema.json",
"entry": ["src/index.ts", "scripts/*.ts"], "entry": ["scripts/*.ts"],
"ignoreDependencies": ["@runwisp/pubv"] "ignoreDependencies": ["@runwisp/pubv"]
} }
+374 -352
View File
File diff suppressed because it is too large. Load diff
+1 -1
View File
@@ -88,7 +88,7 @@
"knip": "^6.34.0", "knip": "^6.34.0",
"lefthook": "^2.1.12", "lefthook": "^2.1.12",
"mdast-util-from-markdown": "^2.0.3", "mdast-util-from-markdown": "^2.0.3",
"oxfmt": "^0.70.0", "oxfmt": "^0.71.0",
"oxlint": "^1.83.0", "oxlint": "^1.83.0",
"oxlint-tsgolint": "^7.0.2001", "oxlint-tsgolint": "^7.0.2001",
"publint": "^0.3.24", "publint": "^0.3.24",