Compare commits
17
Commits
d99d84d387
...
0.8.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
acf9d06ddd | ||
|
|
eba60f6569 | ||
|
|
52ce655d8e | ||
|
|
76327a8c47 | ||
|
|
d7004c0f71 | ||
|
|
69231eb9ac | ||
|
|
7ff371c569 | ||
|
|
0339a493a2 | ||
|
|
2c856f28e3 | ||
|
|
4260a4732c | ||
|
|
11d364e187 | ||
|
|
8dc0b95320 | ||
|
|
7b90f898d3 | ||
|
|
1bdf7f0315 | ||
|
|
55bf6c24a7 | ||
|
|
e7b5c0284d | ||
|
|
013bfa883b |
No files matched your search
@@ -77,6 +77,9 @@ jobs:
|
||||
- run: npm ci
|
||||
- run: npm run build
|
||||
- run: npm run check
|
||||
# Fails the build below 100% coverage on `src/` (`c8 --all --100`);
|
||||
# the same run produces the report published below. See
|
||||
# development/ci.md § Coverage threshold.
|
||||
- run: npm run test:ci
|
||||
# Publish this tag's coverage to the self-hosted pages server,
|
||||
# served read-only at
|
||||
|
||||
+18
-1
@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.8.1] - 2026-09-23
|
||||
|
||||
- gate CI at 100% coverage: `test:ci` runs c8 with `--all --100` over `src/`,
|
||||
and a test loads the `index.ts` barrel so it is measured
|
||||
- pin the duplicate-tag union collapse (members sharing a tag dispatch through
|
||||
one handler) with tests
|
||||
|
||||
## [0.8.0] - 2026-09-23
|
||||
|
||||
- reject a universe that mixes a literal with a broad type (e.g.
|
||||
`"a" | \`x-${number}\``), which the finite-literal gate let through
|
||||
- narrow the tagged-union matcher's handler parameters for a union-valued or
|
||||
optional discriminant, and its fallback to the unhandled tags, instead of
|
||||
passing `never`
|
||||
|
||||
## [0.7.1] - 2026-09-23
|
||||
|
||||
- upgrade dependencies
|
||||
@@ -86,7 +101,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
- basic setup
|
||||
|
||||
[Unreleased]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.7.1...main
|
||||
[Unreleased]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.8.1...main
|
||||
[0.8.1]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.8.0...0.8.1
|
||||
[0.8.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.7.1...0.8.0
|
||||
[0.7.1]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.7.0...0.7.1
|
||||
[0.7.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.6.0...0.7.0
|
||||
[0.6.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.5.0...0.6.0
|
||||
|
||||
+3
-2
@@ -41,7 +41,7 @@ faster tiers catch less, slower tiers are more thorough":
|
||||
| `npm run verify` | manual | Definition of done: `npm run check` + unit tests, one shot | ~6s |
|
||||
| `npm run fix` | manual | Auto-resolve fixable issues (lint, format) | ~3s |
|
||||
| `npm run maintain` | manual / CI (advisory) | `maintain:knip` + `maintain:outdated` (whole-project + network scans) | ~10s |
|
||||
| CI build (auto) | on push to `main` / tag | `build` job (build + correctness + packaging) — see [.gitea/workflows/ci.yml](./.gitea/workflows/ci.yml) | ~30s+ |
|
||||
| CI build (auto) | on push to `main` / tag | `build` job (build + correctness + coverage + packaging) — see [.gitea/workflows/ci.yml](./.gitea/workflows/ci.yml) | ~30s+ |
|
||||
| CI maintain (auto, non-blocking) | on push to `main` | `npm run maintain` — reports, never fails the build | ~10s |
|
||||
| CI publish (auto) | on tag | packaging checks + `publish:publint` / `publish:attw`, then the Gitea release page and `npm publish` (skipped, and the job failed, without `NPM_TOKEN`) | ~15s |
|
||||
|
||||
@@ -125,7 +125,8 @@ CI step. Pick the prefix that matches the script's lifecycle:
|
||||
`npm run fix`; the diff is the review surface.
|
||||
- `test:*` — test scripts. `test` is the canonical entry point (`check:tsc` +
|
||||
unit tests); `test:unit` skips the typecheck for fast local iteration;
|
||||
`test:ci` adds c8 coverage.
|
||||
`test:ci` runs the suite under c8 and fails below 100% coverage on `src/`
|
||||
(CI-only; `verify` stays coverage-free).
|
||||
- `watch:*` — long-running watchers for the manual inner dev loop. Aggregated by
|
||||
`watch`.
|
||||
- `maintain:*` — advisory repo-maintenance scans: read-only, but whole-project
|
||||
|
||||
@@ -40,6 +40,19 @@ Yet to be implemented
|
||||
- **`NaN` and `-0` cannot be matched specifically.** They have no literal type,
|
||||
so both stay part of `number`.
|
||||
|
||||
### Why open universes are rejected
|
||||
|
||||
An open universe — one carrying a broad member, as in
|
||||
`type Units = "s" | "ms" | "min" | (string & {})` — is not a dispatch concern.
|
||||
If the values arrive from outside the program, parse them at the boundary down
|
||||
to a finite union and match the narrowed result; the openness never reaches the
|
||||
matcher. If the domain is genuinely extensible, the right shape is a runtime
|
||||
`Map` of handlers, where "no handler" is a lookup, not a pattern. Either way an
|
||||
open matcher would abandon the one guarantee this library exists to give —
|
||||
provable exhaustiveness — to automate what a `switch` and a default arm already
|
||||
cover. The type-level cost of supporting open universes is recorded in
|
||||
[development/library.md](./development/library.md#supported-universes).
|
||||
|
||||
## License
|
||||
|
||||
MIT © 2025 tmu. See [LICENSE](./LICENSE).
|
||||
|
||||
+6
-63
@@ -6,75 +6,21 @@ Backlog and tracking for tiny-pattern-ts. Managed in vscode-todotasks format.
|
||||
|
||||
Setup:
|
||||
☐ Split off template into separate package => pi --session 01a07dde-7050-7054-bb36-1606d7eb2bc3 @low
|
||||
✔ straighten oxc rules @done
|
||||
✔ oxc forbids ternary => remove oxc rule @done
|
||||
✔ oxc wants comments to start comments with a capital letter => remove oxc rule @done
|
||||
✔ there already exists a /* */ block comment in primitive.ts, => change to multi-line comment @done
|
||||
|
||||
✔ Remove example code files and its documentation and its exports from index.ts @high @done
|
||||
✔ remove src/match.ts and its documentation @high @done
|
||||
✔ remove src/pattern.ts and its documentation @high @done
|
||||
✔ remove src/index.test.ts and its documentation @high @done
|
||||
✔ exports from `src/index.ts` should only be the public API surface @done
|
||||
|
||||
|
||||
v1.0:
|
||||
☐ API surface is stable and fully typed
|
||||
☐ Finalize public exports in `src/index.ts`
|
||||
☐ Document all exported types and functions
|
||||
☐ Add JSDoc for public APIs
|
||||
☐ Test coverage meets threshold
|
||||
☐ Achieve 100% branch coverage on `src/primitive-union.ts`
|
||||
☐ Achieve 100% branch coverage on `src/index.ts`
|
||||
|
||||
Testing:
|
||||
✔ Cover autocomplete with real completion test cases in the suite @medium @done
|
||||
→ `src/util/__tests__/lsp-completion.ts` (`#test-utils/…`) is the helper; the suite asserts its labels (see development/testing.md § Autocomplete)
|
||||
→ wire it into `node --test` so a test asserts the offered labels
|
||||
→ note: `Parameters<typeof factory>[0]` resolves only the *last* overload; use `@ts-expect-error` call sites for factory negatives, not `not.toExtend<Parameters<…>>`
|
||||
✔ Drive the LSP completion helper through the LSP protocol library instead of a hand-rolled JSON-RPC client @medium @done
|
||||
✔ Add `vscode-languageserver-protocol` and record the tooling decision @done
|
||||
✔ Rewrite `src/util/__tests__/lsp-completion.ts` onto `createMessageConnection` and typed requests @done
|
||||
✔ Update `development/testing.md § Autocomplete` for the new client @done
|
||||
✔ Run `npm run verify` and check the task off @done
|
||||
✘ Test a literal union widened with `(string & {})` — `"red" | "green" | "yellow" | (string & {})` @medium @cancelled
|
||||
→ broad universes are rejected; the rejection is covered by the broad-universe gate tests
|
||||
✔ Type hole when using broad types like string as a universe @high @done
|
||||
→ decided: broad universes are rejected at the factory, so the exhaustive overload can always be proven
|
||||
→ value/stringification collisions (`true | "true"`, `1 | "1"`) are rejected too; handler params are typed by `Member<T, K>`
|
||||
→ see development/library.md § Supported universes
|
||||
✔ 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:
|
||||
✔ Clean up: adopt the 3-overload matcher (`src/prototype-ac2.ts`) and delete the prototypes @high @done
|
||||
→ `getMatcher` / `getMatcherW`, each with overloads `ExhaustiveLoose` → `Fallback` → `Handlers` (order is load-bearing)
|
||||
→ fold into `src/primitive.ts` / the public API; drop `src/prototype*.ts`
|
||||
✔ `_` should receive only the unhandled `T` keys, not all of `T` @medium @done
|
||||
→ the fallback is now a second argument: `(handlers, (s) => …)`, `s: Exclude<T, keyof handlers>`
|
||||
✔ A fallback for an already-exhaustive handler map must be a compile error @medium @done
|
||||
→ rejected by an F-bounded constraint on `Handled` (checked *after* inference); a conditional in the fallback parameter is evaluated too early and breaks contextual typing
|
||||
✔ Implement matcher with similar API like matcher from primitive.ts @high @done
|
||||
→ `getTaggedUnionMatcher` / `getTaggedUnionMatcherW`, curried on the discriminant key
|
||||
→ fallback is the second argument; `_` removed
|
||||
✔ Rename `primitive` to `primitive-union` and `getMatcher` to `getPrimitiveMatcher` @medium @done
|
||||
→ `src/primitive.ts` / `src/primitive.test.ts` → `primitive-union.*`
|
||||
→ `getMatcherW` → `getPrimitiveMatcherW` for symmetry with the tagged-union pair
|
||||
→ update `src/index.ts`, `development/library.md` and any README references
|
||||
→ shipped as `getPrimitiveUnionMatcher` / `getPrimitiveUnionMatcherW`; kept `Union` for symmetry with the tagged-union pair
|
||||
☐ when using a union type as a property, the current behavior of tagged union matcher is
|
||||
✔ 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
|
||||
|
||||
Bugs:
|
||||
✔ TS 7 LSP server logs `context canceled` on stderr at shutdown @done
|
||||
→ `handleExit` returns `io.EOF`, cancelling the background context while `Session.updateWatches` is still in flight; the bare error is flushed to stderr and the server exits 1
|
||||
→ close stdin after `shutdown` instead of sending `exit`; the server exits cleanly (code 0, no output), kill kept as a fallback
|
||||
Enhancements:
|
||||
✔ Allow boolean literals in primitive union patterns (e.g. `true: () => "yes"`) @medium @done
|
||||
✔ Are there other primitive types that should be supported in union patterns? (e.g. `bigint`, `symbol`) @medium @done
|
||||
→ added boolean, null and undefined; rejected `symbol` (compile-time brand, nothing at runtime) and `bigint` (not a property key)
|
||||
✔ Allow boolean, null and undefined discriminant values in tagged-union patterns @medium @done
|
||||
→ moved the `PatternKey` / `PatternParam` projection to `matcher-shared.ts` and keyed the tagged-union handler map through it; see development/library.md § 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:
|
||||
☐ Bring README.md back to its previous form — synopsis and examples restored, in the correct place
|
||||
@@ -84,12 +30,8 @@ Documentation:
|
||||
☐ Add comparison section vs. other TS pattern-matching libs in Readme.md
|
||||
☐ Write migration guide for users coming from discriminated unions
|
||||
☐ Create backlog tasks for implementation
|
||||
✔ Document the matcher design paths in `development/` — union vs overload merge, inferred universe (`NoInfer`), conditional `RequireKeys`, cases-first — and why each was abandoned @done
|
||||
☐ Validate code fences in Markdown (start with README.md) — compile the TypeScript examples against `src/` so the docs cannot drift from the API
|
||||
|
||||
Workflow:
|
||||
✔ Resolve the finish/push tension: `create:finish` leaves `main` ahead of its upstream while `create:branch` refuses until `main` matches upstream — decide whether `finish` should push or `branch` should compare only `BEHIND` (see development/workflow.md) @done
|
||||
|
||||
Maintenance:
|
||||
☐ Serve CI coverage over a tiny self-hosted webserver (replace the zip artifact) @low
|
||||
☐ Explore serving coverage for non-tag pushes (e.g. `main/coverage`, PR previews) @low
|
||||
@@ -102,3 +44,4 @@ Maintenance:
|
||||
☐ Add a minimal dir-listing webserver to the gitea docker setup for serving landing page (reuse existing reverse proxy)
|
||||
☐ CI writes landing page to a shared volume keyed by project + tag (e.g. `/landing/tiny-pattern-ts/<tag>/`)
|
||||
☐ Browse to `…/tiny-pattern-ts/index.html` in the browser
|
||||
☐ Add testing with TypeScript 5.0 baseline in CI
|
||||
@@ -97,6 +97,39 @@ Leave `act_runner`'s `force_pull` disabled.
|
||||
(`docker rmi gitea.e1nsnull.de/tmu/act-ci:<version>`); do not reach for
|
||||
force-pull.
|
||||
|
||||
## Coverage threshold
|
||||
|
||||
#### Decision (2026-09)
|
||||
|
||||
`npm run test:ci` fails below 100% statements / branches / functions / lines
|
||||
across `src/**/*.ts` (`c8 --all --include "src/**/*.ts" --100`). The gate rides
|
||||
the `build` job; `npm run verify` stays coverage-free.
|
||||
|
||||
#### Why
|
||||
|
||||
- The types are the feature, so an untested branch is a hole in the contract,
|
||||
not a metric to trade off; 100% is the only threshold that means "no hole".
|
||||
- `--all` counts a `src/` file no test imports. Without it c8 reports only the
|
||||
files the suite happened to load, so a new untested module is invisible and
|
||||
the threshold passes vacuously.
|
||||
- The gate rides `test:ci`, which `build` already runs — no new job or step.
|
||||
- `verify` stays fast and local; the slower coverage run is a CI-only tier (see
|
||||
[workflow.md § Feedback tiers](./workflow.md#feedback-tiers)).
|
||||
|
||||
#### Rejected
|
||||
|
||||
- Per-file thresholds: a global 100% already forces every counted file to 100%.
|
||||
- A `check:coverage` script: it would re-run the suite or read c8's temp dir,
|
||||
and no `check:*` script runs tests.
|
||||
- `--all` without `--include`: it would also sweep `scripts/`, which is not the
|
||||
shipped surface.
|
||||
|
||||
#### Known issue
|
||||
|
||||
- `src/matcher-shared.ts` is types only, so its runtime image is empty; c8 still
|
||||
lists it under `--all`. It carries a file-level `/* c8 ignore start */` with
|
||||
the reason. Adding runtime code there means removing that directive.
|
||||
|
||||
## Coverage serving
|
||||
|
||||
#### Decision (2026-09)
|
||||
|
||||
+31
-11
@@ -145,6 +145,10 @@ inversion: the handler parameter is the member(s) of `T` whose `PatternKey` is
|
||||
object satisfy the exhaustive overload and reaches the `dispatch` throw.
|
||||
Rejecting at the boundary avoids threading an open/closed branch through
|
||||
`Handlers`, `Fallback` and `MustBePartial`.
|
||||
- **The finite-literal predicate is `IsLiteral<PatternKey<T>> extends true`.**
|
||||
`IsLiteral` is `boolean` for a union that mixes a literal with a broad type
|
||||
(`"a" | \`x-${number}\``), so `extends false`would treat the mix as
|
||||
supported;`extends true` is the check that rejects it.
|
||||
- **Collisions are rejected, not merged.** `Member<T, K>` would be sound (the
|
||||
handler gets the union), but the API is one handler per member; rejecting
|
||||
keeps `Member` a singleton and the remainder exact.
|
||||
@@ -163,7 +167,9 @@ Extract<T, Stringified<T>>` catches numeric collisions too.
|
||||
non-self-referential parameter type (`{ [K in keyof H]: … R … }` gives
|
||||
`unknown`); an F-bounded guard referencing `keyof Handled` in `Handled`'s own
|
||||
constraint sees the constraint, not the map; all handlers share one `R` (only
|
||||
the fallback widens it); `IsLiteral` is the finite-literal predicate.
|
||||
the fallback widens it); `IsLiteral` is the finite-literal predicate. The
|
||||
user-facing consequence — open universes are a parsing or registry concern,
|
||||
not a dispatch one — is guidance in README § Why open universes are rejected.
|
||||
- **`Member<T, K>` without the gate:** sound, but a colliding handler gets a
|
||||
union and `1 | "1"` stays one runtime key.
|
||||
- **A round-trip injectivity gate** (`IsEqual<T, PatternParam<PatternKey<T>>>`):
|
||||
@@ -208,16 +214,27 @@ The key is a separate call because `K` is inferred from its literal argument and
|
||||
|
||||
#### Why
|
||||
|
||||
- **Same fallback/remainder machinery as the primitive-union matcher.** `HandledMembers`
|
||||
maps the handled tags to their members and `Exclude<T, …>` is the fallback's
|
||||
parameter; the redundant-fallback guard is the same F-bounded constraint. Only
|
||||
the "universe" changes — `T`'s members instead of primitive values.
|
||||
- **Same fallback/remainder machinery as the primitive-union matcher.** `HandledTags`
|
||||
recovers the tag values the map handled (`Member<Tags, keyof Handled>`) and
|
||||
`Narrowed<T, K, Exclude<Tags, …>>` is the fallback's parameter; the
|
||||
redundant-fallback guard is the same F-bounded constraint. Only the "universe"
|
||||
changes — `T`'s members instead of primitive values.
|
||||
- **`T extends object`, not `Record<PropertyKey, unknown>`.** An `interface` has
|
||||
no implicit index signature, so the `Record` constraint would reject
|
||||
interface-based unions. The runtime reads the tag off `object` with one
|
||||
assertion, the tagged twin of the primitive-union dispatch's `shape as string | number`.
|
||||
- **`MapTaggedUnion` distributes with `Extract`.** A duplicated tag yields a
|
||||
union of members instead of dropping one.
|
||||
- **`Narrowed` distributes over `T`, narrowing `K` to the tag.** A member whose
|
||||
`K` cannot take the tag drops out; a duplicated tag yields a union of members
|
||||
instead of dropping one. `T[K] extends V` returns the exact member (a
|
||||
discriminated union's declared interface) untouched, so the mapped form only
|
||||
handles a property that is itself a union.
|
||||
- **A union-valued or optional discriminant is supported.** A single shape whose
|
||||
property is a union (`{ color: "red" | "green" | "blue" }`) is narrowed per
|
||||
handler instead of being passed `never`. Matching a defined tag on an optional
|
||||
property (`{ type?: "x" }`) proves the key is present, so it becomes required
|
||||
(`{ type: "x" }`); the `undefined` tag narrows it to `{ type?: never }` under
|
||||
`exactOptionalPropertyTypes` (absence) or `{ type?: undefined }` when the
|
||||
property explicitly admits `undefined`.
|
||||
- **A `boolean` / `null` / `undefined` tag goes through the shared
|
||||
`PatternKey` / `Member` projection.** `Discriminated` admits those tags
|
||||
(they are in `Tag`), but they cannot key a mapped type, so the handler map is
|
||||
@@ -228,10 +245,13 @@ The key is a separate call because `K` is inferred from its literal argument and
|
||||
|
||||
#### Known issue
|
||||
|
||||
- A member's tag must be unique across the union; two members with the same tag
|
||||
collapse to a union under one handler. A tag colliding with its
|
||||
stringification (`true | "true"`) is rejected by the universe gate — see
|
||||
§ Supported universes.
|
||||
- A tag need not be unique across the union. Two members sharing one is not a
|
||||
soundness hole: they select a single runtime key, so one handler receiving
|
||||
their union is the only correct behavior — the key is simply not a
|
||||
discriminant. The gate rejects only the distinct-value collision
|
||||
(`true | "true"`), where two values share a key and `Member` can no longer
|
||||
invert it; see § Supported universes. Pinned by the duplicate-tag tests in
|
||||
`src/tagged-union.test.ts`.
|
||||
|
||||
## Primitive universe
|
||||
|
||||
|
||||
@@ -35,7 +35,8 @@ in
|
||||
[CONTRIBUTING.md § Development commands](../CONTRIBUTING.md#development-commands).
|
||||
`c8` uses V8 coverage, so the `--strip-types` source is instrumented without a
|
||||
build step, and the runner relies on the `.ts` import-extension convention (see
|
||||
[tooling.md](./tooling.md#source-imports-use-ts-extensions)).
|
||||
[tooling.md](./tooling.md#source-imports-use-ts-extensions)). CI gates that
|
||||
coverage at 100% (see [ci.md § Coverage threshold](./ci.md#coverage-threshold)).
|
||||
|
||||
## Handler arguments
|
||||
|
||||
@@ -198,6 +199,11 @@ the CLI is for manual inspection.
|
||||
delay is needed.
|
||||
- The server answers some requests with a string id (`client/registerCapability`);
|
||||
the client must tolerate `string | number` ids or the server stalls.
|
||||
- `LspSession.close()` sends `shutdown` and then closes stdin instead of
|
||||
sending `exit`. The TS 7 Go server's `handleExit` returns `io.EOF`, cancelling
|
||||
the background context while a watch update is still in flight, and logs a
|
||||
bare `context canceled` before exiting 1; EOF on stdin exits 0 with no output.
|
||||
The kill stays as a fallback for a server that does not exit.
|
||||
|
||||
## Known issues
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "tiny-pattern-ts",
|
||||
"version": "0.7.1",
|
||||
"version": "0.8.1",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "tiny-pattern-ts",
|
||||
"version": "0.7.1",
|
||||
"version": "0.8.1",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"type-fest": "^5.9.0"
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "tiny-pattern-ts",
|
||||
"version": "0.7.1",
|
||||
"version": "0.8.1",
|
||||
"description": "Pattern matching for TypeScript/ESM environments (F#-style, not regex)",
|
||||
"keywords": [
|
||||
"adt",
|
||||
@@ -58,7 +58,7 @@
|
||||
"maintain:knip": "knip --include dependencies,exports,files",
|
||||
"maintain:outdated": "check-outdated --ignore-pre-releases --ignore-packages @types/node",
|
||||
"test": "npm run check:tsc && node --test --strip-types \"src/**/*.test.ts\"",
|
||||
"test:ci": "c8 --reporter=text --reporter=lcov --reporter=html node --test --strip-types \"src/**/*.test.ts\"",
|
||||
"test:ci": "c8 --all --include \"src/**/*.ts\" --reporter=text --reporter=lcov --reporter=html --100 node --test --strip-types \"src/**/*.test.ts\"",
|
||||
"test:unit": "node --test --strip-types \"src/**/*.test.ts\"",
|
||||
"verify": "npm run check && npm run test:unit",
|
||||
"watch": "npm run watch:test",
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
import { strict as assert } from "node:assert";
|
||||
import { test } from "node:test";
|
||||
|
||||
import { expectTypeOf } from "expect-type";
|
||||
|
||||
import {
|
||||
getPrimitiveUnionMatcher,
|
||||
getPrimitiveUnionMatcherW,
|
||||
getTaggedUnionMatcher,
|
||||
getTaggedUnionMatcherW,
|
||||
} from "./index.ts";
|
||||
|
||||
// The published entry point is the barrel (`package.json` exports
|
||||
// `./dist/index.js`), so every factory must be reachable from here. Importing it
|
||||
// also loads the module, which is what lets c8's `--all` measure it — see
|
||||
// development/ci.md § Coverage threshold.
|
||||
test("index: the public entry point re-exports every matcher factory", () => {
|
||||
// Assert
|
||||
expectTypeOf(getPrimitiveUnionMatcher).toBeFunction();
|
||||
assert.equal(typeof getPrimitiveUnionMatcher, "function");
|
||||
expectTypeOf(getPrimitiveUnionMatcherW).toBeFunction();
|
||||
assert.equal(typeof getPrimitiveUnionMatcherW, "function");
|
||||
expectTypeOf(getTaggedUnionMatcher).toBeFunction();
|
||||
assert.equal(typeof getTaggedUnionMatcher, "function");
|
||||
expectTypeOf(getTaggedUnionMatcherW).toBeFunction();
|
||||
assert.equal(typeof getTaggedUnionMatcherW, "function");
|
||||
});
|
||||
@@ -1,3 +1,4 @@
|
||||
/* c8 ignore start -- types only: the module has no runtime image to cover */
|
||||
import type { IsLiteral, IsNever, ValueOf } from "type-fest";
|
||||
|
||||
// The primitive-union and tagged-union matchers differ in their universe, but the
|
||||
@@ -62,11 +63,11 @@ export type Collisions<T> = Extract<T, Stringified<T>>;
|
||||
// universe is a finite union of literals with no value/stringification
|
||||
// collision: only then can `PatternKey` be inverted unambiguously.
|
||||
export type UnsupportedReason<T extends Matchable> =
|
||||
IsLiteral<PatternKey<T>> extends false
|
||||
? "broad types like string, number and template literals are not supported"
|
||||
: [Collisions<T>] extends [never]
|
||||
? never
|
||||
: `a value and its stringification collide. Value is "${Collisions<T> & string}"`;
|
||||
IsLiteral<PatternKey<T>> extends true
|
||||
? [Collisions<T>] extends [never]
|
||||
? never
|
||||
: `a value and its stringification collide. Value is "${Collisions<T> & string}"`
|
||||
: "broad types like string, number and template literals are not supported";
|
||||
|
||||
// The diagnostic for an unsupported universe. Extends `HandlerMap` so the
|
||||
// implementation's `handlers: HandlerMap` stays assignable when the gate is
|
||||
|
||||
@@ -528,6 +528,8 @@ test("getPrimitiveUnionMatcher: a broad universe is rejected", () => {
|
||||
getPrimitiveUnionMatcher<number>()({ 1: () => 1 });
|
||||
// @ts-expect-error a template literal is open
|
||||
getPrimitiveUnionMatcher<`a${string}`>()({ a: () => 1 });
|
||||
// @ts-expect-error a literal mixed with a template literal is open
|
||||
getPrimitiveUnionMatcher<"a" | `x-${number}`>()({ a: () => 1 });
|
||||
// @ts-expect-error `string | boolean` is open because of `string`
|
||||
getPrimitiveUnionMatcher<string | boolean>()({ true: () => 1 });
|
||||
// @ts-expect-error the widening factory rejects broad universes too
|
||||
|
||||
+516
-1
@@ -892,6 +892,434 @@ test("getTaggedUnionMatcher: the maximum illegal tag universe is rejected", () =
|
||||
});
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
// Property unions
|
||||
// ============================================================================
|
||||
|
||||
test("property union: narrows each handler", () => {
|
||||
// Arrange — one shape, not a union of variants; `color` is a union.
|
||||
interface Paint {
|
||||
readonly color: "red" | "green" | "blue";
|
||||
readonly value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Paint>()("color");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
red: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
readonly color: "red";
|
||||
readonly value: number;
|
||||
}>();
|
||||
assert.equal(s.color, "red");
|
||||
return s.value;
|
||||
},
|
||||
green: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
readonly color: "green";
|
||||
readonly value: number;
|
||||
}>();
|
||||
assert.equal(s.color, "green");
|
||||
return s.value;
|
||||
},
|
||||
blue: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
readonly color: "blue";
|
||||
readonly value: number;
|
||||
}>();
|
||||
assert.equal(s.color, "blue");
|
||||
return s.value;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Paint) => number>();
|
||||
assert.equal(describe({ color: "red", value: 1 }), 1);
|
||||
assert.equal(describe({ color: "green", value: 2 }), 2);
|
||||
assert.equal(describe({ color: "blue", value: 3 }), 3);
|
||||
});
|
||||
|
||||
test("property union: a fallback receives the unhandled values", () => {
|
||||
// Arrange
|
||||
interface Paint {
|
||||
color: "red" | "green" | "blue";
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Paint>()("color");
|
||||
|
||||
// Act
|
||||
const describe = factory(
|
||||
{
|
||||
red: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
color: "red";
|
||||
value: number;
|
||||
}>();
|
||||
assert.equal(s.color, "red");
|
||||
return 1 as const;
|
||||
},
|
||||
},
|
||||
(s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
color: "green" | "blue";
|
||||
value: number;
|
||||
}>();
|
||||
assert.ok(s.color === "green" || s.color === "blue");
|
||||
return 2 as const;
|
||||
},
|
||||
);
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Paint) => 1 | 2>();
|
||||
assert.equal(describe({ color: "red", value: 1 }), 1);
|
||||
assert.equal(describe({ color: "green", value: 2 }), 2);
|
||||
assert.equal(describe({ color: "blue", value: 3 }), 2);
|
||||
});
|
||||
|
||||
test("property union: a numeric property narrows each handler", () => {
|
||||
// Arrange
|
||||
interface Version {
|
||||
code: 1 | 2 | 3;
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Version>()("code");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
1: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ code: 1; value: number }>();
|
||||
assert.equal(s.code, 1);
|
||||
return 1;
|
||||
},
|
||||
2: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ code: 2; value: number }>();
|
||||
assert.equal(s.code, 2);
|
||||
return 2;
|
||||
},
|
||||
3: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ code: 3; value: number }>();
|
||||
assert.equal(s.code, 3);
|
||||
return 3;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Version) => number>();
|
||||
assert.equal(describe({ code: 1, value: 10 }), 1);
|
||||
assert.equal(describe({ code: 2, value: 20 }), 2);
|
||||
assert.equal(describe({ code: 3, value: 30 }), 3);
|
||||
});
|
||||
|
||||
test("property union: an optional property is required for a defined tag", () => {
|
||||
// Arrange — `type?` is `"x" | undefined`; both handlers must be typed,
|
||||
// and matching `"x"` proves the key is present, so `type` becomes required.
|
||||
interface Maybe {
|
||||
type?: "x";
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Maybe>()("type");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
x: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ type: "x"; value: number }>();
|
||||
assert.equal(s.type, "x");
|
||||
return 1;
|
||||
},
|
||||
undefined: (s) => {
|
||||
// The input only allows absence (exactOptionalPropertyTypes), so
|
||||
// the `undefined` tag narrows the key to never-present.
|
||||
expectTypeOf(s).toEqualTypeOf<{ type?: never; value: number }>();
|
||||
assert.equal(s.type, undefined);
|
||||
return 2;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Maybe) => number>();
|
||||
assert.equal(describe({ type: "x", value: 1 }), 1);
|
||||
assert.equal(describe({ value: 2 }), 2);
|
||||
});
|
||||
|
||||
test("property union: an optional fallback receives the undefined tag", () => {
|
||||
// Arrange
|
||||
interface Maybe {
|
||||
type?: "x";
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Maybe>()("type");
|
||||
|
||||
// Act
|
||||
const describe = factory(
|
||||
{
|
||||
x: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ type: "x"; value: number }>();
|
||||
assert.equal(s.type, "x");
|
||||
return 1 as const;
|
||||
},
|
||||
},
|
||||
(s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
type?: never;
|
||||
value: number;
|
||||
}>();
|
||||
assert.equal(s.type, undefined);
|
||||
return 2 as const;
|
||||
},
|
||||
);
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Maybe) => 1 | 2>();
|
||||
assert.equal(describe({ type: "x", value: 1 }), 1);
|
||||
assert.equal(describe({ value: 2 }), 2);
|
||||
});
|
||||
|
||||
test("property union: explicit `undefined` stays distinct from absence", () => {
|
||||
// Arrange — `type?: "x" | undefined` admits an explicit `undefined`, unlike
|
||||
// the bare optional above; the two representations must not be conflated.
|
||||
interface Explicit {
|
||||
type?: "x" | undefined;
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Explicit>()("type");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
x: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ type: "x"; value: number }>();
|
||||
assert.equal(s.type, "x");
|
||||
return 1;
|
||||
},
|
||||
undefined: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
type?: undefined;
|
||||
value: number;
|
||||
}>();
|
||||
assert.equal(s.type, undefined);
|
||||
return 2;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Explicit) => number>();
|
||||
assert.equal(describe({ type: "x", value: 1 }), 1);
|
||||
assert.equal(describe({ type: undefined, value: 2 }), 2);
|
||||
assert.equal(describe({ value: 3 }), 2);
|
||||
});
|
||||
|
||||
test("property union: a union-valued member is split, not dropped", () => {
|
||||
// A member whose tag is itself a union sits beside a singleton-tag member.
|
||||
// Selecting members with `Extract<T, Record<K, V>>` keeps only the
|
||||
// singleton; the distributive narrowing must keep both sides of the
|
||||
// union-valued member.
|
||||
// Arrange
|
||||
type Mixed = { kind: "a"; a: number } | { kind: "a" | "b"; b: number };
|
||||
const factory = getTaggedUnionMatcher<Mixed>()("kind");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
a: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<
|
||||
{ kind: "a"; a: number } | { kind: "a"; b: number }
|
||||
>();
|
||||
assert.equal(s.kind, "a");
|
||||
return 1;
|
||||
},
|
||||
b: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ kind: "b"; b: number }>();
|
||||
assert.equal(s.kind, "b");
|
||||
return 2;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Mixed) => number>();
|
||||
assert.equal(describe({ kind: "a", a: 1 }), 1);
|
||||
assert.equal(describe({ kind: "a", b: 2 }), 1);
|
||||
assert.equal(describe({ kind: "b", b: 3 }), 2);
|
||||
});
|
||||
|
||||
test("property union: getTaggedUnionMatcherW widens the returns", () => {
|
||||
// Arrange
|
||||
interface Paint {
|
||||
color: "red" | "green" | "blue";
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcherW<Paint>()("color");
|
||||
|
||||
// Act
|
||||
const describe = factory({
|
||||
red: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ color: "red"; value: number }>();
|
||||
assert.equal(s.color, "red");
|
||||
return "r" as const;
|
||||
},
|
||||
green: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ color: "green"; value: number }>();
|
||||
assert.equal(s.color, "green");
|
||||
return 1 as const;
|
||||
},
|
||||
blue: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<{ color: "blue"; value: number }>();
|
||||
assert.equal(s.color, "blue");
|
||||
return true as const;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Paint) => "r" | 1 | true>();
|
||||
assert.equal(describe({ color: "red", value: 1 }), "r");
|
||||
assert.equal(describe({ color: "green", value: 2 }), 1);
|
||||
assert.equal(describe({ color: "blue", value: 3 }), true);
|
||||
});
|
||||
|
||||
test("property union: enforces its contract", () => {
|
||||
// Arrange
|
||||
interface Paint {
|
||||
color: "red" | "green" | "blue";
|
||||
value: number;
|
||||
}
|
||||
const factory = getTaggedUnionMatcher<Paint>()("color");
|
||||
|
||||
// Act / Assert — the calls below must not compile
|
||||
factory({
|
||||
red: () => 1,
|
||||
green: () => 2,
|
||||
blue: () => 3,
|
||||
// @ts-expect-error `yellow` is not a value of `color`
|
||||
yellow: () => 4,
|
||||
});
|
||||
// @ts-expect-error a gap without a fallback is not exhaustive
|
||||
factory({ red: () => 1 });
|
||||
// @ts-expect-error a fallback is redundant once every value is handled
|
||||
factory({ red: () => 1, green: () => 2, blue: () => 3 }, () => 0);
|
||||
});
|
||||
|
||||
test("property union: a broad value in the union is rejected", () => {
|
||||
// Arrange — the property is a union, but not a finite union of literals: a
|
||||
// template literal cannot be proven exhaustive.
|
||||
interface Template {
|
||||
kind: "a" | `x-${number}`;
|
||||
a: number;
|
||||
}
|
||||
|
||||
// Act / Assert — the calls below must not compile
|
||||
// @ts-expect-error a template literal is not a finite literal
|
||||
getTaggedUnionMatcher<Template>()("kind")({ a: () => 1 });
|
||||
// @ts-expect-error the widening factory rejects broad values too
|
||||
getTaggedUnionMatcherW<Template>()("kind")({ a: () => 1 });
|
||||
});
|
||||
|
||||
test("property union: a value/stringification collision is rejected", () => {
|
||||
// Arrange — one property holding both a value and its stringification; both
|
||||
// would key the same handler.
|
||||
interface BooleanColliding {
|
||||
kind: "true" | true;
|
||||
a: number;
|
||||
}
|
||||
interface NumericColliding {
|
||||
kind: "1" | 1;
|
||||
a: number;
|
||||
}
|
||||
|
||||
// Act / Assert — the calls below must not compile
|
||||
// @ts-expect-error `true` collides with the string tag `"true"`
|
||||
getTaggedUnionMatcher<BooleanColliding>()("kind")({ true: () => 1 });
|
||||
// @ts-expect-error the number tag `1` collides with the string tag `"1"`
|
||||
getTaggedUnionMatcher<NumericColliding>()("kind")({ "1": () => 1 });
|
||||
// @ts-expect-error the widening factory rejects the collision too
|
||||
getTaggedUnionMatcherW<BooleanColliding>()("kind")({ true: () => 1 });
|
||||
});
|
||||
|
||||
test("property union: a collision is rejected beside legal members", () => {
|
||||
// Arrange — the map is otherwise complete, so only the collision can make
|
||||
// it invalid.
|
||||
interface Colliding {
|
||||
kind: "true" | true | "a";
|
||||
a: number;
|
||||
}
|
||||
|
||||
// Act / Assert — the call below must not compile
|
||||
// @ts-expect-error `true` collides with the string tag `"true"`
|
||||
getTaggedUnionMatcher<Colliding>()("kind")({ true: () => 1, a: () => 2 });
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
// Duplicate tags
|
||||
// ============================================================================
|
||||
|
||||
// A tag is a discriminant only while it is unique across the union. Two members
|
||||
// may still share one: the tag set `Tags<T, K>` dedupes, so a single handler is
|
||||
// exhaustive for both and receives their union. This is the documented known
|
||||
// issue (development/library.md § Tagged-union matcher); the tests below pin the
|
||||
// behavior so it cannot change silently.
|
||||
|
||||
test("duplicate tag: members sharing a tag collapse to one handler", () => {
|
||||
// Arrange — `kind` is not a true discriminant: both members carry `"a"`.
|
||||
interface First {
|
||||
readonly kind: "a";
|
||||
readonly first: number;
|
||||
}
|
||||
interface Second {
|
||||
readonly kind: "a";
|
||||
readonly second: string;
|
||||
}
|
||||
type Clashing = First | Second;
|
||||
const factory = getTaggedUnionMatcher<Clashing>()("kind");
|
||||
|
||||
// Act
|
||||
const pick = factory({
|
||||
a: (s) => {
|
||||
// The shared tag cannot be split, so the handler sees both members.
|
||||
expectTypeOf(s).toEqualTypeOf<First | Second>();
|
||||
assert.equal(s.kind, "a");
|
||||
return "first" in s ? s.first : s.second.length;
|
||||
},
|
||||
});
|
||||
|
||||
// Assert — the one `a` key is exhaustive and both members reach it.
|
||||
expectTypeOf(pick).toEqualTypeOf<(shape: Clashing) => number>();
|
||||
assert.equal(pick({ kind: "a", first: 1 }), 1);
|
||||
assert.equal(pick({ kind: "a", second: "abc" }), 3);
|
||||
});
|
||||
|
||||
test("duplicate tag: handling one tag consumes every member that shares it", () => {
|
||||
// Arrange — `"a"` selects two members; `"c"` selects one.
|
||||
type Mixed =
|
||||
| { readonly kind: "a"; readonly a: number }
|
||||
| { readonly kind: "a"; readonly b: string }
|
||||
| { readonly kind: "c"; readonly c: boolean };
|
||||
const factory = getTaggedUnionMatcher<Mixed>()("kind");
|
||||
|
||||
// Act
|
||||
const describe = factory(
|
||||
{
|
||||
a: (s) => {
|
||||
expectTypeOf(s).toEqualTypeOf<
|
||||
| { readonly kind: "a"; readonly a: number }
|
||||
| { readonly kind: "a"; readonly b: string }
|
||||
>();
|
||||
return 1 as const;
|
||||
},
|
||||
},
|
||||
(s) => {
|
||||
// Handling `"a"` removes both of its members, not just one.
|
||||
expectTypeOf(s).toEqualTypeOf<{
|
||||
readonly kind: "c";
|
||||
readonly c: boolean;
|
||||
}>();
|
||||
assert.equal(s.kind, "c");
|
||||
return 2 as const;
|
||||
},
|
||||
);
|
||||
|
||||
// Assert
|
||||
expectTypeOf(describe).toEqualTypeOf<(shape: Mixed) => 1 | 2>();
|
||||
assert.equal(describe({ kind: "a", a: 1 }), 1);
|
||||
assert.equal(describe({ kind: "a", b: "x" }), 1);
|
||||
assert.equal(describe({ kind: "c", c: true }), 2);
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
// Dispatch — runtime behavior
|
||||
// ============================================================================
|
||||
@@ -935,6 +1363,7 @@ interface LabelsProbe {
|
||||
readonly tail?: string;
|
||||
readonly typeName?: string;
|
||||
readonly typeSource?: string;
|
||||
readonly key?: string;
|
||||
}
|
||||
|
||||
const labelsFor = ({
|
||||
@@ -944,6 +1373,7 @@ const labelsFor = ({
|
||||
tail = "",
|
||||
typeName = "Shape",
|
||||
typeSource = SHAPE_SOURCE,
|
||||
key = "kind",
|
||||
}: LabelsProbe): Promise<readonly string[]> => {
|
||||
const session = new LspSession(REPO_ROOT);
|
||||
const target: CompletionTarget = {
|
||||
@@ -951,7 +1381,7 @@ const labelsFor = ({
|
||||
source: [
|
||||
`import { ${factory} } from "./index.ts";`,
|
||||
typeSource,
|
||||
`const m = ${factory}<${typeName}>()("kind")({`,
|
||||
`const m = ${factory}<${typeName}>()("${key}")({`,
|
||||
body,
|
||||
`}${tail});`,
|
||||
"",
|
||||
@@ -1038,6 +1468,91 @@ test("autocomplete: boolean and nullish tags are offered by name", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// A single shape whose property is a union: the popup is still keyed by the
|
||||
// property's values, not by the members of a union type.
|
||||
const PALETTE_SOURCE = `interface Palette { color: "red" | "green" | "blue"; value: number }`;
|
||||
const FLAG_SOURCE = `interface Flag { kind: true | false | null | undefined; a: number }`;
|
||||
|
||||
test("property union: autocomplete offers the property's values", () => {
|
||||
// Arrange
|
||||
const name = "property_union_fresh";
|
||||
|
||||
// Act
|
||||
const labels = labelsFor({
|
||||
name,
|
||||
factory: "getTaggedUnionMatcher",
|
||||
typeName: "Palette",
|
||||
typeSource: PALETTE_SOURCE,
|
||||
key: "color",
|
||||
body: " /*COMPLETE*/",
|
||||
});
|
||||
|
||||
// Assert
|
||||
return labels.then((result) => {
|
||||
assert.deepEqual([...result], ["blue", "green", "red"]);
|
||||
});
|
||||
});
|
||||
|
||||
test("property union: autocomplete drops a handled value", () => {
|
||||
// Arrange
|
||||
const name = "property_union_after_key";
|
||||
|
||||
// Act
|
||||
const labels = labelsFor({
|
||||
name,
|
||||
factory: "getTaggedUnionMatcher",
|
||||
typeName: "Palette",
|
||||
typeSource: PALETTE_SOURCE,
|
||||
key: "color",
|
||||
body: " red: () => 1,\n /*COMPLETE*/",
|
||||
});
|
||||
|
||||
// Assert
|
||||
return labels.then((result) => {
|
||||
assert.deepEqual([...result], ["blue", "green"]);
|
||||
});
|
||||
});
|
||||
|
||||
test("property union: autocomplete makes the remaining values optional with a fallback", () => {
|
||||
// Arrange
|
||||
const name = "property_union_with_fallback";
|
||||
|
||||
// Act
|
||||
const labels = labelsFor({
|
||||
name,
|
||||
factory: "getTaggedUnionMatcher",
|
||||
typeName: "Palette",
|
||||
typeSource: PALETTE_SOURCE,
|
||||
key: "color",
|
||||
body: " /*COMPLETE*/",
|
||||
tail: ", () => 0",
|
||||
});
|
||||
|
||||
// Assert
|
||||
return labels.then((result) => {
|
||||
assert.deepEqual([...result], ["blue?", "green?", "red?"]);
|
||||
});
|
||||
});
|
||||
|
||||
test("property union: autocomplete offers boolean and nullish values by name", () => {
|
||||
// Arrange
|
||||
const name = "property_union_boolean_nullish";
|
||||
|
||||
// Act
|
||||
const labels = labelsFor({
|
||||
name,
|
||||
factory: "getTaggedUnionMatcher",
|
||||
typeName: "Flag",
|
||||
typeSource: FLAG_SOURCE,
|
||||
body: " /*COMPLETE*/",
|
||||
});
|
||||
|
||||
// Assert
|
||||
return labels.then((result) => {
|
||||
assert.deepEqual([...result], ["false", "null", "true", "undefined"]);
|
||||
});
|
||||
});
|
||||
|
||||
// `Mixed` has two common keys, but `id`'s value is not a tag, so only `kind`
|
||||
// may serve as the discriminant.
|
||||
const MIXED_SOURCE = `type Mixed = { id: Date; kind: "a"; a: number } | { id: Date; kind: "b"; b: number };`;
|
||||
|
||||
+32
-17
@@ -1,4 +1,4 @@
|
||||
import type { Exact, UnknownRecord } from "type-fest";
|
||||
import type { Exact, SetRequired, UnknownRecord } from "type-fest";
|
||||
|
||||
import type {
|
||||
HandlerMap,
|
||||
@@ -28,34 +28,49 @@ type Discriminated<T extends object> = {
|
||||
[K in keyof T]: T[K] extends Matchable ? K : never;
|
||||
}[keyof T];
|
||||
|
||||
// The member(s) of `T` tagged `V`. `Extract` distributes over the union, so a
|
||||
// The member(s) of `T` narrowed to the tag(s) `V`. Distributes over `T`, so a
|
||||
// duplicated tag maps to a union of members rather than silently dropping one.
|
||||
// A member whose `K` cannot take `V` drops out; the rest have `K` narrowed to
|
||||
// `Extract<T[K], V>`. `T[K] extends V` keeps an exact member (a discriminated
|
||||
// union's declared interface) untouched, so only a property that is itself a
|
||||
// union — or optional — goes through the mapped form. `SetRequired` makes `K`
|
||||
// required unless `V` admits `undefined`: a defined tag yields `{ type: "x" }`,
|
||||
// while the `undefined` tag keeps `{ type?: never }` (absence) or
|
||||
// `{ type?: undefined }` when the property admits an explicit `undefined`.
|
||||
// Keyed by `PatternKey`, so `boolean`/`null`/`undefined` tags can key a mapped
|
||||
// type; `Member` inverts the projection against the tag set to recover the
|
||||
// member.
|
||||
// type; `Member` inverts the projection against the tag set to recover the tag.
|
||||
type Narrowed<T extends object, K extends keyof T, V> = T extends object
|
||||
? [Extract<T[K], V>] extends [never]
|
||||
? never
|
||||
: T[K] extends V
|
||||
? T
|
||||
: undefined extends V
|
||||
? { [P in keyof T]: P extends K ? Extract<T[P], V> : T[P] }
|
||||
: SetRequired<
|
||||
{ [P in keyof T]: P extends K ? Extract<T[P], V> : T[P] },
|
||||
K
|
||||
>
|
||||
: never;
|
||||
|
||||
type MapTaggedUnion<T extends object, K extends keyof T> = {
|
||||
[P in PatternKey<Tags<T, K>>]: Extract<T, Record<K, Member<Tags<T, K>, P>>>;
|
||||
[P in PatternKey<Tags<T, K>>]: Narrowed<T, K, Member<Tags<T, K>, P>>;
|
||||
};
|
||||
|
||||
type Handlers<T extends object, K extends keyof T, R> = {
|
||||
[P in PatternKey<Tags<T, K>>]: UnaryFn<MapTaggedUnion<T, K>[P], R>;
|
||||
};
|
||||
|
||||
// The members `Handled` covers. Mapping over the projected keys keeps every
|
||||
// index within `MapTaggedUnion`'s keys, and the conditional drops a stray key
|
||||
// outside `T` so it cannot widen the remainder. The remainder is
|
||||
// `Exclude<T, …>`, mirroring the primitive-union matcher's
|
||||
// `Exclude<T, Member<T, keyof Handled>>`.
|
||||
type HandledMembers<T extends object, K extends keyof T, Handled> = {
|
||||
[P in PatternKey<Tags<T, K>>]: P extends keyof Handled
|
||||
? MapTaggedUnion<T, K>[P]
|
||||
: never;
|
||||
}[PatternKey<Tags<T, K>>];
|
||||
// The tag values whose `PatternKey` is handled.
|
||||
type HandledTags<T extends object, K extends keyof T, Handled> = Member<
|
||||
Tags<T, K>,
|
||||
keyof Handled
|
||||
>;
|
||||
|
||||
// The fallback is a *second argument*, not a property of the handler map, so
|
||||
// its parameter can be the remainder the map left uncovered. See development/library.md.
|
||||
// its parameter can be the remainder the map left uncovered: the members
|
||||
// narrowed to the tags the map did not handle. See development/library.md.
|
||||
type Fallback<T extends object, K extends keyof T, Handled, R> = UnaryFn<
|
||||
Exclude<T, HandledMembers<T, K, Handled>>,
|
||||
Narrowed<T, K, Exclude<Tags<T, K>, HandledTags<T, K, Handled>>>,
|
||||
R
|
||||
>;
|
||||
|
||||
|
||||
Reference in new issue
Block a user