Compare commits
200
Commits
9a242225ee
..
0.4.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7e7f716424 | ||
|
|
62db7de537 | ||
|
|
ff823b3cba | ||
|
|
eeb831b717 | ||
|
|
ae7ffb6fa2 | ||
|
|
0d6a3f1b9b | ||
|
|
8615723c64 | ||
|
|
935e82d205 | ||
|
|
c7223dbe69 | ||
|
|
2d3577716d | ||
|
|
cc88c07961 | ||
|
|
62c37e6d89 | ||
|
|
947eac8089 | ||
|
|
eea2fbb17d | ||
|
|
b278a153d3 | ||
|
|
8b73143740 | ||
|
|
13497d1df8 | ||
|
|
998c4bfd80 | ||
|
|
9f56d7ae8e | ||
|
|
94ccc16963 | ||
|
|
0b97632a7c | ||
|
|
6f87c2f3b5 | ||
|
|
88159296d4 | ||
|
|
800c11139d | ||
|
|
05fad0fcd6 | ||
|
|
58d127da4e | ||
|
|
165bd9e3df | ||
|
|
02634f41de | ||
|
|
9da5b5dbf2 | ||
|
|
dc57529f0f | ||
|
|
484e5c8ca5 | ||
|
|
c51e32d6a6 | ||
|
|
9e5522c131 | ||
|
|
ee146ce350 | ||
|
|
33c6d9dc8d | ||
|
|
65e885989b | ||
|
|
16092350b8 | ||
|
|
a3eb6183af | ||
|
|
ce3d618757 | ||
|
|
73e5bc0093 | ||
|
|
08513b36a9 | ||
|
|
068d6b4998 | ||
|
|
fa0b7f2e84 | ||
|
|
71ecd508b7 | ||
|
|
c13bc2f408 | ||
|
|
8e2691e6aa | ||
|
|
16650b07e3 | ||
|
|
a0f0894339 | ||
|
|
ed71929365 | ||
|
|
cce030b8e5 | ||
|
|
2ff67801e0 | ||
|
|
62a5599ab3 | ||
|
|
34567856a5 | ||
|
|
a25ac6d1e2 | ||
|
|
40bf652b97 | ||
|
|
1e13917cbe | ||
|
|
42281a0f10 | ||
|
|
c15bc0153e | ||
|
|
ae319f6547 | ||
|
|
63e8edce79 | ||
|
|
b456a430a7 | ||
|
|
36d8c4feae | ||
|
|
d646fd1ec4 | ||
|
|
177d63fa95 | ||
|
|
f6f820a648 | ||
|
|
c5cc903221 | ||
|
|
cf73857931 | ||
|
|
9f038a230d | ||
|
|
1465926783 | ||
|
|
5e7d40b013 | ||
|
|
74c39e1346 | ||
|
|
7ea84b66fa | ||
|
|
95d73d11b6 | ||
|
|
fe02317fc8 | ||
|
|
84d48c6e67 | ||
|
|
c7372732ba | ||
|
|
9faa0ecc55 | ||
|
|
73669ec5b6 | ||
|
|
dc7ce22fc5 | ||
|
|
97dfe9e7b4 | ||
|
|
b92645faa1 | ||
|
|
5bb58137c4 | ||
|
|
e1dec54363 | ||
|
|
c0bba0775c | ||
|
|
b8d235df89 | ||
|
|
76fe8993a7 | ||
|
|
f984576d4e | ||
|
|
79b4d8c005 | ||
|
|
60e416b0fe | ||
|
|
e90d2549e3 | ||
|
|
8915eb8faa | ||
|
|
75f2185b32 | ||
|
|
9c472c88c2 | ||
|
|
16962e947e | ||
|
|
be0ca717d0 | ||
|
|
5a3ee3b8cc | ||
|
|
77fb604d7e | ||
|
|
1b2b50304e | ||
|
|
048a8870e6 | ||
|
|
f0b28c81c0 | ||
|
|
1dfb979ebb | ||
|
|
f04ad3d5bc | ||
|
|
93cbfcf6b1 | ||
|
|
3e33b51d1b | ||
|
|
abbdf4410e | ||
|
|
245dfaf198 | ||
|
|
b9fe21175f | ||
|
|
5292455dbc | ||
|
|
d1ef039688 | ||
|
|
c65f86e5d5 | ||
|
|
b5bfe83140 | ||
|
|
60bf1bb3a9 | ||
|
|
24bd0270c0 | ||
|
|
475136c1e5 | ||
|
|
67e3e13b5e | ||
|
|
595759ca7a | ||
|
|
8495adc47b | ||
|
|
3df672d306 | ||
|
|
42cbe2194e | ||
|
|
9dd973a950 | ||
|
|
034296f011 | ||
|
|
78bec7a5eb | ||
|
|
224afa9afb | ||
|
|
a865b466bd | ||
|
|
7216c418d0 | ||
|
|
1191f3c4d9 | ||
|
|
eee73a151d | ||
|
|
4d92ce9f9a | ||
|
|
b29f924416 | ||
|
|
a0dd187042 | ||
|
|
e7a058d608 | ||
|
|
e96c3f89ac | ||
|
|
78aa97d670 | ||
|
|
13ea134d05 | ||
|
|
b18e03ff97 | ||
|
|
0ceb5a586e | ||
|
|
fe9d59f8d4 | ||
|
|
303544796e | ||
|
|
968a478c93 | ||
|
|
e86709f593 | ||
|
|
1709fbe842 | ||
|
|
0b461c233f | ||
|
|
8d1a03f025 | ||
|
|
b7d1dbdf06 | ||
|
|
99bda289a6 | ||
|
|
0c6d1483de | ||
|
|
9a08262076 | ||
|
|
672fd1f7e4 | ||
|
|
844e80d650 | ||
|
|
8c2855aa92 | ||
|
|
8efd13b2f4 | ||
|
|
93cb37441d | ||
|
|
863198d472 | ||
|
|
15aef06e32 | ||
|
|
b50149aad6 | ||
|
|
06bc6bc43e | ||
|
|
75d605fabe | ||
|
|
837203c29e | ||
|
|
c7f566500e | ||
|
|
09c5b129bb | ||
|
|
b9fb054176 | ||
|
|
464789b385 | ||
|
|
49a78f3683 | ||
|
|
892aead383 | ||
|
|
682ecf1163 | ||
|
|
8b4722da26 | ||
|
|
da5ab79f9b | ||
|
|
3d0fe18d6a | ||
|
|
103cf04f8d | ||
|
|
7973bf0d0b | ||
|
|
8940537fc0 | ||
|
|
436b49e3be | ||
|
|
8924dd67d3 | ||
|
|
538272c222 | ||
|
|
e78f624cbb | ||
|
|
1a749b13d6 | ||
|
|
1fe3dbe28b | ||
|
|
8a8d57172c | ||
|
|
7e9401590e | ||
|
|
74e4538094 | ||
|
|
34e9b52ee8 | ||
|
|
2b3ef0f721 | ||
|
|
ec98223f8d | ||
|
|
3fa72820df | ||
|
|
01d1084e1f | ||
|
|
24a3880aad | ||
|
|
7de4604ab4 | ||
|
|
b649013d1c | ||
|
|
c6f7a5d1b0 | ||
|
|
99fd85ca7e | ||
|
|
b3a4e14f45 | ||
|
|
c3f913fae9 | ||
|
|
0598a9eb4a | ||
|
|
7349d0dec2 | ||
|
|
e45592ae00 | ||
|
|
45b6c141e8 | ||
|
|
9bc87aab87 | ||
|
|
0c3e51c768 | ||
|
|
ab6eb0f34c | ||
|
|
cb5b302238 |
No files matched your search
@@ -0,0 +1,208 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
# Releases are tag pushes (`scripts/release.sh` tags bare `x.y.z`). A
|
||||||
|
# `branches` filter alone matches no tag ref, so without this both the
|
||||||
|
# tag-gated `publish` job and the coverage publish step never fire.
|
||||||
|
tags: ["*"]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
workflow_dispatch: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Cheap gate that collapses the release double-run. `scripts/release.sh`
|
||||||
|
# pushes `main` and the tag seconds apart, and the tag points at exactly
|
||||||
|
# the HEAD commit that push delivers — so the branch run would verify the
|
||||||
|
# identical tree the tag run verifies anyway (plus `publish`). When a push
|
||||||
|
# to `main` is headed by a release commit (`:rocket: Release x.y.z`, the
|
||||||
|
# single commit release.sh creates), the full CI is skipped here and the
|
||||||
|
# tag run becomes the authoritative one for that SHA. All other pushes —
|
||||||
|
# PRs, tags, ordinary `main` merges — see `skip=false` and run as before.
|
||||||
|
#
|
||||||
|
# Coupling: the pattern below MUST stay in sync with the release commit
|
||||||
|
# message in `scripts/release.sh`. Failure mode if the tag push ever fails
|
||||||
|
# after `main` accepted the release commit: no CI fires; fix by re-running
|
||||||
|
# `git push --tags`.
|
||||||
|
release-gate:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
skip: ${{ steps.decide.outputs.skip }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- id: decide
|
||||||
|
env:
|
||||||
|
REF: ${{ gitea.ref }}
|
||||||
|
run: |
|
||||||
|
# Keyed on the ref, not just the message: a tag run checks out
|
||||||
|
# the same release commit, and `publish` needs its `build`.
|
||||||
|
if [ "${REF}" = "refs/heads/main" ] &&
|
||||||
|
git log -1 --format=%s | grep -qE '^:rocket: Release [0-9]+\.[0-9]+\.[0-9]+$'; then
|
||||||
|
echo 'Release commit on main — the tag run covers this SHA; skipping full CI.'
|
||||||
|
echo 'skip=true' >>"${GITHUB_OUTPUT}"
|
||||||
|
else
|
||||||
|
echo 'skip=false' >>"${GITHUB_OUTPUT}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
build:
|
||||||
|
needs: release-gate
|
||||||
|
if: needs.release-gate.outputs.skip != 'true'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
# `image` extends the runner's default job image (catthehacker/act)
|
||||||
|
# with Node 26 pre-planted in the tool cache layout, so setup-node's
|
||||||
|
# version probe hits and never downloads (see docker/Dockerfile). The
|
||||||
|
# tag MUST equal the exact version pinned in `.node-version`; the bump
|
||||||
|
# ritual is documented in CONTRIBUTING.md § CI runner image. The volume
|
||||||
|
# bind-mounts the shared pages tree so the
|
||||||
|
# coverage step below can write into it; the runner whitelists this
|
||||||
|
# path via `container.valid_volumes` (docker-space `setup/gitea.sh`).
|
||||||
|
container:
|
||||||
|
image: gitea.e1nsnull.de/tmu/act-ci:26.8.2
|
||||||
|
volumes:
|
||||||
|
- /data/gitea-pages:/data/gitea-pages
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
# Fail fast when the job container is not the baked image: a stale
|
||||||
|
# tag on the runner (`forcePull=false` in its pull log) silently
|
||||||
|
# reintroduces the per-job download. Cheap, and it names the
|
||||||
|
# invariant.
|
||||||
|
- name: Assert the baked tool cache is present
|
||||||
|
run: |
|
||||||
|
test -f "/opt/hostedtoolcache/node/$(tr -d '[:space:]' < .node-version)/x64.complete"
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
cache: "npm"
|
||||||
|
- run: npm ci
|
||||||
|
- run: npm run build
|
||||||
|
- run: npm run check
|
||||||
|
- run: npm run test:ci
|
||||||
|
# Publish this tag's coverage to the self-hosted pages server,
|
||||||
|
# served read-only at
|
||||||
|
# https://pages.e1nsnull.de/<owner>/<repo>/<tag>/coverage/. Wipe only
|
||||||
|
# this tag's `coverage/`, so sibling docs/landing trees and older
|
||||||
|
# tags survive; pruning stale tags is a manual chore. The
|
||||||
|
# precompress pass emits `.br` / `.gz` / `.zst` sidecars next to
|
||||||
|
# every text asset, so `static-web-server` can serve the precompressed
|
||||||
|
# variant and keep the original as fallback.
|
||||||
|
- name: Publish coverage to the pages server
|
||||||
|
if: startsWith(gitea.ref, 'refs/tags/')
|
||||||
|
env:
|
||||||
|
REPO: ${{ github.repository }}
|
||||||
|
REF: ${{ gitea.ref }}
|
||||||
|
run: |
|
||||||
|
TAG="${REF#refs/tags/}"
|
||||||
|
DEST="/data/gitea-pages/${REPO}/${TAG}/coverage"
|
||||||
|
rm -rf "${DEST}"
|
||||||
|
mkdir -p "${DEST}"
|
||||||
|
cp -R coverage/. "${DEST}/"
|
||||||
|
node --strip-types scripts/precompress.ts "${DEST}"
|
||||||
|
echo "Coverage: https://pages.e1nsnull.de/${REPO}/${TAG}/coverage/"
|
||||||
|
# Fast, offline packaging gate. `attw` stays in `publish` (it needs
|
||||||
|
# a pack + full resolution matrix); `publint` packs too but is cheap
|
||||||
|
# enough to run on every push so a packaging break fails here, not
|
||||||
|
# at release time.
|
||||||
|
- run: npm run publish:publint
|
||||||
|
# Persist the exact dist/ that `check`, `test:ci` and `publint` were
|
||||||
|
# run against, so `publish` ships those bytes instead of rebuilding
|
||||||
|
# (which could in principle differ and would pay the build twice).
|
||||||
|
- uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: dist
|
||||||
|
path: dist/
|
||||||
|
|
||||||
|
# Advisory scans (dead code, dependency freshness). Non-blocking: surfaced in
|
||||||
|
# the Actions tab for visibility, but must never gate a merge — so
|
||||||
|
# continue-on-error and intentionally NOT in `publish`'s `needs`.
|
||||||
|
maintain:
|
||||||
|
needs: release-gate
|
||||||
|
if: needs.release-gate.outputs.skip != 'true'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
# Same baked image as `build` — without it this job re-downloads Node
|
||||||
|
# per run (see docker/Dockerfile).
|
||||||
|
container:
|
||||||
|
image: gitea.e1nsnull.de/tmu/act-ci:26.8.2
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
cache: "npm"
|
||||||
|
- run: npm ci
|
||||||
|
- run: npm run maintain
|
||||||
|
|
||||||
|
publish:
|
||||||
|
if: startsWith(gitea.ref, 'refs/tags/')
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
# Same baked image as `build` — setup-node still owns the registry-url
|
||||||
|
# `.npmrc` rewrite here; only the Node download is skipped.
|
||||||
|
container:
|
||||||
|
image: gitea.e1nsnull.de/tmu/act-ci:26.8.2
|
||||||
|
# The release page is created with the run's automatic Gitea token
|
||||||
|
# (`github.token`), so it needs `contents: write`.
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
# The npm token is optional: `secrets` is not an allowed context in a
|
||||||
|
# step `if` (see GitHub's context-availability table), so it is lifted
|
||||||
|
# into job-level `env`, where an unset secret arrives as the empty
|
||||||
|
# string and skips the publish rather than attempting an unauthenticated
|
||||||
|
# one. Set NPM_TOKEN in the Gitea repo: Settings → Actions → Secrets.
|
||||||
|
env:
|
||||||
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
# Same lockfile/key as `build`, and tag runs can read caches
|
||||||
|
# saved on `main` — without this, every release pays a cold
|
||||||
|
# `npm ci` despite the warm shared npm cache.
|
||||||
|
cache: "npm"
|
||||||
|
registry-url: "https://registry.npmjs.org/"
|
||||||
|
- run: npm ci
|
||||||
|
# Consume the dist/ that `build` produced and gated, instead of
|
||||||
|
# rebuilding here — `publish` must ship the tested artifact.
|
||||||
|
- uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
name: dist
|
||||||
|
path: dist/
|
||||||
|
- run: npm run publish:publint
|
||||||
|
- run: npm run publish:attw
|
||||||
|
# The Gitea release page is created *before* `npm publish` on
|
||||||
|
# purpose: a broken page then fails CI without burning an npm
|
||||||
|
# version. The page is cheap to retry, a published version is not.
|
||||||
|
# The body is the matching Keep-a-Changelog section; an unknown tag
|
||||||
|
# makes the extractor exit non-zero, so the page can never go up
|
||||||
|
# empty.
|
||||||
|
- name: Extract release notes from CHANGELOG.md
|
||||||
|
env:
|
||||||
|
TAG_REF: ${{ gitea.ref }}
|
||||||
|
run: ./scripts/release-notes.sh "${TAG_REF#refs/tags/}" > release-notes.md
|
||||||
|
- name: Create the Gitea release
|
||||||
|
id: gitea_release
|
||||||
|
uses: https://gitea.com/actions/gitea-release-action@v1
|
||||||
|
with:
|
||||||
|
body_path: release-notes.md
|
||||||
|
- name: Publish to npm
|
||||||
|
id: npm_publish
|
||||||
|
if: env.NPM_TOKEN != ''
|
||||||
|
run: npm publish --access public
|
||||||
|
env:
|
||||||
|
NODE_AUTH_TOKEN: ${{ env.NPM_TOKEN }}
|
||||||
|
# All-or-nothing: the tag is only released once *both* the release
|
||||||
|
# page and the npm package are up. A skipped npm publish (NPM_TOKEN
|
||||||
|
# unset) has no `success` outcome, so `always()` reaches this check
|
||||||
|
# even after a failure and turns the skipped half into an explicit
|
||||||
|
# red job instead of a silently green one.
|
||||||
|
- name: Require both releases
|
||||||
|
if: always()
|
||||||
|
run: |
|
||||||
|
GITEA="${{ steps.gitea_release.outcome }}"
|
||||||
|
NPM="${{ steps.npm_publish.outcome }}"
|
||||||
|
if [ "${GITEA}" != success ] || [ "${NPM}" != success ]; then
|
||||||
|
echo "::error::incomplete release — gitea=${GITEA:-skipped} npm=${NPM:-skipped}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
name: CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "npm"
|
|
||||||
- run: npm ci
|
|
||||||
- run: npm run build
|
|
||||||
- run: npm run check
|
|
||||||
- run: npm run test:ci
|
|
||||||
- name: Upload coverage
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: coverage
|
|
||||||
path: coverage
|
|
||||||
|
|
||||||
publish:
|
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
|
||||||
needs: build
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
registry-url: "https://registry.npmjs.org/"
|
|
||||||
- run: npm ci
|
|
||||||
- run: npm run build
|
|
||||||
- run: npm publish --access public
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
+4
-15
@@ -1,15 +1,8 @@
|
|||||||
# Logs
|
|
||||||
logs
|
|
||||||
*.log
|
|
||||||
npm-debug.log*
|
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
pnpm-debug.log*
|
|
||||||
lerna-debug.log*
|
|
||||||
|
|
||||||
node_modules
|
node_modules
|
||||||
dist
|
dist
|
||||||
dist-ssr
|
coverage
|
||||||
|
*.log
|
||||||
|
*.tsbuildinfo
|
||||||
*.local
|
*.local
|
||||||
|
|
||||||
# Editor directories and files
|
# Editor directories and files
|
||||||
@@ -17,10 +10,6 @@ dist-ssr
|
|||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
!.vscode/settings.json
|
!.vscode/settings.json
|
||||||
!.vscode/tasks.json
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
.idea
|
.idea
|
||||||
.DS_Store
|
.DS_Store
|
||||||
*.suo
|
|
||||||
*.ntvs*
|
|
||||||
*.njsproj
|
|
||||||
*.sln
|
|
||||||
*.sw?
|
|
||||||
+1
-1
@@ -1 +1 @@
|
|||||||
26
|
26.8.2
|
||||||
-15
@@ -1,15 +0,0 @@
|
|||||||
node_modules/
|
|
||||||
coverage/
|
|
||||||
*.log
|
|
||||||
*.tsbuildinfo
|
|
||||||
src/
|
|
||||||
.vscode/
|
|
||||||
.editorconfig
|
|
||||||
.oxfmtrc.json
|
|
||||||
.oxlintrc.json
|
|
||||||
.node-version
|
|
||||||
cspell.json
|
|
||||||
lefthook.yml
|
|
||||||
.sortpackagerc.json
|
|
||||||
LICENSE
|
|
||||||
commit-message-template
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# Turn the `engines` field from a warning into a gate. By default a Node
|
||||||
|
# version mismatch is only reported as a notice, so an install run under an
|
||||||
|
# unpinned Node still succeeds and silently rewrites package-lock.json using
|
||||||
|
# that older npm's resolution rules. Refuse the install instead.
|
||||||
|
engine-strict=true
|
||||||
+11
-1
@@ -1,9 +1,19 @@
|
|||||||
{
|
{
|
||||||
|
"$schema": "./node_modules/oxfmt/configuration_schema.json",
|
||||||
"semi": true,
|
"semi": true,
|
||||||
"singleQuote": false,
|
"singleQuote": false,
|
||||||
"trailingComma": "all",
|
"trailingComma": "all",
|
||||||
"printWidth": 80,
|
"printWidth": 80,
|
||||||
"tabWidth": 4,
|
"tabWidth": 4,
|
||||||
"endOfLine": "lf",
|
"endOfLine": "lf",
|
||||||
"arrowParens": "always"
|
"arrowParens": "always",
|
||||||
|
"sortPackageJson": true,
|
||||||
|
"sortImports": true,
|
||||||
|
"ignorePatterns": [
|
||||||
|
"dist",
|
||||||
|
"coverage",
|
||||||
|
"node_modules",
|
||||||
|
"package-lock.json",
|
||||||
|
"*.tsbuildinfo"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
+26
-12
@@ -1,11 +1,6 @@
|
|||||||
{
|
{
|
||||||
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
||||||
"plugins": [
|
"plugins": ["typescript", "unicorn", "oxc", "import"],
|
||||||
"typescript",
|
|
||||||
"unicorn",
|
|
||||||
"oxc",
|
|
||||||
"import"
|
|
||||||
],
|
|
||||||
"categories": {
|
"categories": {
|
||||||
"correctness": "error",
|
"correctness": "error",
|
||||||
"suspicious": "error",
|
"suspicious": "error",
|
||||||
@@ -18,13 +13,20 @@
|
|||||||
"eslint/no-undefined": "off",
|
"eslint/no-undefined": "off",
|
||||||
"eslint/sort-keys": "off",
|
"eslint/sort-keys": "off",
|
||||||
"eslint/id-length": "off",
|
"eslint/id-length": "off",
|
||||||
"import/no-named-export": "off"
|
"eslint/capitalized-comments": "off",
|
||||||
},
|
"eslint/no-ternary": "off",
|
||||||
"env": {
|
"import/no-named-export": "off",
|
||||||
"builtin": true,
|
"eslint/one-var": "off",
|
||||||
"es2024": true,
|
"import/group-exports": "off",
|
||||||
"node": true
|
"import/exports-last": "off",
|
||||||
|
"eslint/sort-imports": "off",
|
||||||
|
"import/consistent-type-specifier-style": "off",
|
||||||
|
"unicorn/prefer-export-from": "off",
|
||||||
|
"typescript/method-signature-style": "off",
|
||||||
|
"typescript/promise-function-async": "off"
|
||||||
},
|
},
|
||||||
|
"options": { "typeAware": true },
|
||||||
|
"env": { "builtin": true, "es2024": true, "node": true },
|
||||||
"overrides": [
|
"overrides": [
|
||||||
{
|
{
|
||||||
"files": ["**/*.test.ts"],
|
"files": ["**/*.test.ts"],
|
||||||
@@ -34,6 +36,18 @@
|
|||||||
"import/no-nodejs-modules": "off",
|
"import/no-nodejs-modules": "off",
|
||||||
"eslint/no-magic-numbers": "off"
|
"eslint/no-magic-numbers": "off"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"files": ["scripts/**/*.ts"],
|
||||||
|
"rules": {
|
||||||
|
"import/no-nodejs-modules": "off"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"files": ["src/util/__tests__/**"],
|
||||||
|
"rules": {
|
||||||
|
"import/no-nodejs-modules": "off"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"ignorePatterns": ["dist", "node_modules", "coverage"]
|
"ignorePatterns": ["dist", "node_modules", "coverage"]
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
*
|
||||||
|
!.gitignore
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"packages": ["npm:@spences10/pi-lsp@0.0.46"]
|
||||||
|
}
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/sort-package-json.json"
|
|
||||||
}
|
|
||||||
Vendored
+4
-1
@@ -1,7 +1,10 @@
|
|||||||
{
|
{
|
||||||
"recommendations": [
|
"recommendations": [
|
||||||
|
"connor4312.nodejs-testing",
|
||||||
"oxc.oxc-vscode",
|
"oxc.oxc-vscode",
|
||||||
"streetsidesoftware.code-spell-checker",
|
"streetsidesoftware.code-spell-checker",
|
||||||
"typescriptteam.native-preview"
|
"typescriptteam.native-preview",
|
||||||
|
"sandy081.todotasks",
|
||||||
|
"EditorConfig.EditorConfig"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
Vendored
+15
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Debug current test file",
|
||||||
|
"runtimeExecutable": "node",
|
||||||
|
"runtimeArgs": ["--test", "--strip-types"],
|
||||||
|
"args": ["${file}"],
|
||||||
|
"cwd": "${workspaceFolder}",
|
||||||
|
"console": "integratedTerminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Vendored
+33
-5
@@ -1,22 +1,50 @@
|
|||||||
{
|
{
|
||||||
"typescript.tsdk": "node_modules/typescript/lib",
|
"nodejs-testing.extensions": [
|
||||||
|
{
|
||||||
|
"extensions": ["mjs", "cjs", "js"],
|
||||||
|
"parameters": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"extensions": ["ts"],
|
||||||
|
"parameters": ["--strip-types"]
|
||||||
|
}
|
||||||
|
],
|
||||||
"[typescript]": {
|
"[typescript]": {
|
||||||
"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": "esbenp.prettier-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
|
"[jsonc]": {
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
|
"[markdown]": {
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true
|
"editor.formatOnSave": true
|
||||||
},
|
},
|
||||||
"[mdx]": {
|
"[mdx]": {
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
|
"[yaml]": {
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true
|
"editor.formatOnSave": true
|
||||||
},
|
},
|
||||||
"editor.defaultFormatter": "oxc.oxc-vscode",
|
"editor.defaultFormatter": "oxc.oxc-vscode",
|
||||||
"editor.formatOnSave": true,
|
"editor.formatOnSave": true
|
||||||
"js/ts.tsdk.path": "node_modules/typescript/lib"
|
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
Machine entry point for AI coding agents working in this repo. The authoritative
|
||||||
|
guidance for humans lives in [CONTRIBUTING.md](./CONTRIBUTING.md) and
|
||||||
|
[README.md](./README.md); this file only points at it and states the stable
|
||||||
|
first-action facts. Do not restate evolving prose here — it will drift.
|
||||||
|
|
||||||
|
## First action
|
||||||
|
|
||||||
|
- Project: F#-style pattern matching for TypeScript/ESM. Node `>=26` (pinned via `.node-version`), ESM-only (no CommonJS shim).
|
||||||
|
- **While iterating:** `npm run test` (`check:tsc` + the unit suite) for fast feedback on the files you changed.
|
||||||
|
- **Optional code intelligence:** this repo installs `@spences10/pi-lsp` (pinned in `.pi/settings.json`) as a project-local pi extension. It talks to the repo's own TypeScript 7 via `tsc --lsp --stdio` and exposes **read-only** tools — `lsp_hover`, `lsp_definition`, `lsp_references`, `lsp_find_symbol`, `lsp_document_symbols`, `lsp_diagnostics(_many)`. Prefer `lsp_references` over `grep -w` for widely-colliding identifiers (`matches`, `type`, …); use `lsp_hover` to read inferred types on generic-heavy code. It has no rename / code-action / apply-edit surface — the write side is pi's `edit` tool + `check:tsc`. Treat empty LSP output as _inconclusive_, not success: **`npm run test` / `npm run verify` remain the sole authoritative gate** (see the next bullet). The server keeps running across that gate with a ~5 min idle timeout and registers no file watchers, so if you change `tsconfig.json` / `package.json` mid-session its diagnostics can be stale — when LSP output disagrees with `check:tsc`, trust `check:tsc` and restart pi (or wait out the idle timeout) before concluding the LSP is wrong.
|
||||||
|
- **Definition of done — run this before you call the work finished:** `npm run verify`. If all green, commit. If red, look at the output, fix the root cause, and re-run.
|
||||||
|
- **On commit:** write a good message (see [CONTRIBUTING.md § Commit messages](./CONTRIBUTING.md#commit-messages)). Lefthook's pre-commit hook already runs the fast, offline, staged-file checks — don't run them by hand. If the hook fails on style, `npm run fix`, restage, recommit.
|
||||||
|
- **Document decisions where the next maintainer will look:** rationale, rejected alternatives and known issues go in `development/<category>.md` (see [development/README.md](./development/README.md)); the actionable rule stays in [CONTRIBUTING.md](./CONTRIBUTING.md) and links to it. Write each fact once — never copy the rule into `development/` or the reason into `CONTRIBUTING.md` — and change both in the same commit when a rule changes.
|
||||||
|
- **`npm run maintain` is NOT part of the feature loop.** Its scans are advisory, never a gate; run them only on an explicit maintenance / update-deps branch.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm run test # while iterating (fast feedback)
|
||||||
|
npm run verify # definition of done: whole-project correctness, one shot
|
||||||
|
```
|
||||||
|
|
||||||
|
## Never do
|
||||||
|
|
||||||
|
Don't silence the type system to force a green run. As an agent these are forbidden:
|
||||||
|
|
||||||
|
- `// @ts-nocheck`, `// @ts-ignore`, `// @ts-expect-error`
|
||||||
|
- `// oxlint-disable` / `// oxlint-disable-next-line` — the sole exception is the fixed file-level `typescript/no-floating-promises` header at the top of a `*.test.ts` file, spelled exactly as [CONTRIBUTING.md § Rules the tools don't enforce](./CONTRIBUTING.md#rules-the-tools-dont-enforce) prescribes
|
||||||
|
- `as` casts used to push an expression through (type-aware oxlint already flags unsafe assertions)
|
||||||
|
|
||||||
|
Fix the root cause with the type system instead — narrowing, generics, `satisfies`, conditional / mapped types, utility types (`NonNullable`, `Exclude`, …). TypeScript can express it; that's the intended tool. The `oxlint-disable`-location rule in [CONTRIBUTING.md § Rules the tools don't enforce](./CONTRIBUTING.md#rules-the-tools-dont-enforce) is a **human** last-resort convention (so a reviewer can spot a deliberate suppression) — it is not permission for you to add one, except the one fixed `*.test.ts` file-level header named there. If the types genuinely cannot express something, stop and surface the conflict (commit message / handover) rather than suppress it.
|
||||||
|
|
||||||
|
The same applies to the checks themselves: **never `git commit --no-verify`** (or otherwise skip a pre-commit / pre-push hook). The checks are fast and offline, so a redundant run is fine — bypassing a hook to get green is the identical anti-pattern. If a commit already skipped a hook, redo it through one: `git reset --soft HEAD~1 && git commit -C <skipped-sha>`.
|
||||||
|
|
||||||
|
Never start a long-lived / blocking process such as `npm run watch`. It runs until a human stops it with Ctrl-C, so in an agent turn it hangs forever and floods the context with continuous output. Reach for a one-shot command instead — `npm run test` (or `npm run check`) — to get feedback.
|
||||||
|
|
||||||
|
## Backlog
|
||||||
|
|
||||||
|
`backlog.tasks` uses the vscode-todotasks format (not Markdown). A line ending in `:` is a project; every other line is a task. Status glyphs: `☐` open, `✔` done, `✘` cancelled; subtasks nest by indentation. Inline `@tags` carry metadata — `@done` / `@cancelled` mark completion, `@critical` / `@high` / `@low` / `@today` set priority. The `(…)` timestamp after `@done` is editor-generated: omit it when checking off by hand.
|
||||||
|
|
||||||
|
**Required coupling:** a `✔` line _must_ also carry `@done`, and a `✘` line _must_ carry `@cancelled`. The `sandy081.todotasks` extension treats the glyph as the completion signal, then unconditionally searches for the matching tag to decorate; a bare `✔`/`✘` with no tag makes it compute an illegal `Range` (negative character offset) that throws and kills all highlighting/decoration for the document. A `☐` may stand alone. So check off by hand as `✔ … @done` (optionally `@done (timestamp)`), never a lone `✔`.
|
||||||
|
|
||||||
|
### Working on tasks
|
||||||
|
|
||||||
|
Every task — with or without subtasks — goes through the complete branching model:
|
||||||
|
|
||||||
|
- Create the branch with `npm run create:branch -- <prefix>/<desc>`, inferring the prefix from the task content (`feature/…` / `fix/…` / `chore/…`) — do not hand-write `git switch -c`, the command enforces the clean-tree / current-`main` / green-baseline precondition. Work with commits (each subtask gets one or more), then present a concise handover for the user to review. Use this fixed shape:
|
||||||
|
|
||||||
|
```md
|
||||||
|
## Handover — <branch>
|
||||||
|
|
||||||
|
**Implemented:** <what was built, and how>
|
||||||
|
**Judgement calls:** <where the task was unclear, and what you assumed>
|
||||||
|
**Known problems:** <open issues, caveats, follow-ups>
|
||||||
|
```
|
||||||
|
|
||||||
|
Once the user has no further objections, merge back: `npm run create:finish` (on the branch — it merges `--no-ff`, runs `npm run verify`, and deletes the branch). The branching model is documented in [CONTRIBUTING.md § Branching model](./CONTRIBUTING.md#branching-model).
|
||||||
|
|
||||||
|
Follow [CONTRIBUTING.md § Testing discipline (type-driven)](./CONTRIBUTING.md#testing-discipline-type-driven) throughout.
|
||||||
|
|
||||||
|
## Read these
|
||||||
|
|
||||||
|
- [CONTRIBUTING.md § Rules the tools don't enforce](./CONTRIBUTING.md#rules-the-tools-dont-enforce) — the constraints the linters don't catch; CI/review bounce these. **The most important section.**
|
||||||
|
- [CONTRIBUTING.md § Testing discipline (type-driven)](./CONTRIBUTING.md#testing-discipline-type-driven) — write the `expectTypeOf` (type) before the `assert` (red); the types are the feature.
|
||||||
|
- [CONTRIBUTING.md § Script prefix convention](./CONTRIBUTING.md#script-prefix-convention) — adding an `npm run` script? reuse an existing prefix or it doesn't belong.
|
||||||
|
- [CONTRIBUTING.md § Commit messages](./CONTRIBUTING.md#commit-messages) — gitmoji + imperative + 50/72.
|
||||||
|
- [CONTRIBUTING.md § Feedback tiers](./CONTRIBUTING.md#feedback-tiers) — what runs when and at what cost (`watch` / pre-commit / pre-push / `check` / `verify` / `fix` / `maintain` / CI).
|
||||||
|
- [development/](./development/README.md) — the decisions, rejected alternatives and known issues behind the rules; the “why” that CONTRIBUTING.md links to. Read the relevant file before changing an area.
|
||||||
|
- [development/tooling.md](./development/tooling.md) — the rationale behind each tool choice; read before changing tooling.
|
||||||
|
- [package.json `#scripts`](./package.json) — the source of truth for every command (the `LEFTHOOK_FILES` convention scopes them to staged files vs. the whole project).
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0/).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.4.0] - 2026-09-20
|
||||||
|
|
||||||
|
- move the `_` fallback out of handlers
|
||||||
|
|
||||||
|
## [0.3.0] - 2026-09-18
|
||||||
|
|
||||||
|
- condensed primitive matcher factories down to 2 from formerly 4
|
||||||
|
- house shared test helpers under `src/util/__tests__/`
|
||||||
|
|
||||||
|
## [0.2.0] - 2026-09-16
|
||||||
|
|
||||||
|
- allow ternaries and lowercase comments in oxlint
|
||||||
|
- switch `src/primitive.ts` prose from block comments to line comments
|
||||||
|
- remove the template's `match`/`P` example modules and their documentation, and point `src/index.ts` at the primitive matchers
|
||||||
|
|
||||||
|
## [0.1.8] - 2026-09-16
|
||||||
|
|
||||||
|
- upgrade dependencies
|
||||||
|
- ignore `@types/node` in `maintain:outdated` (misleading `latest` dist-tag)
|
||||||
|
- require extremely concise prose in `development/`
|
||||||
|
|
||||||
|
## [0.1.7] - 2026-09-16
|
||||||
|
|
||||||
|
- require a short summary under `[Unreleased]` in the changelog before a branch is finished
|
||||||
|
- let `create:branch` start from a `main` that is ahead of its upstream, so a finished merge no longer blocks the next branch until it is pushed
|
||||||
|
|
||||||
|
## [0.1.6] - 2026-09-15
|
||||||
|
|
||||||
|
- restructure the documentation: README.md for users, CONTRIBUTING.md for contributors, and development/ for the decisions, rejected alternatives and known issues
|
||||||
|
- document the decisions and known issues for CI, tooling, testing, publishing and the workflow
|
||||||
|
|
||||||
|
## [0.1.5] - 2026-09-15
|
||||||
|
|
||||||
|
- improve CI configuration
|
||||||
|
|
||||||
|
## [0.1.4] - 2026-09-14
|
||||||
|
|
||||||
|
- fix CI to node from custom image
|
||||||
|
- upgrade dependencies
|
||||||
|
|
||||||
|
## [0.1.3] - 2026-09-14
|
||||||
|
|
||||||
|
- change to custom image for CI
|
||||||
|
|
||||||
|
## [0.1.2] - 2026-09-14
|
||||||
|
|
||||||
|
- upgrade dependencies
|
||||||
|
|
||||||
|
## [0.1.1] - 2026-09-14
|
||||||
|
|
||||||
|
- upgrade dependencies
|
||||||
|
|
||||||
|
## [0.1.0] - 2026-09-14
|
||||||
|
|
||||||
|
- basic setup
|
||||||
|
|
||||||
|
[Unreleased]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.4.0...main
|
||||||
|
[0.4.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.3.0...0.4.0
|
||||||
|
[0.3.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.2.0...0.3.0
|
||||||
|
[0.2.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.8...0.2.0
|
||||||
|
[0.1.8]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.7...0.1.8
|
||||||
|
[0.1.7]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.6...0.1.7
|
||||||
|
[0.1.6]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.5...0.1.6
|
||||||
|
[0.1.5]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.4...0.1.5
|
||||||
|
[0.1.4]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.3...0.1.4
|
||||||
|
[0.1.3]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.2...0.1.3
|
||||||
|
[0.1.2]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.1...0.1.2
|
||||||
|
[0.1.1]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.1.0...0.1.1
|
||||||
|
[0.1.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/20308c5a6d8cccfb09b02ac2ebebd8055e91cd11...0.1.0
|
||||||
+242
@@ -0,0 +1,242 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
This document is for maintainers and contributors working on the project
|
||||||
|
itself. End-user documentation is in [README.md](./README.md). The reasons
|
||||||
|
behind the rules here — the decisions, rejected alternatives, and known issues —
|
||||||
|
live in [development/](./development/README.md). The machine entry point for AI
|
||||||
|
coding agents is [AGENTS.md](./AGENTS.md); keep this file as the prose home for
|
||||||
|
the rules so agents and humans don't diverge.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Clone the repository.
|
||||||
|
2. Install Node.js >= 26 — see [.node-version](./.node-version); the exact pinned
|
||||||
|
version is what CI and the runner image use.
|
||||||
|
3. `npm ci`.
|
||||||
|
4. `npm run setup` — the one-time clone configuration (currently registers the
|
||||||
|
commit-message template).
|
||||||
|
|
||||||
|
## Development commands
|
||||||
|
|
||||||
|
- **Build:** `npm run build`
|
||||||
|
- **Test:** `npm run test`, `npm run test:ci`
|
||||||
|
- **Watch:** `npm run watch` - re-runs tests on file save, humans only
|
||||||
|
- **Checks:** `npm run check`, `npm run fix`
|
||||||
|
- **Verify:** `npm run verify` — the definition of done
|
||||||
|
- **Maintenance:** `npm run maintain` — advisory only
|
||||||
|
- **Individual fixes:** `npm run fix:oxfmt`, `npm run fix:oxlint`
|
||||||
|
|
||||||
|
## Feedback tiers
|
||||||
|
|
||||||
|
The tools are organized into a feedback ladder. Each tier catches different
|
||||||
|
things at different costs; the rule of thumb is "earlier tiers fire more often,
|
||||||
|
faster tiers catch less, slower tiers are more thorough":
|
||||||
|
|
||||||
|
| Tier | When | What it runs | Time |
|
||||||
|
| -------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
||||||
|
| `npm run watch` | manual | `watch:test` — re-runs tests on file save | ~0.1s |
|
||||||
|
| Pre-commit (auto) | on stage | tsc + oxlint + oxfmt + cspell (staged files only) | ~1.3s |
|
||||||
|
| Pre-push (auto) | on push | `npm test` (full tsc + unit tests) | ~3.5s |
|
||||||
|
| `npm run check` | manual | Correctness gates: tsc + oxlint + oxfmt + cspell (whole project) | ~3s |
|
||||||
|
| `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 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 |
|
||||||
|
|
||||||
|
Before pushing, run `npm run verify` — the one-shot correctness gate. Run
|
||||||
|
`npm run maintain` only on a maintenance / update-deps branch. Why the splits
|
||||||
|
are where they are: [development/workflow.md § Feedback tiers](./development/workflow.md#feedback-tiers).
|
||||||
|
|
||||||
|
## Testing discipline (type-driven)
|
||||||
|
|
||||||
|
For this library the types _are_ the feature, so development is **type-driven**:
|
||||||
|
the compile-time expectation is written before the runtime assertion, and both
|
||||||
|
before the implementation. The loop is **type → red → green → refactor**:
|
||||||
|
|
||||||
|
1. **Type** — write the compile-time expectation first
|
||||||
|
(`expectTypeOf(...).toEqualTypeOf<…>()`) and let `npm run check:tsc` fail on
|
||||||
|
the _type_. The type error is the spec you want to hit before the runtime
|
||||||
|
logic exists.
|
||||||
|
2. **Red** — add the matching runtime assertion (`assert.*`) so
|
||||||
|
`npm run test:unit` now fails on behavior.
|
||||||
|
3. **Green** — implement in `src/*.ts` until both the type check and the test
|
||||||
|
pass.
|
||||||
|
4. **Refactor** — with the type system and the tests as the safety net, then
|
||||||
|
`npm run verify` as the definition-of-done gate.
|
||||||
|
|
||||||
|
Every test pairs an `expectTypeOf(...)` with an `assert.*`; keep them together.
|
||||||
|
The autocomplete tests (`src/util/__tests__/lsp-completion.test.ts` for the
|
||||||
|
helper, `src/primitive.test.ts` for the matcher's popup) are the
|
||||||
|
exception —
|
||||||
|
the language server, not the type system, is the oracle (see
|
||||||
|
[development/testing.md § Autocomplete](./development/testing.md#autocomplete)).
|
||||||
|
Each test body follows **AAA (Arrange–Act–Assert)** with labeled blocks
|
||||||
|
separated by a blank line: `// Arrange` sets up the inputs (e.g. the matcher
|
||||||
|
factory), `// Act` exercises the subject once from them (not a second
|
||||||
|
throwaway call), `// Assert` holds every check — type expectations first,
|
||||||
|
runtime assertions last; an empty block drops its label (see
|
||||||
|
[development/testing.md § AAA ordering](./development/testing.md#aaa-ordering)).
|
||||||
|
Type-first is enforced structurally: `npm test` runs `check:tsc` before the
|
||||||
|
test runner, so a wrong type can never be papered over by a passing assertion.
|
||||||
|
Per [AGENTS.md § Never do](./AGENTS.md#never-do), reach green honestly — fix the
|
||||||
|
types, never suppress the checks you can't make pass. Full rationale:
|
||||||
|
[development/testing.md](./development/testing.md).
|
||||||
|
|
||||||
|
## Code style and formatting
|
||||||
|
|
||||||
|
`oxfmt` is the formatter and `oxlint` is the linter (with type-aware rules).
|
||||||
|
`npm run fix` resolves the fixable issues; `npm run check` verifies without
|
||||||
|
writing. Suppressions must be fixed at the root — do not add `oxlint-disable`
|
||||||
|
directives or `as` casts to force a green run (see
|
||||||
|
[AGENTS.md § Never do](./AGENTS.md#never-do)).
|
||||||
|
|
||||||
|
Suggested VSCode extensions are in
|
||||||
|
[.vscode/extensions.json](./.vscode/extensions.json); the project's formatter
|
||||||
|
and linter are wired up there. Toolchain decisions:
|
||||||
|
[development/tooling.md](./development/tooling.md).
|
||||||
|
|
||||||
|
## Commit messages
|
||||||
|
|
||||||
|
Gitmoji subject, imperative mood, 50/72 wrapping. The template is
|
||||||
|
[commit-message-template](./commit-message-template); `npm run setup`
|
||||||
|
(or `npm run setup:git-commit-message`) registers it as git's
|
||||||
|
`commit.template`. Examples and rationale:
|
||||||
|
[development/workflow.md § Commit messages](./development/workflow.md#commit-messages).
|
||||||
|
|
||||||
|
## Script prefix convention
|
||||||
|
|
||||||
|
Script names in `package.json` use a prefix that signals _when_ the script is
|
||||||
|
intended to run. A `<prefix>:<name>` script is implicitly aggregated by a
|
||||||
|
`<prefix>` script (if one exists) and run by the corresponding lefthook hook or
|
||||||
|
CI step. Pick the prefix that matches the script's lifecycle:
|
||||||
|
|
||||||
|
- `create:*` — front doors of the repo's own workflow; these mutate git state
|
||||||
|
rather than the source. `create:branch` opens a unit of work, `create:finish`
|
||||||
|
closes the branch half, `create:release` closes the release half
|
||||||
|
(maintainer-only). No bare `create` aggregator on purpose.
|
||||||
|
- `check:*` — read-only verification; never modifies files. Aggregated by
|
||||||
|
`npm run check`.
|
||||||
|
- `fix:*` — mutating counterpart of a `check:*` script. Aggregated by
|
||||||
|
`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.
|
||||||
|
- `watch:*` — long-running watchers for the manual inner dev loop. Aggregated by
|
||||||
|
`watch`.
|
||||||
|
- `maintain:*` — advisory repo-maintenance scans: read-only, but whole-project
|
||||||
|
and/or network-bound, so never a correctness gate. Aggregated by
|
||||||
|
`npm run maintain`.
|
||||||
|
- `publish:*` — validates the _publishable artifact_ (e.g. `dist/`) rather than
|
||||||
|
the source, so it needs a fresh build.
|
||||||
|
- `setup:*` — one-time configuration of a fresh clone; mutates the local
|
||||||
|
environment rather than the repo source, so it is never part of a hook or CI
|
||||||
|
step. Aggregated by `npm run setup`, run once after cloning.
|
||||||
|
|
||||||
|
A new script must reuse an existing prefix. If none fits, that's a signal the
|
||||||
|
script doesn't belong in the pipeline — not a reason to invent a new prefix. If
|
||||||
|
it genuinely does belong, add the prefix to this list in the same commit as its
|
||||||
|
first member; an undocumented prefix becomes invisible and quietly accrues
|
||||||
|
members. Why `create:` exists, the rejected names, and the design of the bare
|
||||||
|
scripts: [development/workflow.md § Script prefix convention](./development/workflow.md#script-prefix-convention).
|
||||||
|
|
||||||
|
## Rules the tools don't enforce
|
||||||
|
|
||||||
|
CI and review will bounce these even though `npm run check` and the linters
|
||||||
|
don't catch them. They're the high-frequency things a contributor (or an agent)
|
||||||
|
reaches for by default:
|
||||||
|
|
||||||
|
- **Source imports use `.ts` extensions, never `.js`.** `node --strip-types`
|
||||||
|
only resolves the `.ts` form at test time; "pre-fixing" an import to `.js`
|
||||||
|
breaks the inner loop. (why:
|
||||||
|
[development/tooling.md](./development/tooling.md#source-imports-use-ts-extensions))
|
||||||
|
- **A new `npm run` script must reuse an existing prefix.** See
|
||||||
|
[Script prefix convention](#script-prefix-convention).
|
||||||
|
- **`oxlint-disable` directives live in source, not `.oxlintrc.json`.** The
|
||||||
|
trade-off must sit next to the code it silences. This is a _human_ last-resort
|
||||||
|
convention; agents must not add these — see
|
||||||
|
[AGENTS.md § Never do](./AGENTS.md#never-do). The sole agent exception is the
|
||||||
|
fixed file-level header at the top of a `*.test.ts` file, spelled exactly:
|
||||||
|
`/* oxlint-disable typescript/no-floating-promises -- expectTypeOf() is a sync
|
||||||
|
type-assertion library that the type-aware linter misidentifies as a promise
|
||||||
|
*/` — any other suppression stays human-last-resort. (why:
|
||||||
|
[development/tooling.md](./development/tooling.md#oxlint-disable-directives-live-next-to-the-code))
|
||||||
|
- **Don't put slow / network / whole-project scans in `check` or pre-commit.**
|
||||||
|
Advisory scans are not correctness gates; they belong under `maintain:`. (why:
|
||||||
|
[development/workflow.md](./development/workflow.md#feedback-tiers))
|
||||||
|
- **New work starts with `npm run create:branch`, never a hand-written
|
||||||
|
`git switch -c` / `git checkout -b`.** The command carries the branch
|
||||||
|
precondition; branching around it skips the clean-tree, current-`main` and
|
||||||
|
green-baseline checks, and the skip is invisible until a failure can no longer
|
||||||
|
be attributed. (why:
|
||||||
|
[development/workflow.md](./development/workflow.md#branching-model))
|
||||||
|
- **Work is merged back with `npm run create:finish`, never a hand-written
|
||||||
|
`git merge`.** The command carries the merge-side preconditions (clean tree,
|
||||||
|
current `main`, a `feature/`/`fix/`/`chore/` branch) and runs `npm run verify`
|
||||||
|
after the merge, so a merge cannot land unverified. (why:
|
||||||
|
[development/workflow.md](./development/workflow.md#branching-model))
|
||||||
|
- **There is no local `npm run publish`, and `publish:publint` / `publish:attw`
|
||||||
|
don't go in `check`.** (why:
|
||||||
|
[development/publishing.md](./development/publishing.md#ci-only-publishing))
|
||||||
|
- **A branch ends with a changelog note:** before `npm run create:finish`,
|
||||||
|
summarize the work under `[Unreleased]` in [CHANGELOG.md](./CHANGELOG.md).
|
||||||
|
(why:
|
||||||
|
[development/workflow.md](./development/workflow.md#changelog-notes))
|
||||||
|
- **A decision or its rationale belongs in `development/`, not here.** This file
|
||||||
|
holds the actionable rule; `development/<category>.md` holds why, the rejected
|
||||||
|
alternatives and the known issues. When you change a rule, update its category
|
||||||
|
file in the same commit and cross-link the two. (why:
|
||||||
|
[development/README.md](./development/README.md))
|
||||||
|
- **Prose in `development/` is extremely concise.** When adding or changing a
|
||||||
|
decision, write fragments if needed — sacrifice grammar for concision. (why:
|
||||||
|
[development/README.md § Decision blocks](./development/README.md#decision-blocks))
|
||||||
|
|
||||||
|
## Branching model
|
||||||
|
|
||||||
|
**GitHub Flow (single-developer).** Every change — feature, fix, refactor —
|
||||||
|
branches off `main` and is merged back via a local commit. There is no pull
|
||||||
|
request workflow on Gitea yet.
|
||||||
|
|
||||||
|
- **Base branch:** `main`
|
||||||
|
- **Branch naming:** `feature/<desc>` / `fix/<desc>` / `chore/<desc>`
|
||||||
|
- **Starting work:** `npm run create:branch -- <prefix>/<desc>`. It refuses,
|
||||||
|
without changing anything, unless the working tree is clean, no
|
||||||
|
merge/rebase/cherry-pick is in progress, `main` is not behind its upstream
|
||||||
|
(a local merge not yet pushed is fine — the push belongs to `create:release`),
|
||||||
|
and `npm run test` is green on `main`. The prefix is _your_ call, inferred from
|
||||||
|
the task; the script validates it rather than guessing it.
|
||||||
|
- **Merging:** `npm run create:finish` (on the branch). It re-asserts the same
|
||||||
|
preconditions, merges `--no-ff`, runs `npm run verify`, and deletes the branch
|
||||||
|
only after the merge is green. The push is left to `create:release`, so the
|
||||||
|
merge stays local and reviewable.
|
||||||
|
- CI runs on every push to `main` — see [Feedback tiers](#feedback-tiers) and
|
||||||
|
[.gitea/workflows/ci.yml](./.gitea/workflows/ci.yml).
|
||||||
|
- **Releases are NOT triggered by pushes.** Only the maintainer triggers a
|
||||||
|
release; see [Publishing](#publishing).
|
||||||
|
|
||||||
|
Full rationale, including the front-door decisions:
|
||||||
|
[development/workflow.md § Branching model](./development/workflow.md#branching-model).
|
||||||
|
|
||||||
|
## Submitting changes
|
||||||
|
|
||||||
|
There is no pull request workflow on Gitea yet, so a contribution is submitted
|
||||||
|
as a branch that is merged locally:
|
||||||
|
|
||||||
|
1. `npm run create:branch -- <prefix>/<desc>`.
|
||||||
|
2. Commit your work (one or more commits, per the tests and style rules above).
|
||||||
|
3. `npm run verify` — the definition of done.
|
||||||
|
4. Add a changelog note under `[Unreleased]` (see
|
||||||
|
[Rules the tools don't enforce](#rules-the-tools-dont-enforce)).
|
||||||
|
5. `npm run create:finish` to merge the branch into `main` and verify the
|
||||||
|
result.
|
||||||
|
6. Present a handover for review. Once there are no further objections, the
|
||||||
|
maintainer pushes.
|
||||||
|
|
||||||
|
When the project is promoted to GitHub, this step becomes a normal pull request
|
||||||
|
against `main`.
|
||||||
|
|
||||||
|
## Publishing
|
||||||
|
|
||||||
|
Publishing is maintainer-only and CI-only. See
|
||||||
|
[development/publishing.md](./development/publishing.md).
|
||||||
@@ -2,43 +2,34 @@
|
|||||||
|
|
||||||
Pattern matching for TypeScript/ESM environments (F#-style, not regex).
|
Pattern matching for TypeScript/ESM environments (F#-style, not regex).
|
||||||
|
|
||||||
## Development
|
## Description
|
||||||
|
|
||||||
- **Build:** `npm run build`
|
`tiny-pattern-ts` brings F#-style pattern matching to TypeScript. Patterns are
|
||||||
- **Test:** `npm run test`, `npm run test:ci`
|
ordinary objects whose `matches` method is a TypeScript type guard, so narrowing
|
||||||
- **Checks:** `npm run check`, `npm run fix`
|
composes the way any other guard does. It is deliberately not a regex engine and
|
||||||
- **Format/Fix:** `npm run fix:oxfmt`, `npm run fix:oxlint`
|
not a macro: there is no transpiler and no DSL to learn, and the type-level
|
||||||
|
contract is the feature — see [development/library.md](./development/library.md)
|
||||||
|
for the design decisions and the known limitations.
|
||||||
|
|
||||||
### Tooling
|
## Requirements
|
||||||
|
|
||||||
- **TypeScript 7** — type checker and build (`tsc`).
|
- **Node.js >= 26** (`engines` field; pinned via `.node-version`).
|
||||||
- **node --test** + `--experimental-strip-types` — test runner (Node 22.6+, flag dropped on Node 24).
|
- **TypeScript >= 5.0** to consume the published declarations. The emitted `.d.ts`
|
||||||
- **c8** — code coverage for `test:ci`.
|
use `const` type parameters (TS 5.0) and keep their relative `.ts` specifiers;
|
||||||
- **oxlint** — Rust-based linter.
|
both resolve on TS >= 5.0 in `node10` / `node16` / `nodenext` / `bundler`.
|
||||||
- **oxfmt** — Rust-based formatter (Prettier-compatible).
|
- The package is **ESM-only** (no CommonJS shim).
|
||||||
- **cspell** — spell checking.
|
|
||||||
- **sort-package-json** — keep `package.json` keys alphabetized.
|
|
||||||
- **lefthook** — git pre-commit hooks.
|
|
||||||
|
|
||||||
### Requirements
|
## API
|
||||||
|
|
||||||
- Node.js >= 22.6 (>= 24 recommended; `--experimental-strip-types` is unflagged on 24).
|
Yet to be implemented
|
||||||
|
|
||||||
## VSCode integration
|
## License
|
||||||
|
|
||||||
- Recommended extensions: see `.vscode/extensions.json` (oxc, cspell).
|
MIT © 2025 tmu. See [LICENSE](./LICENSE).
|
||||||
- TypeScript 7 is used via `typescript.tsdk` pointing at `node_modules/typescript/lib`.
|
|
||||||
- oxc extension provides oxlint squiggles and oxfmt format-on-save.
|
|
||||||
|
|
||||||
## Workflows
|
## Contributing
|
||||||
|
|
||||||
- Version updates via `npm version`.
|
Contributions are documented in [CONTRIBUTING.md](./CONTRIBUTING.md); the
|
||||||
- Publishing via GitHub Actions on tagged commits (see `.github/workflows/ci.yml`).
|
reasons behind the project's decisions, rejected alternatives, and known issues
|
||||||
- Changesets is available as a devDependency for changelog automation if desired.
|
live in [development/](./development/README.md). AI coding agents start at
|
||||||
|
[AGENTS.md](./AGENTS.md).
|
||||||
## Contribution guidelines
|
|
||||||
|
|
||||||
- Commit signing (GPG).
|
|
||||||
- Set up commit message template: `npm run use:git-commit-message`.
|
|
||||||
- See `commit-message-template`.
|
|
||||||
- Type-only tests use `expect-type`'s `expectTypeOf(...)` inside `node --test` cases.
|
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
Tasks
|
||||||
|
|
||||||
|
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.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
|
||||||
|
|
||||||
|
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
|
||||||
|
→ `(handlers, fallback)` with `handlers` covering all of `T` is accepted; the redundant fallback should be rejected (currying would allow the guard)
|
||||||
|
|
||||||
|
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
|
||||||
|
☐ Are there other primitive types that should be supported in union patterns? (e.g. `bigint`, `symbol`) @medium
|
||||||
|
|
||||||
|
Documentation:
|
||||||
|
☐ Bring README.md back to its previous form — synopsis and examples restored, in the correct place
|
||||||
|
→ 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
|
||||||
|
☐ 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
|
||||||
|
→ design: no deploy step in CI; the webserver just exposes the shared directory (decided over Gitea Pages / Codecov — neither confirmed available/ wanted)
|
||||||
|
☐ serve docs over self hosted server @low
|
||||||
|
☐ Add a minimal dir-listing webserver to the gitea docker setup for serving docs (reuse existing reverse proxy)
|
||||||
|
☐ CI writes docs to a shared volume keyed by project + tag (e.g. `/docs/tiny-pattern-ts/<tag>/`)
|
||||||
|
☐ Browse to `…/docs/<repo>/<tag>/index.html` in the browser
|
||||||
|
☐ serve landing page over self hosted server @low
|
||||||
|
☐ 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
|
||||||
+35
-7
@@ -2,20 +2,48 @@
|
|||||||
"version": "0.2",
|
"version": "0.2",
|
||||||
"language": "en",
|
"language": "en",
|
||||||
"words": [
|
"words": [
|
||||||
"tslib",
|
|
||||||
"typefest",
|
|
||||||
"lefthook",
|
"lefthook",
|
||||||
"oxlint",
|
"oxlint",
|
||||||
"oxfmt",
|
"oxfmt",
|
||||||
"oxc",
|
"oxc",
|
||||||
"nodenext",
|
"nodenext",
|
||||||
"nocheck",
|
|
||||||
"oxfmtrc",
|
"oxfmtrc",
|
||||||
"oxlintrc",
|
"oxlintrc",
|
||||||
"sortpackagerc",
|
|
||||||
"EDITMSG",
|
"EDITMSG",
|
||||||
"esbenp",
|
"typescriptteam",
|
||||||
"typescriptteam"
|
"gitmoji",
|
||||||
|
"dbaeumer",
|
||||||
|
"msvc",
|
||||||
|
"publint",
|
||||||
|
"attw",
|
||||||
|
"arethetypeswrong",
|
||||||
|
"knip",
|
||||||
|
"tsgolint",
|
||||||
|
"tsgo",
|
||||||
|
"tsserver",
|
||||||
|
"gitea",
|
||||||
|
"lipanski",
|
||||||
|
"pubv",
|
||||||
|
"knope",
|
||||||
|
"runwisp",
|
||||||
|
"glab",
|
||||||
|
"hostedtoolcache",
|
||||||
|
"nodebase",
|
||||||
|
"frontends",
|
||||||
|
"catthehacker",
|
||||||
|
"nsnull",
|
||||||
|
"dedup",
|
||||||
|
"dedupe",
|
||||||
|
"repoint",
|
||||||
|
"postversion",
|
||||||
|
"prebuild",
|
||||||
|
"Zilla",
|
||||||
|
"kacl",
|
||||||
|
"bestikk",
|
||||||
|
"silverwind",
|
||||||
|
"idris",
|
||||||
|
"todotasks",
|
||||||
|
"connor"
|
||||||
],
|
],
|
||||||
"ignorePaths": ["dist", "node_modules", "public", "coverage", "*.svg"]
|
"ignorePaths": ["dist", "node_modules", "coverage", "*.svg", ".gitignore"]
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
# Development documentation
|
||||||
|
|
||||||
|
Why this project works the way it does: the decisions, what was rejected, and
|
||||||
|
the shortcomings and known issues we carry. Written for maintainers and
|
||||||
|
contributors.
|
||||||
|
|
||||||
|
The actionable rules — setup, running, testing, submitting — live in
|
||||||
|
[CONTRIBUTING.md](../CONTRIBUTING.md). **Each fact is written once**: the rule
|
||||||
|
there, the reason here; neither restates the other, and where a fact is useful
|
||||||
|
in both they link. Read the relevant file before changing an area, and when a
|
||||||
|
rule changes update its rationale here in the same commit.
|
||||||
|
|
||||||
|
User-facing documentation is [README.md](../README.md). `docs/` is deliberately
|
||||||
|
unused: that name is reserved for the future user documentation site, and
|
||||||
|
deploying it is out of scope. These files are not part of that site.
|
||||||
|
|
||||||
|
## Layout
|
||||||
|
|
||||||
|
One file per category:
|
||||||
|
|
||||||
|
| File | Covers |
|
||||||
|
| -------------------------------- | ----------------------------------------------------------------------- |
|
||||||
|
| [library.md](./library.md) | Public API design, the type-level contract, and its limitations |
|
||||||
|
| [workflow.md](./workflow.md) | Branching and merging, script prefixes, feedback tiers, commit messages |
|
||||||
|
| [tooling.md](./tooling.md) | Toolchain choices and configuration, editor setup |
|
||||||
|
| [testing.md](./testing.md) | Test strategy and type-driven development |
|
||||||
|
| [ci.md](./ci.md) | CI pipeline, runner image, coverage serving |
|
||||||
|
| [publishing.md](./publishing.md) | Release and npm publishing |
|
||||||
|
|
||||||
|
We start with one file per category so each area stays small enough to hold in
|
||||||
|
mind; a category that outgrows it becomes a folder with an index, and the links
|
||||||
|
in CONTRIBUTING.md and README.md point at the category, not a single decision.
|
||||||
|
|
||||||
|
## Decision blocks
|
||||||
|
|
||||||
|
Record every non-obvious choice as a block in the relevant category file:
|
||||||
|
|
||||||
|
```md
|
||||||
|
## Runner image
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Bake Node into the CI job image at the setup-node tool-cache layout instead
|
||||||
|
of downloading per job.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- ...
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Gitea Pages / per-job download
|
||||||
|
- force-pull
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- a Dockerfile-only change re-pushed under an unchanged tag is invisible to the runner
|
||||||
|
- recover with `docker rmi <image>`
|
||||||
|
```
|
||||||
|
|
||||||
|
- The date is the month the decision was made, not when the file was edited —
|
||||||
|
the anchor for "current" versus "was current once".
|
||||||
|
- `Rejected` stops the project re-litigating the same alternatives; an empty one
|
||||||
|
usually means they were never written down.
|
||||||
|
- `Known issue` is where shortcomings live. A caveat not tied to one decision
|
||||||
|
goes under a `## Known issues` section at the end of the file.
|
||||||
|
- Replace a superseded decision in place rather than archiving it; git history
|
||||||
|
is the archive.
|
||||||
|
- Terse is the point: humans skim and agents imitate the style already in the
|
||||||
|
file, so verbosity compounds edit over edit. Grammar loses to density here on
|
||||||
|
purpose.
|
||||||
|
|
||||||
|
## Adding to these docs
|
||||||
|
|
||||||
|
1. Pick the category: `library`, `workflow`, `tooling`, `testing`, `ci`,
|
||||||
|
`publishing`.
|
||||||
|
2. Add or update a decision block; keep existing text unless the decision
|
||||||
|
changed.
|
||||||
|
3. If an actionable rule changes, update
|
||||||
|
[CONTRIBUTING.md](../CONTRIBUTING.md) in the same commit and cross-link.
|
||||||
|
Never change a rule there without updating its rationale here.
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
# CI
|
||||||
|
|
||||||
|
[.gitea/workflows/ci.yml](../.gitea/workflows/ci.yml) is the source of truth for
|
||||||
|
the job graph; this file records why it is shaped the way it is.
|
||||||
|
|
||||||
|
## Pipeline
|
||||||
|
|
||||||
|
- **`build`** (push to `main` / tag) — build + correctness + packaging.
|
||||||
|
- **`maintain`** (push to `main`, non-blocking) — `npm run maintain`; reports,
|
||||||
|
never fails the build.
|
||||||
|
- **`publish`** (tag) — packaging checks + `publish:publint` / `publish:attw`,
|
||||||
|
then the Gitea release page and `npm publish` (see
|
||||||
|
[publishing.md](./publishing.md)).
|
||||||
|
- **`release-gate`** — on a `:rocket: Release x.y.z` commit it skips
|
||||||
|
`build`/`maintain`, because `create:release` pushes the tag for the same commit
|
||||||
|
right after and the tag run is authoritative. It uses no Node and stays on the
|
||||||
|
default image.
|
||||||
|
|
||||||
|
## Runner image
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`build` / `maintain` / `publish` run in `gitea.e1nsnull.de/tmu/act-ci:<version>`
|
||||||
|
([docker/Dockerfile](../docker/Dockerfile)): the default act image with Node
|
||||||
|
overlaid at the exact `/opt/hostedtoolcache` layout `actions/setup-node` probes.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- No job pays the ~50 MB Node fetch, because the probe hits the baked entry.
|
||||||
|
- The tag must equal the exact [.node-version](../.node-version) pin, and the
|
||||||
|
image is rebuilt only as part of a Node bump — there is no other trigger.
|
||||||
|
- Building needs a docker daemon and registry credentials, so it belongs to no
|
||||||
|
feedback tier. That is why it is **not** an `npm run` script: no
|
||||||
|
[prefix](./workflow.md#script-prefix-convention) fits, and that is the signal.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Downloading Node in every job — the ~50 MB fetch was the original problem.
|
||||||
|
- Caching Proxy (Squid or similar) — adds complexity to global setup
|
||||||
|
- Mounting the tool cache - No invalidation will fill the cache with stale versions
|
||||||
|
|
||||||
|
## Bumping Node
|
||||||
|
|
||||||
|
Bumping Node is one coordinated change, committed as a unit:
|
||||||
|
|
||||||
|
1. Edit [.node-version](../.node-version) to the exact `x.y.z` — floats like `26`
|
||||||
|
resolve to the latest patch at runtime and bust the baked entry, so
|
||||||
|
[scripts/runner-image.sh](../scripts/runner-image.sh) refuses them.
|
||||||
|
2. `docker login gitea.e1nsnull.de` (user + package/access token), then
|
||||||
|
`./scripts/runner-image.sh --push`, which reads the version and pushes
|
||||||
|
`<IMAGE_REPO>:<version>`.
|
||||||
|
3. Repoint the three `container.image` tags in
|
||||||
|
[.gitea/workflows/ci.yml](../.gitea/workflows/ci.yml) to that version.
|
||||||
|
|
||||||
|
Skipping step 2 fails CI at image pull; skipping step 3 silently reverts to the
|
||||||
|
per-job download.
|
||||||
|
|
||||||
|
## Image invariants
|
||||||
|
|
||||||
|
For the `setup-node` probe to hit, two things must hold — both easy to break:
|
||||||
|
|
||||||
|
### The `x64.complete` marker
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Bake a `<version>/<arch>.complete` marker next to the Node directory.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `actions/tool-cache` accepts a cached tool only when
|
||||||
|
`<version>/<arch>.complete` exists beside it (`tc.find()` checks). A bare
|
||||||
|
`node/<version>/x64/` is ignored and the download happens anyway. See the
|
||||||
|
comment in [docker/Dockerfile](../docker/Dockerfile).
|
||||||
|
|
||||||
|
### Tag freshness, with force-pull deliberately off
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Leave `act_runner`'s `force_pull` disabled.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The tag encodes only the Node version, and the image is rebuilt only when that
|
||||||
|
changes — so the normal flow always yields a new tag and the runner pulls it.
|
||||||
|
- Forcing a pull re-pulls the image on every job for no benefit.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Enabling `force_pull`: it is acceptable to miss a runner-side image change,
|
||||||
|
and a `Dockerfile`-only change is not worth a per-job pull.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- A `Dockerfile`-only change (like the marker above) re-pushed under an
|
||||||
|
unchanged tag is invisible to the runner, which keeps the old image while the
|
||||||
|
registry shows the new digest. Remove the stale tag on the runner host
|
||||||
|
(`docker rmi gitea.e1nsnull.de/tmu/act-ci:<version>`); do not reach for
|
||||||
|
force-pull.
|
||||||
|
|
||||||
|
## Coverage serving
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Serve CI coverage from a shared directory on the runner, with no deploy step in
|
||||||
|
CI.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The webserver exposes the shared directory and the Gitea docker setup reuses
|
||||||
|
the existing reverse proxy — no upload artifact, no external service.
|
||||||
|
- Coverage is written to a shared volume keyed by project and tag (for example
|
||||||
|
`/docs/tiny-pattern-ts/<tag>/`).
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Gitea Pages and Codecov: neither was confirmed available or wanted.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- Coverage is served for tag pushes only; non-tag pushes (for example
|
||||||
|
`main/coverage`) are tracked separately.
|
||||||
|
|
||||||
|
[scripts/precompress.ts](../scripts/precompress.ts) emits `.br` / `.gz` / `.zst`
|
||||||
|
sidecars next to text assets. The Gitea pages service (`static-web-server` with
|
||||||
|
`SERVER_COMPRESSION_STATIC=true`) serves the sidecar matching `Accept-Encoding`
|
||||||
|
and falls back to the original.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Precompress into sidecars rather than per request.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The assets are static and change only on deploy, so the work is paid once.
|
||||||
|
- Images, fonts and archives are already compressed; a sidecar would only grow
|
||||||
|
them, so only text extensions are emitted.
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
# Library design
|
||||||
|
|
||||||
|
The type-level design of the public API and the limitations it carries. The
|
||||||
|
user-facing reference is [README § API](../README.md#api).
|
||||||
|
|
||||||
|
The matcher is implemented in `src/primitive.ts` and re-exported from
|
||||||
|
`src/index.ts` as `getMatcher` / `getMatcherW`; the rest of the library is
|
||||||
|
placeholder code.
|
||||||
|
|
||||||
|
## Matcher shape
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A factory takes the universe and returns a builder; the builder takes a handler
|
||||||
|
map and an optional fallback:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const matcher = getMatcher<"a" | "b">()({ a: (s) => …, b: (s) => … });
|
||||||
|
const fallback = getMatcher<"a" | "b" | "c">()({ a: (s) => … }, (s) => …);
|
||||||
|
```
|
||||||
|
|
||||||
|
Exhaustive or fallback is decided **at the call site**, by whether the second
|
||||||
|
argument is present. The fallback's parameter is the remainder
|
||||||
|
`Exclude<T, keyof Handled>`. Only the return-strictness axis remains, so there
|
||||||
|
are two factories:
|
||||||
|
|
||||||
|
- `getMatcher` — one common `R`; the fallback must fit it;
|
||||||
|
- `getMatcherW` — the union `PatternReturns<Handled> | R`.
|
||||||
|
|
||||||
|
Each factory is two overloads whose order is load-bearing:
|
||||||
|
|
||||||
|
1. `Handlers<T, R>` — the exhaustive form, and the contextual type of the
|
||||||
|
handler-map popup;
|
||||||
|
2. `Handled extends Exact<Partial<Handlers<T, R>>, Handled>` plus
|
||||||
|
`Fallback<T, Handled, R>` — a partial handler map plus the fallback.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- **The fallback is an argument, not a property.** TypeScript fixes a property's
|
||||||
|
contextual type before it infers its sibling keys, so `_: (s) => …` in the
|
||||||
|
handler map can only see all of `T`, never `Exclude<T, keyof Handled>`. A later
|
||||||
|
argument is contextually typed from inference on an earlier one, so the split
|
||||||
|
is what makes the remainder expressible.
|
||||||
|
- **Overload order keeps both messages.** #1 supplies the contextual type
|
||||||
|
(`a, b, c`); #2 accepts a partial map once a fallback is present, so its popup
|
||||||
|
is optional (`a?, b?, c?`). A gap without a fallback is reported against #1.
|
||||||
|
- **`R` needs an inference site.** `R` inside the `Exact<…>` constraint is not
|
||||||
|
one, so `handlers: Handled & Partial<Handlers<T, R>>` re-adds it; without that
|
||||||
|
`R` collapses to `unknown` when the handler params are inferred.
|
||||||
|
- **`Exact` restores the excess-property check.** TypeScript skips it for a
|
||||||
|
generic constraint, so without `Exact` the handler map accepts keys outside
|
||||||
|
`T`.
|
||||||
|
- Two factories, not four: the fallback is an argument, not a separate API.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- **Single-object `_`** (the former shape). `_` sees only all of `T`; the
|
||||||
|
remainder is not expressible there, and an exhaustive map plus `_` was
|
||||||
|
accepted.
|
||||||
|
- **Curried handlers-first** — `(handlers)(fallback)`. `Handled` is fixed before
|
||||||
|
the second call, so a redundant-fallback guard would work. Rejected: two calls
|
||||||
|
for the common case.
|
||||||
|
- **`this` / HKT self-reference.** `this` is post-construction (method bodies,
|
||||||
|
return positions); a parameter's contextual type is pre-construction.
|
||||||
|
`keyof this` in an interface method is the interface, not the literal.
|
||||||
|
- **Variance / `const` type parameters / `NoInfer` / `unique symbol` brands /
|
||||||
|
defaulted type-param guards.** None change inference or evaluation order;
|
||||||
|
`in`/`out` on the handler map broke contextual typing outright. `NoInfer`
|
||||||
|
specifically leaks into the emitted `.d.ts`, raising the consumer floor to
|
||||||
|
TypeScript 5.4 (README promises `>= 5.0`).
|
||||||
|
- **Union merge**, **overload merge with only the exhaustive arm last**,
|
||||||
|
**inferred universe**, **conditional `RequireKeys`**, **cases-first curried** —
|
||||||
|
decided against while the API was single-object; their reasons (reported
|
||||||
|
near-miss member, no `_` in the exhaustive popup, `NoInfer`/floor, `keyof P`
|
||||||
|
counts optional keys, not pipe-friendly) hold where they still apply.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- A redundant fallback is accepted: when the handler map already covers `T`, the
|
||||||
|
fallback is still allowed. The guard would be
|
||||||
|
`Exclude<T, keyof Handled> extends never ? never : unknown`, but the
|
||||||
|
conditional is evaluated before `Handled` is inferred; currying is the only
|
||||||
|
encoding that fixes it (see Rejected).
|
||||||
|
- `PatternReturns` must be
|
||||||
|
`ReturnType<Extract<ValueOf<P>, (...args: never[]) => unknown>>` so it survives
|
||||||
|
the closed, partly-optional `P` constraints.
|
||||||
|
- `Parameters<typeof factory>[0]` resolves only the **last** overload, so it is
|
||||||
|
not a sound "rejected" oracle for a factory. Factory-negative tests use
|
||||||
|
`@ts-expect-error` call sites (the test file only — the general ban stands).
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
# Publishing
|
||||||
|
|
||||||
|
Publishing is CI-only: local `npm publish` is not supported, and the maintainer
|
||||||
|
triggers releases from `main`. The mechanics are in
|
||||||
|
[scripts/release.sh](../scripts/release.sh) and
|
||||||
|
[scripts/release-notes.sh](../scripts/release-notes.sh); the job graph is
|
||||||
|
[.gitea/workflows/ci.yml](../.gitea/workflows/ci.yml).
|
||||||
|
|
||||||
|
## Release steps
|
||||||
|
|
||||||
|
1. All intended changes are merged to `main` and passing CI.
|
||||||
|
2. The maintainer runs `npm run create:release`. VS Code opens
|
||||||
|
[CHANGELOG.md](../CHANGELOG.md) to finalize the `[Unreleased]` notes; because
|
||||||
|
pubv refuses a dirty tree, the edit is committed first (then folded into the
|
||||||
|
release commit), and pubv suggests a version from those notes to confirm or
|
||||||
|
edit.
|
||||||
|
3. `scripts/release.sh` creates one release commit (graduated changelog +
|
||||||
|
`package.json` bump, amended together), tags it, and pushes.
|
||||||
|
4. CI fires on both pushes. `publish` runs on the tag (build + publish checks +
|
||||||
|
release page + `npm publish`), while `release-gate` recognizes the release
|
||||||
|
commit and skips `build`/`maintain`: the tag verifies the identical SHA, so no
|
||||||
|
work is duplicated. The publish checks pass before the artifact is published,
|
||||||
|
and the release page is created from the matching Keep-a-Changelog section
|
||||||
|
_before_ `npm publish`, so a broken page fails CI without consuming a version
|
||||||
|
and `npm publish` stays the last step.
|
||||||
|
|
||||||
|
## CI-only publishing
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Releases are cut by CI from `main`; there is no local `npm publish` and no
|
||||||
|
`publish:*` script in the `check` chain.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The tag is the artifact marker: CI verifies the exact commit it points at, so
|
||||||
|
a local publish could ship something the tag does not describe.
|
||||||
|
- `publish:publint` / `publish:attw` validate the _publishable artifact_, which
|
||||||
|
needs a fresh build; they are not source-correctness checks and do not belong
|
||||||
|
in `check`.
|
||||||
|
|
||||||
|
## The release commit is assembled from two tools
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`create:release` uses `pubv` for the changelog graduation and bump heuristic,
|
||||||
|
then `npm version` for the `package.json` + lockfile bump, amended into a single
|
||||||
|
release commit.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- We want hand-written Keep-a-Changelog notes, an `[Unreleased]` ->
|
||||||
|
`## [x.y.z] - DATE` graduation, and a tag on the exact commit that gets
|
||||||
|
published — and no single tool did both the graduation and the `package.json`
|
||||||
|
bump.
|
||||||
|
- Split by strength: `pubv` (tiny, changelog-driven) owns preflight, the
|
||||||
|
interactive major/minor/patch heuristic, and graduating and committing
|
||||||
|
`CHANGELOG.md` (no tag, no push); `npm version` syncs `package.json` + the
|
||||||
|
lockfile; `--amend` folds them into one commit; the tag is created _after_ the
|
||||||
|
amend so it is never orphaned.
|
||||||
|
- The notes are finalized _before_ pubv because its bump heuristic reads the
|
||||||
|
`[Unreleased]` body — editing afterwards would inform the changelog only, not
|
||||||
|
the version. The staging commit that satisfies pubv's clean-tree check is
|
||||||
|
folded back into the single release commit.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- The conventional-commits family: the history is gitmoji, not Conventional, and
|
||||||
|
the notes are hand-written (see
|
||||||
|
[workflow.md § Commit messages](./workflow.md#commit-messages)).
|
||||||
|
- `changesets` / `rtk`: config plus a heavier flow that fights the CI-only
|
||||||
|
publish.
|
||||||
|
- `knope` / `kacl` / `bestikk`: changelog-only (no `package.json` bump) and
|
||||||
|
5-year / 2-year / brand-new maintenance.
|
||||||
|
- `pubv` alone: it never writes `package.json`.
|
||||||
|
- `versions` (silverwind): good Gitea support, but pairing it with a hand-rolled
|
||||||
|
promote became a ~180-line script, which this ~30-line version replaces.
|
||||||
|
|
||||||
|
## The version has one source of truth
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
The version is derived from the graduated `## [x.y.z]` heading in
|
||||||
|
[CHANGELOG.md](../CHANGELOG.md) and written to `package.json` +
|
||||||
|
`package-lock.json` by `npm version`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `release.sh` reads the version from the changelog, so the changelog is the
|
||||||
|
input and `package.json` the derived copy — one direction, no drift.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- A `## Version` line in the README: it makes `release.sh` responsible for a
|
||||||
|
third file.
|
||||||
|
- Linking `package.json` from the README: it invites a hand-maintained duplicate
|
||||||
|
the link does not keep in sync.
|
||||||
|
|
||||||
|
## Release notes are extracted from the changelog
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`scripts/release-notes.sh <tag>` prints the Keep-a-Changelog section for the tag
|
||||||
|
and exits non-zero when it is missing.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- CI reuses the release body from the same file that drove the version, so the
|
||||||
|
page and the changelog cannot disagree.
|
||||||
|
- Failing on a missing section means a release can never publish an empty body.
|
||||||
|
A leading `v` is tolerated so both `v1.2.3` and `1.2.3` match `## [1.2.3]`.
|
||||||
|
|
||||||
|
## Token gates
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
The Gitea release page uses the run's automatic token (`github.token`).
|
||||||
|
`npm publish` is gated on `NPM_TOKEN`, lifted into job-level `env`. A final
|
||||||
|
`always()` step fails the job unless both halves reported `success`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The automatic token needs only `contents: write`, so the release page needs no
|
||||||
|
secret gate.
|
||||||
|
- `secrets` is not allowed in a step `if`, so `NPM_TOKEN` must be lifted into
|
||||||
|
job-level `env`; an unset secret then skips the publish instead of attempting
|
||||||
|
an unauthenticated one.
|
||||||
|
- A tag is all-or-nothing: without the `always()` guard a skipped or failed npm
|
||||||
|
half would leave the job silently green. The guard turns it red.
|
||||||
|
|
||||||
|
Set `NPM_TOKEN` (npm publish rights) under Settings -> Actions -> Secrets.
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
# Testing
|
||||||
|
|
||||||
|
For this library the types _are_ the feature, so a runtime-only test loop would
|
||||||
|
verify the wrong thing. The commands are in
|
||||||
|
[CONTRIBUTING.md](../CONTRIBUTING.md); this file records why the loop is shaped
|
||||||
|
the way it is.
|
||||||
|
|
||||||
|
## Type-driven development
|
||||||
|
|
||||||
|
The rules — the loop and the pairing rule — are in
|
||||||
|
[CONTRIBUTING.md § Testing discipline (type-driven)](../CONTRIBUTING.md#testing-discipline-type-driven).
|
||||||
|
What follows is why and what was rejected.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
The compile-time expectation is written before the runtime assertion, and both
|
||||||
|
before the implementation.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- A runtime-only test can pass while the type is wrong, so a type-level library
|
||||||
|
would ship a broken feature its tests bless.
|
||||||
|
- The type error is a more precise spec than a failing assertion, because it
|
||||||
|
states the exact expected type before the logic exists.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Runtime-first (classic red/green): it verifies the value, not the contract,
|
||||||
|
and the contract is the product.
|
||||||
|
- Testing the type only: it would not catch handler dispatch or the `_`
|
||||||
|
fallback (see `src/primitive.test.ts`).
|
||||||
|
|
||||||
|
The runner is `node --test --strip-types "src/**/*.test.ts"` and the tiers are
|
||||||
|
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)).
|
||||||
|
|
||||||
|
## AAA ordering
|
||||||
|
|
||||||
|
The rule is in
|
||||||
|
[CONTRIBUTING.md § Testing discipline (type-driven)](../CONTRIBUTING.md#testing-discipline-type-driven).
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Test bodies read arrange → act → assert: inputs (the factory) set up first, the
|
||||||
|
subject exercised once from them, all checks last — types then runtime. The
|
||||||
|
blocks are labeled with `// Arrange` / `// Act` / `// Assert` comments and
|
||||||
|
separated by a blank line; an empty block drops its label.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- Interleaved setup/checks hide what runs vs. what is observed; the eye
|
||||||
|
re-reads the block to find the seams.
|
||||||
|
- A factory built mid-test invites a second throwaway call of the subject;
|
||||||
|
arranging it once makes the positive construction and the negative
|
||||||
|
`Parameters<…>` check share one source of truth.
|
||||||
|
- Labels make the seams explicit, not inferred — grep-able and reviewable
|
||||||
|
without reading the statements.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Unlabeled ordering (bare blank lines): the seams still have to be found by
|
||||||
|
reading; the labels cost nothing.
|
||||||
|
|
||||||
|
## Test helpers
|
||||||
|
|
||||||
|
The rule is enforced by `import/no-relative-parent-imports`; this section records
|
||||||
|
why the mechanism is shaped like this.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A shared test helper — code that scattered `*.test.ts` files import to do their
|
||||||
|
testing — lives under `src/util/__tests__/` and is addressed by the
|
||||||
|
`#test-utils/…` self-reference (`package.json#imports`:
|
||||||
|
`"#test-utils/*": "./src/util/__tests__/*"`), never by a relative path:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { LspSession } from "#test-utils/lsp-completion.ts";
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The lint rule bans upward (`../`) imports, and a cross-cutting helper can
|
||||||
|
always be placed above _some_ scattered consumer, wherever it goes. Name
|
||||||
|
beats path: a `#test-utils/…` specifier has no direction, so the rule never
|
||||||
|
fires and file moves only touch the one mapping in `package.json`.
|
||||||
|
- `#…` is Node's reserved prefix for _private_ subpath imports: publishing
|
||||||
|
`package.json` leaks nothing and resolves nothing for consumers.
|
||||||
|
- `__tests__` as the folder name is not about tests living there; it is the
|
||||||
|
directory pattern `tsconfig.build.json` already excludes, so a helper can
|
||||||
|
never be emitted into `dist/` and shipped by accident.
|
||||||
|
- Node's own resolver handles `#…` under `--strip-types`, and `tsc` resolves it
|
||||||
|
via the same `imports` field — one mechanism for runtime and type gate, no
|
||||||
|
loader needed.
|
||||||
|
- The helper uses `node:` builtins (it drives a language server), so
|
||||||
|
`import/no-nodejs-modules` is off for `src/util/__tests__/**` in
|
||||||
|
`.oxlintrc.json` — the same exception the `scripts/**` scope carries.
|
||||||
|
- Helpers carry no library coupling: their tests probe in-memory documents
|
||||||
|
whose contextual types are written inline, so only the helper's own contract
|
||||||
|
(marker handling, position, label extraction) is under test. A test that
|
||||||
|
asserts a _matcher's_ popup belongs with the matcher.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- A helper beside the tests (`src/util/test.ts`, flat `src/`): composes only
|
||||||
|
while `src/` stays flat; the first nested test reaching it reintroduces the
|
||||||
|
banned upward import.
|
||||||
|
- Bare `~/…` specifier: not valid in `imports` (keys must start with `#`) —
|
||||||
|
resolution fails at runtime with `ERR_MODULE_NOT_FOUND`. A `#~/…` “home”
|
||||||
|
shorthand was dropped in review; `#test-utils/…` states what it is.
|
||||||
|
- tsconfig `paths` alias: resolves for `tsc` but not for plain
|
||||||
|
`node --test --strip-types` (no loader hook), breaking the fast tier.
|
||||||
|
- Turning `import/no-relative-parent-imports` off for test files: the rule
|
||||||
|
still guards non-test helpers importing each other, and the exemption is
|
||||||
|
only needed for the one specifier the mapping already solves cleanly.
|
||||||
|
|
||||||
|
## Autocomplete
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Completion is verified by driving the repo's own language server
|
||||||
|
(`tsc --lsp --stdio`, the same server pi's LSP extension talks to) through
|
||||||
|
the test helper `#test-utils/lsp-completion.ts`
|
||||||
|
(`src/util/__tests__/lsp-completion.ts`), not through the type system:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
node --strip-types src/util/__tests__/lsp-completion.ts <file> [<marker>]
|
||||||
|
```
|
||||||
|
|
||||||
|
The script prints the labels the server offers at a `/*COMPLETE*/` marker inside
|
||||||
|
`<file>` (the marker is stripped before the document is sent). Its `LspSession`
|
||||||
|
is imported by `src/util/__tests__/lsp-completion.test.ts` — which tests the
|
||||||
|
helper itself against inline documents, never the library's code — and by
|
||||||
|
`src/primitive.test.ts`, where the same probe asserts the matcher's popup;
|
||||||
|
the CLI is for manual inspection.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- Completion is a contextual-type property: it depends on which overload
|
||||||
|
signature TypeScript picks for the object literal, and no type-level assertion
|
||||||
|
observes that.
|
||||||
|
- `Parameters<typeof factory>[0]` resolves only the _last_ overload, so it is
|
||||||
|
not the popup's contextual type either — see
|
||||||
|
[library.md § Matcher shape](./library.md#matcher-shape).
|
||||||
|
- The server is the only ground truth; the script reproduces what the editor
|
||||||
|
shows.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- **`expect-type` would not work**: there is no operator for “the popup offers
|
||||||
|
these labels”. `toExtend` / `toEqualTypeOf` test assignability and cannot say
|
||||||
|
which overload supplied the contextual type.
|
||||||
|
- **Checking by hand in the editor**: not reproducible in review or by an agent.
|
||||||
|
- **`@ts-expect-error` at a completion position**: it asserts the absence of a
|
||||||
|
compile error, not the presence of specific labels.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- Each test spawns its own `tsc` server so the tests share no state and pass in
|
||||||
|
any order; the file is an integration test (~1.6 s) that needs `node_modules`.
|
||||||
|
`didOpen` is handled in order before the completion request, so no settle
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Known issues
|
||||||
|
|
||||||
|
- The type-aware linter misidentifies `expectTypeOf()` as a floating promise, so
|
||||||
|
test files that use it (`src/primitive.test.ts`) carry a file-level
|
||||||
|
`oxlint-disable typescript/no-floating-promises` with an explanatory comment.
|
||||||
|
It is a known false positive, not a rule worth disabling project-wide (see
|
||||||
|
[tooling.md § oxlint-disable directives live next to the code](./tooling.md#oxlint-disable-directives-live-next-to-the-code)).
|
||||||
@@ -0,0 +1,315 @@
|
|||||||
|
# Tooling
|
||||||
|
|
||||||
|
Every tool below was chosen and configured deliberately. The commands a
|
||||||
|
contributor runs are in [CONTRIBUTING.md](../CONTRIBUTING.md) and the versions
|
||||||
|
in [package.json](../package.json).
|
||||||
|
|
||||||
|
## Tool inventory
|
||||||
|
|
||||||
|
- **TypeScript 7** — type checker and build (`tsc`).
|
||||||
|
- **node --test** + `--strip-types` — test runner.
|
||||||
|
- **c8** — coverage for `test:ci`.
|
||||||
|
- **oxlint** — Rust linter, type-aware via **oxlint-tsgolint** (typescript-go).
|
||||||
|
- **oxfmt** — Rust formatter (Prettier-compatible) for JS/TS, JSON/JSONC, YAML,
|
||||||
|
Markdown, MDX, and more; its `package.json` key sorting replaces
|
||||||
|
`sort-package-json`.
|
||||||
|
- **cspell** — spell checking.
|
||||||
|
- **knip** — unused dependencies, exports, and files.
|
||||||
|
- **check-outdated** — dependencies behind the registry; exits non-zero when any
|
||||||
|
is outdated.
|
||||||
|
- **publint** — validates `package.json` for ESM publishing.
|
||||||
|
- **@arethetypeswrong/cli** (`attw`) — validates `.d.ts` against module-resolution
|
||||||
|
scenarios.
|
||||||
|
- **lefthook** — git hooks.
|
||||||
|
- **@spences10/pi-lsp** — read-only LSP code intelligence for AI agents
|
||||||
|
(project-local `.pi/settings.json`); talks to this repo's TypeScript 7 via
|
||||||
|
`tsc --lsp --stdio`.
|
||||||
|
- **vscode-languageserver-protocol** — LSP client and protocol types for the
|
||||||
|
autocomplete test helper (`src/util/__tests__/lsp-completion.ts`).
|
||||||
|
|
||||||
|
When each runs is in
|
||||||
|
[CONTRIBUTING.md § Feedback tiers](../CONTRIBUTING.md#feedback-tiers).
|
||||||
|
|
||||||
|
## TypeScript and build
|
||||||
|
|
||||||
|
### One type-check config, one emit config
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`tsconfig.json` extends `@tsconfig/strictest` + `@tsconfig/node26`.
|
||||||
|
`tsconfig.build.json` adds the emit-only options (`declaration`, `sourceMap`,
|
||||||
|
`inlineSources`, `outDir`, `target: es2024`,
|
||||||
|
`rewriteRelativeImportExtensions: true`) and excludes test files.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The editor and CI type-check from one config while the build emits from the
|
||||||
|
other, so a test file cannot leak into `dist/`.
|
||||||
|
- `inlineSources` embeds the original TypeScript in `dist/*.js.map`, so
|
||||||
|
debuggers map into `src/` without it being shipped.
|
||||||
|
- `declarationMap` stays off: a `.d.ts.map` cannot embed source and would
|
||||||
|
dangle.
|
||||||
|
|
||||||
|
### The build starts from an empty `dist/`
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`npm run build` runs a `prebuild` hook that empties `dist/`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `tsc` does not prune orphaned emit output — dropping `declarationMap` left
|
||||||
|
stale `*.d.ts.map` files — so reproducibility needs an empty `dist/`.
|
||||||
|
- `prebuild` removes only `dist`; the manual `clean` resets `dist` + `coverage`,
|
||||||
|
so a local coverage report survives a build.
|
||||||
|
|
||||||
|
### Source imports use `.ts` extensions
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Source imports use `.ts`, never `.js`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `node --strip-types` resolves the `.ts` form at test time.
|
||||||
|
- `rewriteRelativeImportExtensions` rewrites them to `.js` in the emitted
|
||||||
|
JavaScript.
|
||||||
|
- The emitted `.d.ts` keep the `.ts` specifier, which TypeScript >= 5.0 resolves
|
||||||
|
(see [README § Requirements](../README.md#requirements)), so no
|
||||||
|
post-processing step is needed.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- "Pre-fixing" an import to `.js`: it breaks the inner `node --strip-types`
|
||||||
|
loop.
|
||||||
|
|
||||||
|
## Linting and formatting
|
||||||
|
|
||||||
|
### Type-aware oxlint is a config property
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Type-aware oxlint is enabled via `options.typeAware: true` in `.oxlintrc.json`
|
||||||
|
(powered by `oxlint-tsgolint`).
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The script commands stay clean — no CLI flag.
|
||||||
|
- A config property cannot be forgotten on one call site.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- A CLI flag in the `check:oxlint` / `fix:oxlint` scripts: it puts the mode in
|
||||||
|
two places and invites them to drift.
|
||||||
|
|
||||||
|
### `oxlint-disable` directives live next to the code
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A type-aware rule that false-positives is silenced with a source-level
|
||||||
|
`oxlint-disable` directive (see `src/primitive.ts`,
|
||||||
|
`src/primitive.test.ts`), not by turning the rule off in `.oxlintrc.json`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The disable sits next to the code it silences, visible to anyone reading the
|
||||||
|
source.
|
||||||
|
- The rule stays on everywhere else, so only the mis-firing line is exempted.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- A project-wide disable in `.oxlintrc.json` for a false positive: it hides the
|
||||||
|
exemption from the reader of the affected code and switches the rule off
|
||||||
|
repo-wide for a one-site problem.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- A source-level disable is a _human_ last resort. AI agents must not add one;
|
||||||
|
they fix the type at its root (see [AGENTS.md § Never do](../AGENTS.md#never-do)).
|
||||||
|
|
||||||
|
### Unwanted stylistic rules are turned off in the config
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A stylistic rule the project rejects is `"off"` in the `.oxlintrc.json` `rules`
|
||||||
|
map, not silenced at a use site. Current entries: `eslint/capitalized-comments`
|
||||||
|
(comments may start lowercase) and `eslint/no-ternary` (ternaries are allowed),
|
||||||
|
joining the oxfmt-superseded rules already off.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The rule is wrong for the whole project, not mis-firing at one site, so there
|
||||||
|
is no line to annotate.
|
||||||
|
- Keeping the two mechanisms separate keeps a source-level `oxlint-disable`
|
||||||
|
meaningful: it marks a lone exception.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- A source-level `oxlint-disable` per use: the same exemption repeated at every
|
||||||
|
site, and oxfmt can move the site.
|
||||||
|
|
||||||
|
### `check:tsc` runs first
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`check:tsc` runs first in the `npm run check` chain.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- A type error short-circuits the rest, which is faster than running
|
||||||
|
oxlint/oxfmt and failing on `tsc` at the end.
|
||||||
|
|
||||||
|
### `.editorconfig` is a fallback, not a gate
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`.editorconfig` exists for editor compatibility; where both apply,
|
||||||
|
`.oxfmtrc.json` is authoritative.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `.editorconfig` covers the files oxfmt does not format: shell scripts,
|
||||||
|
dotfiles, `LICENSE`, the commit-message template, and git's `COMMIT_EDITMSG`
|
||||||
|
buffer.
|
||||||
|
- oxfmt is the formatter; the overlapping keys only keep non-oxfmt editors close
|
||||||
|
to the formatted result, so they cannot disagree with the checker.
|
||||||
|
|
||||||
|
## Static analysis and packaging
|
||||||
|
|
||||||
|
### `knip` omits the `types` category
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`knip --include dependencies,exports,files` omits the `types` category.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `types` produces systematic false positives for libraries whose exported types
|
||||||
|
are part of the public API.
|
||||||
|
- The narrower scope keeps the signal high without config-file boilerplate.
|
||||||
|
|
||||||
|
### `maintain:outdated` ignores `@types/node`
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Pass `--ignore-packages @types/node`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- DT pins `@types/node`'s `latest` dist-tag to LTS (22.x); current-line types
|
||||||
|
ride other tags. Scan sees latest < installed — permanent "reverted", exit
|
||||||
|
1, zero signal. `--ignore-pre-releases` no help: 22.20.3 is stable.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- `--types major,minor,patch`: hides real reverted reports elsewhere.
|
||||||
|
- `@types/node@26.*`: tag stays wrong across majors; un-pin per bump = ritual.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- A genuinely behind `@types/node` goes unreported; match it to
|
||||||
|
`.node-version` by hand.
|
||||||
|
|
||||||
|
### `attw` targets ESM-only
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`attw --profile esm-only` is used.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The package is intentionally ESM-only (no CommonJS shim), so CJS resolution
|
||||||
|
scenarios are out of scope by design, not a bug.
|
||||||
|
|
||||||
|
### `tslib` is deliberately not used
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`tslib` is not a dependency.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `tslib` is a runtime helper for old ES3/ES5 targets; this project targets
|
||||||
|
ES2024.
|
||||||
|
|
||||||
|
## Git hooks and script wiring
|
||||||
|
|
||||||
|
### `LEFTHOOK_FILES` scopes commands to staged files
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
The pre-commit hook sets `LEFTHOOK_FILES` to the staged-files list, and the
|
||||||
|
affected scripts use `${LEFTHOOK_FILES:-<default>}` to default to the whole
|
||||||
|
project.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- It keeps `package.json#scripts` the single source of truth; `lefthook.yml`
|
||||||
|
only says what to run on which files.
|
||||||
|
- The same script works by hand (whole project) and staged (scoped), so there is
|
||||||
|
no second command to maintain.
|
||||||
|
|
||||||
|
## Language server tooling
|
||||||
|
|
||||||
|
### `vscode-languageserver-protocol` backs the autocomplete helper
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
The autocomplete helper (`src/util/__tests__/lsp-completion.ts`) drives
|
||||||
|
`tsc --lsp --stdio` through `vscode-languageserver-protocol`'s
|
||||||
|
`createMessageConnection` and its typed request / notification objects, instead
|
||||||
|
of a hand-rolled JSON-RPC client.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- Framing, `Content-Length` parsing, the pending-request map and server-request
|
||||||
|
dispatch are protocol plumbing the helper only reimplemented; the official
|
||||||
|
client owns them and tolerates the server's `string | number` ids.
|
||||||
|
- `InitializeRequest`, `CompletionRequest`, `DidOpenTextDocumentNotification`,
|
||||||
|
… carry their parameter and result types, so `CompletionList` / `CompletionItem`
|
||||||
|
replace the helper's ad-hoc shape guards.
|
||||||
|
- The `./node` entry re-exports `vscode-jsonrpc/node`, so one devDependency
|
||||||
|
supplies both the transport and the protocol types. It is test-only and never
|
||||||
|
ships (`files` publishes `dist/` only).
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- `vscode-languageclient`: the editor-side client with a full feature registry
|
||||||
|
— far more than a test helper needs.
|
||||||
|
- Generic JSON-RPC (`jsonrpc-lite`, `jayson`): still no LSP types, so they
|
||||||
|
replace framing only and leave the typed protocol surface unimplemented.
|
||||||
|
- Keeping the hand-rolled client: the low-level shape is the maintenance cost
|
||||||
|
the helper exists to remove, and it must be re-audited against the server.
|
||||||
|
|
||||||
|
## Editor and agent tooling
|
||||||
|
|
||||||
|
### VSCode integration
|
||||||
|
|
||||||
|
- Recommended extensions are in
|
||||||
|
[.vscode/extensions.json](../.vscode/extensions.json) (oxc, cspell, TypeScript
|
||||||
|
native-preview, EditorConfig, todo-tasks).
|
||||||
|
- TypeScript 7 runs via the `typescriptteam.native-preview` extension.
|
||||||
|
- The oxc extension provides oxlint squiggles and oxfmt format-on-save;
|
||||||
|
`.vscode/settings.json` pins it per language so a local `[language]` formatter
|
||||||
|
setting cannot override the project's choice.
|
||||||
|
|
||||||
|
### `@spences10/pi-lsp` is pinned and read-only
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`@spences10/pi-lsp` is pinned to `0.0.46` and used read-only.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- It inspects `node_modules/typescript`, sees major >= 7 with no
|
||||||
|
`lib/tsserver.js` (true of the `typescript-go` / `tsgo` port), and spawns the
|
||||||
|
repo's own `tsc --lsp --stdio` — no `typescript-language-server` dependency is
|
||||||
|
needed.
|
||||||
|
- Earlier releases (`<= 0.0.10`) hard-wire to `typescript-language-server
|
||||||
|
--stdio` and are TS6-only.
|
||||||
|
- It is _intermediate_ agent feedback (hover, references, definition, symbols,
|
||||||
|
diagnostics), with no rename / code-action / apply-edit surface, and is never a
|
||||||
|
gate — `npm run check` / `verify` are.
|
||||||
|
- `.pi/settings.json` is the committed declaration; `.pi/npm/` is a gitignored
|
||||||
|
install cache that pi recreates on a trusted startup (running `npm install`
|
||||||
|
for any missing project package), so it is deliberately not tracked.
|
||||||
@@ -0,0 +1,173 @@
|
|||||||
|
# Workflow
|
||||||
|
|
||||||
|
How work moves through the repository. The rules are in
|
||||||
|
[CONTRIBUTING.md](../CONTRIBUTING.md); this file records why they are shaped the
|
||||||
|
way they are.
|
||||||
|
|
||||||
|
## Branching model
|
||||||
|
|
||||||
|
The model is GitHub Flow (single-developer); the steps are in
|
||||||
|
[CONTRIBUTING.md § Branching model](../CONTRIBUTING.md#branching-model). Context
|
||||||
|
behind it: Gitea has no collaborative review UI in use, so it is the lab, and
|
||||||
|
the project moves to GitHub once it is tested and ready.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Work is opened and closed by `create:branch` / `create:finish`, not by prose
|
||||||
|
plus hand-written `git`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The preconditions were prose, and prose rots: a rule nobody checks is a
|
||||||
|
suggestion. A script asserts, then acts, so the branch or merge only exists if
|
||||||
|
the assertions passed.
|
||||||
|
- Type-driven work is only trustworthy if the baseline was green before the
|
||||||
|
first edit. Cheap checks run first and `npm run test` last, so the expensive
|
||||||
|
gate is not paid on an ineligible tree.
|
||||||
|
- The merge half owns the post-merge `npm run verify`, so a merge cannot land
|
||||||
|
unverified. The push stays with `create:release` so the merge is reviewed
|
||||||
|
locally first; `main` is therefore routinely ahead of its upstream between a
|
||||||
|
merge and the release that ships it. `create:branch` requires only that `main`
|
||||||
|
is not _behind_ — matching `create:finish`, which tolerates the local merge and
|
||||||
|
fast-forwards over a remote one — rather than an exact match.
|
||||||
|
- Every failure is non-mutating except the baseline test, which runs on `main`
|
||||||
|
after switching there: a red `main` restores the branch you started on, and a
|
||||||
|
merge conflict aborts back to the feature branch rather than stranding a
|
||||||
|
half-merged `main`.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Hand-written `git switch -c` / `git merge`: same rules, no enforcement.
|
||||||
|
- Reusing `pubv`'s preflight for `create:branch`: release-shaped, third-party,
|
||||||
|
and it would pay for a build and pack a new branch has no use for.
|
||||||
|
- Leaving the merge to reviewer judgment: that judgment moved earlier, to the
|
||||||
|
handover review before `create:finish`, rather than living in a command anyone
|
||||||
|
can run from a dirty tree.
|
||||||
|
- Fast-forward instead of `--no-ff`: `--no-ff` keeps each unit of work visible
|
||||||
|
in `git log`.
|
||||||
|
- Pushing from `create:finish` to keep `main` level with its upstream: it would
|
||||||
|
trade the local review the push waits for for a network side effect, and a
|
||||||
|
failed push would leave the merge landed but unpublished.
|
||||||
|
|
||||||
|
## Changelog notes
|
||||||
|
|
||||||
|
The rule is in
|
||||||
|
[CONTRIBUTING.md § Rules the tools don't enforce](../CONTRIBUTING.md#rules-the-tools-dont-enforce).
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A merged branch carries its own summary under `[Unreleased]` in
|
||||||
|
[CHANGELOG.md](../CHANGELOG.md), added before `create:finish`;
|
||||||
|
`create:release` graduates it into the tagged section (see
|
||||||
|
[publishing.md](./publishing.md)).
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `create:release` derives the bump heuristic from the `[Unreleased]` body, so
|
||||||
|
the notes must exist before release day.
|
||||||
|
- The contributor has fresh context; at release day the intent of a branch is
|
||||||
|
only its diff.
|
||||||
|
- Gitmoji subjects are signposts, not semantic keys, so notes cannot be derived
|
||||||
|
from the history.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Generating notes from subjects at release time: subjects carry no parseable
|
||||||
|
type/scope (see § Commit messages).
|
||||||
|
- The maintainer writing one summary during `create:release`: reconstruction
|
||||||
|
after the fact.
|
||||||
|
- Enforcing it in `create:finish`: the front doors assert git state, not
|
||||||
|
content — and _notable_ is exactly the judgment a tool cannot make.
|
||||||
|
|
||||||
|
## Script prefix convention
|
||||||
|
|
||||||
|
The prefix taxonomy is the rule, and it lives in
|
||||||
|
[CONTRIBUTING.md § Script prefix convention](../CONTRIBUTING.md#script-prefix-convention).
|
||||||
|
The design behind it: bare scripts are the tier entry points — a single tool
|
||||||
|
(`build`, `clean`) or an aggregator of a `prefix:*` family (`check`, `fix`,
|
||||||
|
`test`, `watch`, `maintain`, `setup`) — while `verify` composes `check` +
|
||||||
|
`test:unit` into the whole-project gate (it uses `test:unit`, not `test`,
|
||||||
|
because `check` already runs `check:tsc`).
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
`create:` is the prefix for workflow front doors, with no bare `create`
|
||||||
|
aggregator.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- Both members create something real: a branch, a release.
|
||||||
|
- It joined both lists in [CONTRIBUTING.md](../CONTRIBUTING.md) alongside its
|
||||||
|
first members, so it could not go invisible the way the retired `use:` prefix
|
||||||
|
did.
|
||||||
|
- `publish:*` already set the precedent for a prefix without an aggregator.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- `run:` / `perform:`: they mean only "do the named thing", so every script fits
|
||||||
|
and the taxonomy collapses.
|
||||||
|
- `git:`: names the tool, not the lifecycle moment, and implies passthrough
|
||||||
|
aliases.
|
||||||
|
- `start:`: describes the branch half, not the release.
|
||||||
|
- `cut:`: idiomatic but needs VCS slang to decode.
|
||||||
|
- `flow:`: overloaded in a type-level matching library.
|
||||||
|
- The existing families: `check:*` is read-only (CI would run a state-mutating
|
||||||
|
command), `fix:*` reviews as a diff not a branch, `maintain:*` is advisory and
|
||||||
|
never a gate.
|
||||||
|
|
||||||
|
## Feedback tiers
|
||||||
|
|
||||||
|
The table and invocation rules are in
|
||||||
|
[CONTRIBUTING.md § Feedback tiers](../CONTRIBUTING.md#feedback-tiers); this
|
||||||
|
section explains the split.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Fast, offline, staged-file checks sit in pre-commit; whole-project test runs in
|
||||||
|
pre-push and `verify`; slow or network-bound scans under `maintain`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- `watch:*` runs until killed, in its own pane, so it is the earliest tier,
|
||||||
|
firing on save before staging or commit.
|
||||||
|
- `check:tsc` / `check:oxlint` / `check:oxfmt` / `check:cspell` are fast
|
||||||
|
(~0.2–0.5s each), offline, and scope to staged files via `LEFTHOOK_FILES`, so
|
||||||
|
pre-commit gives instant feedback on what you typed.
|
||||||
|
- `test` (and its `tsc`) runs the whole suite over the whole project, and the
|
||||||
|
staged-file convention does not apply to the test runner, so it belongs in
|
||||||
|
pre-push, after the commits exist but before the push leaves the machine.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- `maintain:*` in `check` or pre-commit: advisory, whole-project and
|
||||||
|
network-bound scans are not correctness gates and would slow the fast tier.
|
||||||
|
- Treating a green pre-commit as the definition of done: it sees only staged
|
||||||
|
files, hence `npm run verify`.
|
||||||
|
- A separate `git push` hook for `verify`: the pre-push test tier already covers
|
||||||
|
it.
|
||||||
|
|
||||||
|
## Commit messages
|
||||||
|
|
||||||
|
The convention is in
|
||||||
|
[CONTRIBUTING.md § Commit messages](../CONTRIBUTING.md#commit-messages).
|
||||||
|
Examples: `:sparkles: Add watch tier with watch:test child`,
|
||||||
|
`:recycle: Move type-aware config to .oxlintrc.json; use source-level disable
|
||||||
|
directives`, `:memo: Restore unique maintainer content as CONTRIBUTING.md`. The
|
||||||
|
body explains what and why, not how; link issues with `Resolves #...`.
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
Gitmoji subjects, imperative mood, wrapped 50/72, not Conventional Commits.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- The history is gitmoji and predates any commit-lint tooling; switching would
|
||||||
|
rewrite the convention for no gain.
|
||||||
|
- The body carries the reasoning a reviewer needs; the subject is a signpost,
|
||||||
|
not a semantic key.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- Conventional Commits: the release flow uses hand-written Keep-a-Changelog
|
||||||
|
notes, not generated ones, so the prefix has no automation value here (see
|
||||||
|
[publishing.md](./publishing.md)).
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# CI job image for the Gitea act_runner: the runner's default job image with
|
||||||
|
# Node pre-planted where actions/setup-node looks first.
|
||||||
|
#
|
||||||
|
# Why this layout: setup-node ignores `node` on PATH; its only fast path is a
|
||||||
|
# probe of /opt/hostedtoolcache/node/<version>/<arch>. Without an entry there
|
||||||
|
# it downloads the ~50 MB distribution on EVERY job (the runner's job
|
||||||
|
# containers are ephemeral, so its tool cache never survives a job). The
|
||||||
|
# official node images keep exactly the layout setup-node expects under
|
||||||
|
# /usr/local, so this layer is a pure file overlay — no scripts, no env.
|
||||||
|
#
|
||||||
|
# Why not a host bind of /opt/hostedtoolcache: binds never self-prune. Docker
|
||||||
|
# images are content-addressed: the base layers dedupe against the act image
|
||||||
|
# the host already has, and `docker image prune` / re-pulls are the cleanup
|
||||||
|
# story.
|
||||||
|
#
|
||||||
|
# NODE_VERSION must match `.node-version` exactly. setup-node resolves a float
|
||||||
|
# like `26` to the latest known patch at runtime, so a bump silently busts the
|
||||||
|
# baked entry; `.node-version` is pinned to x.y.z and scripts/runner-image.sh
|
||||||
|
# guards the coupling. Rebuild + repoint `container.image` in
|
||||||
|
# .gitea/workflows/ci.yml on every bump.
|
||||||
|
#
|
||||||
|
# The extra `nodebase` stage is load-bearing: `COPY --from=` resolves its value
|
||||||
|
# as a *stage name* at parse time, before build args exist, so
|
||||||
|
# `COPY --from=node:${NODE_VERSION}` collapses to the invalid `node:` on
|
||||||
|
# frontends that do not expand args there. ARGs declared before the first FROM
|
||||||
|
# *are* expanded in FROM, so routing through a named stage works everywhere.
|
||||||
|
|
||||||
|
# Global scope: only visible to FROM lines, but that is exactly where we need it.
|
||||||
|
ARG NODE_VERSION=26.8.2
|
||||||
|
FROM node:${NODE_VERSION} AS nodebase
|
||||||
|
|
||||||
|
FROM catthehacker/ubuntu:act-latest
|
||||||
|
|
||||||
|
# ARGs do not cross stage boundaries; redeclare (with the same default, so a
|
||||||
|
# bare `docker build -f docker/Dockerfile .` still works) for the paths below.
|
||||||
|
# Keep this default in sync with the global one above.
|
||||||
|
ARG NODE_VERSION=26.8.2
|
||||||
|
|
||||||
|
# node image: bin/ + lib/ under /usr/local → tool cache: bin/ + lib/ under <ver>/x64.
|
||||||
|
COPY --from=nodebase /usr/local /opt/hostedtoolcache/node/${NODE_VERSION}/x64
|
||||||
|
|
||||||
|
# actions/tool-cache only accepts a cached tool when the sibling marker file
|
||||||
|
# "<version>/<arch>.complete" exists — tc.find() checks it and falls back to
|
||||||
|
# downloading otherwise, however complete the directory is. The marker is what
|
||||||
|
# tc.cacheDir() writes after *it* installs a tool, so a pre-baked entry has to
|
||||||
|
# reproduce it explicitly.
|
||||||
|
RUN touch "/opt/hostedtoolcache/node/${NODE_VERSION}/x64.complete"
|
||||||
|
|
||||||
|
# Fail the build (not CI) if the overlay or the version arg were wrong.
|
||||||
|
# Shell form on purpose: exec form (`RUN [...]`) does not expand ARG values.
|
||||||
|
RUN "/opt/hostedtoolcache/node/${NODE_VERSION}/x64/bin/node" --version
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"$schema": "./node_modules/knip/schema.json",
|
||||||
|
"entry": ["scripts/*.ts"],
|
||||||
|
"ignoreDependencies": ["@runwisp/pubv"]
|
||||||
|
}
|
||||||
+18
-26
@@ -1,29 +1,21 @@
|
|||||||
|
min_version: 2.0.0
|
||||||
|
|
||||||
pre-commit:
|
pre-commit:
|
||||||
parallel: true
|
parallel: true
|
||||||
jobs:
|
commands:
|
||||||
- name: oxlint
|
oxlint:
|
||||||
glob: "*.{ts,tsx,js,jsx,mjs,cjs}"
|
glob: "*.{ts,tsx,js,jsx,mjs,cjs}"
|
||||||
run: npx oxlint {staged_files}
|
run: sh -c 'LEFTHOOK_FILES="$*" npm run check:oxlint' sh {staged_files}
|
||||||
- name: oxfmt
|
oxfmt:
|
||||||
glob: "*.{ts,tsx,js,jsx,mjs,cjs}"
|
glob: "*.{ts,tsx,js,jsx,mjs,cjs,json,jsonc,yaml,yml,md,mdx}"
|
||||||
run: npx oxfmt --check {staged_files}
|
run: sh -c 'LEFTHOOK_FILES="$*" npm run check:oxfmt' sh {staged_files}
|
||||||
- name: cspell
|
cspell:
|
||||||
run: npx cspell {staged_files}
|
run: sh -c 'LEFTHOOK_FILES="$*" npm run check:cspell' sh {staged_files}
|
||||||
- name: sort-package-json
|
typecheck:
|
||||||
run: npx sort-package-json --check
|
run: npm run check:tsc
|
||||||
- name: typecheck
|
|
||||||
run: npx tsc --noEmit
|
|
||||||
|
|
||||||
commands:
|
pre-push:
|
||||||
typecheck:
|
parallel: false
|
||||||
run: npm run check:tsc
|
commands:
|
||||||
spell:
|
test:
|
||||||
run: npm run check:cspell
|
run: npm test
|
||||||
sort:
|
|
||||||
run: npm run check:package
|
|
||||||
lint:
|
|
||||||
run: npm run check:oxlint
|
|
||||||
format:
|
|
||||||
run: npm run check:oxfmt
|
|
||||||
outdated:
|
|
||||||
run: npm run check:outdated
|
|
||||||
Generated
+2394
-1030
File diff suppressed because it is too large.
Load diff
+72
-46
@@ -1,73 +1,99 @@
|
|||||||
{
|
{
|
||||||
"name": "tiny-pattern-ts",
|
"name": "tiny-pattern-ts",
|
||||||
"version": "0.0.0",
|
"version": "0.4.0",
|
||||||
"description": "Pattern matching for TypeScript/ESM environments (F#-style, not regex)",
|
"description": "Pattern matching for TypeScript/ESM environments (F#-style, not regex)",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"pattern-matching",
|
|
||||||
"pattern",
|
|
||||||
"match",
|
|
||||||
"algebraic-data-types",
|
|
||||||
"adt",
|
"adt",
|
||||||
|
"algebraic-data-types",
|
||||||
|
"match",
|
||||||
|
"pattern",
|
||||||
|
"pattern-matching",
|
||||||
"typescript"
|
"typescript"
|
||||||
],
|
],
|
||||||
"repository": {
|
"homepage": "https://gitea.e1nsnull.de/tmu/tiny-pattern-ts#readme",
|
||||||
"type": "git",
|
"bugs": {
|
||||||
"url": "https://github.com/tmueller/tiny-pattern-ts.git"
|
"url": "https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/issues"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"sideEffects": false,
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://gitea.e1nsnull.de/tmu/tiny-pattern-ts.git"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"dist",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"README.md",
|
||||||
|
"LICENSE"
|
||||||
|
],
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"sideEffects": false,
|
||||||
|
"imports": {
|
||||||
|
"#test-utils/*": "./src/util/__tests__/*"
|
||||||
|
},
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"import": "./dist/index.js"
|
"import": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"main": "./dist/index.js",
|
"publishConfig": {
|
||||||
"types": "./dist/index.d.ts",
|
"access": "public"
|
||||||
"files": [
|
},
|
||||||
"dist",
|
|
||||||
"README.md",
|
|
||||||
"LICENSE"
|
|
||||||
],
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc -p tsconfig.build.json",
|
"build": "tsc -p tsconfig.build.json",
|
||||||
"check": "npm run check:oxlint && npm run check:oxfmt && npm run check:tsc && npm run check:cspell && npm run check:package && npm run check:outdated",
|
"prebuild": "rm -rf dist",
|
||||||
"check:cspell": "cspell .",
|
"check": "npm run check:tsc && npm run check:oxlint && npm run check:oxfmt && npm run check:cspell",
|
||||||
"check:outdated": "check-outdated",
|
"check:cspell": "cspell lint ${LEFTHOOK_FILES:-.}",
|
||||||
"check:oxfmt": "oxfmt --check src",
|
"check:oxfmt": "oxfmt --check ${LEFTHOOK_FILES:-.}",
|
||||||
"check:oxlint": "oxlint src",
|
"check:oxlint": "oxlint ${LEFTHOOK_FILES:-src scripts}",
|
||||||
"check:package": "sort-package-json --check",
|
"check:tsc": "tsc",
|
||||||
"check:tsc": "tsc --noEmit",
|
"clean": "rm -rf dist coverage",
|
||||||
"clean": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\"",
|
"fix": "npm run fix:oxlint && npm run fix:oxfmt",
|
||||||
"fix:oxfmt": "oxfmt src",
|
"fix:oxfmt": "oxfmt ${LEFTHOOK_FILES:-.}",
|
||||||
"fix:oxlint": "oxlint --fix src",
|
"fix:oxlint": "oxlint --fix src scripts",
|
||||||
"fix:package": "sort-package-json --write",
|
"create:branch": "./scripts/branch.sh",
|
||||||
"test": "npm run check:tsc && node --test --strip-types src/",
|
"create:finish": "./scripts/finish.sh",
|
||||||
"test:ci": "c8 --reporter=text --reporter=lcov --reporter=html node --test --strip-types src/",
|
"create:release": "./scripts/release.sh",
|
||||||
"test:unit": "node --test --strip-types src/",
|
"maintain": "npm run maintain:knip; npm run maintain:outdated",
|
||||||
"use:git-commit-message": "cp commit-message-template .git/COMMIT_EDITMSG || true"
|
"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:unit": "node --test --strip-types \"src/**/*.test.ts\"",
|
||||||
|
"verify": "npm run check && npm run test:unit",
|
||||||
|
"watch": "npm run watch:test",
|
||||||
|
"watch:test": "node --test --watch --strip-types \"src/**/*.test.ts\"",
|
||||||
|
"publish:attw": "attw . --pack --profile esm-only",
|
||||||
|
"publish:publint": "publint",
|
||||||
|
"setup": "npm run setup:git-commit-message",
|
||||||
|
"setup:git-commit-message": "git config commit.template commit-message-template"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"type-fest": "^5.9.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@oxfmt/binding-linux-x64-musl": "^0.66.0",
|
"@arethetypeswrong/cli": "^0.18.5",
|
||||||
"@oxlint/binding-linux-x64-musl": "^1.81.0",
|
"@runwisp/pubv": "^1.5.1",
|
||||||
"@types/node": "^22.10.0",
|
"@tsconfig/node26": "^26.0.1",
|
||||||
"c8": "^10.1.3",
|
"@tsconfig/strictest": "^2.0.8",
|
||||||
"check-outdated": "^2.13.0",
|
"@types/node": "^26.6.1",
|
||||||
"cspell": "^8.19.3",
|
"c8": "^12.0.0",
|
||||||
|
"check-outdated": "^3.0.0",
|
||||||
|
"cspell": "^10.3.2",
|
||||||
"expect-type": "1.4.0",
|
"expect-type": "1.4.0",
|
||||||
"lefthook": "^1.11.12",
|
"knip": "^6.34.0",
|
||||||
"oxfmt": "^0.66.0",
|
"lefthook": "^2.1.12",
|
||||||
"oxlint": "^1.81.0",
|
"oxfmt": "^0.68.0",
|
||||||
"sort-package-json": "^3.1.0",
|
"oxlint": "^1.83.0",
|
||||||
"tslib": "^2.8.1",
|
"oxlint-tsgolint": "^7.0.2001",
|
||||||
"type-fest": "^4.40.1",
|
"publint": "^0.3.24",
|
||||||
"typescript": "^7.0.2"
|
"typescript": "^7.0.2",
|
||||||
|
"vscode-languageserver-protocol": "^3.18.3"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=26"
|
"node": ">=26"
|
||||||
},
|
},
|
||||||
"publishConfig": {
|
"allowScripts": {
|
||||||
"access": "public"
|
"lefthook@2.1.14": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,296 +0,0 @@
|
|||||||
# Project Specifications for TypeScript NPM Module
|
|
||||||
|
|
||||||
- name of package: tiny-pattern-ts
|
|
||||||
|
|
||||||
## 0. References
|
|
||||||
|
|
||||||
typescript-lib-starter-tiny => https://github.com/tmueller/typescript-lib-starter-tiny/
|
|
||||||
|
|
||||||
## 1. Development Environment
|
|
||||||
|
|
||||||
- **TypeScript**: Use strictest rules (via npm package "@tsconfig/strictest", additional strictures)
|
|
||||||
- **EditorConfig**: Use `.editorconfig` from typescript-lib-starter-tiny
|
|
||||||
- **Prettier**: For code formatting, integrated with ESLint
|
|
||||||
- **ESLint**: Strictest type-checked rules, integrated with Prettier
|
|
||||||
- **Import Sorting**: Via Prettier or ESLint
|
|
||||||
- **cspell**: Basic spelling configuration
|
|
||||||
- **Lefthook**: Pre-commit checks for:
|
|
||||||
|
|
||||||
- Type checking
|
|
||||||
- Spelling
|
|
||||||
- Package sorting
|
|
||||||
- Linting
|
|
||||||
- Formatting
|
|
||||||
- Outdated Packages
|
|
||||||
|
|
||||||
- **Additional Dev Dependencies**:
|
|
||||||
|
|
||||||
- lefthook
|
|
||||||
- sort-package-json
|
|
||||||
- check-outdated
|
|
||||||
|
|
||||||
## 2. Build & Test
|
|
||||||
|
|
||||||
- **Build Tool**: Vite (ESM only, no CJS)
|
|
||||||
- **Testing**: Vitest
|
|
||||||
- **TypeScript Build Output**: `dist` directory
|
|
||||||
- **Additional Runtime Dependencies**:
|
|
||||||
- tslib
|
|
||||||
- type-fest
|
|
||||||
|
|
||||||
## 3. Project Structure & Files
|
|
||||||
|
|
||||||
- __.gitignore__: Ignore `dist`, `node_modules`, and other common files
|
|
||||||
- **.npmignore**: Ignore `src` and other non-dist files
|
|
||||||
- **LICENSE**: MIT
|
|
||||||
- **README.md**: Scaffolded
|
|
||||||
- **commit-message-template**: From typescript-lib-starter-tiny
|
|
||||||
- **Target Environments**: Browser and latest LTS Node.js
|
|
||||||
- **No React, No CJS, ESM only**
|
|
||||||
|
|
||||||
## 4. Automation & Quality
|
|
||||||
|
|
||||||
- **Version Automation**: Use standard `npm version` for versioning
|
|
||||||
- **Unused Dependency Check**: Use `check-outdated` with config
|
|
||||||
- **No commitlint, no conventional commits**
|
|
||||||
|
|
||||||
## 5. Scripts (Clustered as in typescript-lib-starter-tiny, named similarly)
|
|
||||||
|
|
||||||
### SETUP
|
|
||||||
|
|
||||||
- `use:git-commit-message`: Set up commit message template (if needed)
|
|
||||||
|
|
||||||
### TEST
|
|
||||||
|
|
||||||
- `test`: Run typecheck and all tests
|
|
||||||
- `test:unit`: Run unit tests with Vitest
|
|
||||||
- `test:ci`: Run tests in CI mode (with coverage, fail-fast)
|
|
||||||
|
|
||||||
### BUILD
|
|
||||||
|
|
||||||
- `build`: Build the project using Vite
|
|
||||||
|
|
||||||
### CLEAN
|
|
||||||
|
|
||||||
- `clean`: Clean build output
|
|
||||||
- `clean:build`: Remove dist directory
|
|
||||||
|
|
||||||
### CHECK
|
|
||||||
|
|
||||||
- `check`: Run all checks (lint, spell, typecheck, import/package sort, outdated)
|
|
||||||
- `check:eslint`: Run ESLint
|
|
||||||
- `check:prettier`: Check formatting with Prettier
|
|
||||||
- `check:cspell`: Run cspell
|
|
||||||
- `check:tsc`: TypeScript typecheck (no emit)
|
|
||||||
- `check:package`: Check package.json sort
|
|
||||||
- `check:outdated`: Check for unused/outdated dependencies
|
|
||||||
|
|
||||||
### FIX
|
|
||||||
|
|
||||||
- `fix`: Run all fixers (eslint, prettier, package sort)
|
|
||||||
- `fix:eslint`: Auto-fix ESLint issues
|
|
||||||
- `fix:prettier`: Auto-fix formatting with Prettier
|
|
||||||
- `fix:package`: Auto-fix package.json sort
|
|
||||||
|
|
||||||
### HOOKS
|
|
||||||
|
|
||||||
- Lefthook will run relevant scripts on staged files for pre-commit (typecheck, lint, spell, sort, format, check:outdated)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Repository & CI/CD
|
|
||||||
|
|
||||||
- **Repository**: Hosted on GitHub
|
|
||||||
- **Build Pipeline**: Use GitHub Actions for CI/CD
|
|
||||||
- On push and pull request: run build, lint, typecheck, test:ci, spell, check:outdated
|
|
||||||
- On release (tagged commit): publish to npm
|
|
||||||
|
|
||||||
## 7. Versioning & Publishing
|
|
||||||
|
|
||||||
- **Version Update**: Use `npm version` to bump version after merging to main and before publishing
|
|
||||||
- **Publishing to npm**: Only publish from CI on tagged commits (e.g., after version bump and release notes)
|
|
||||||
- **Recommended Workflow**:
|
|
||||||
1. Develop and merge PRs to main
|
|
||||||
2. Run all checks via CI
|
|
||||||
3. Bump version with `npm version <patch|minor|major>`
|
|
||||||
4. Push tag to GitHub
|
|
||||||
5. CI builds and publishes to npm on tag
|
|
||||||
|
|
||||||
## 8. NPM Keywords
|
|
||||||
|
|
||||||
- pattern-matching
|
|
||||||
- pattern
|
|
||||||
- match
|
|
||||||
- algebraic-data-types
|
|
||||||
- adt
|
|
||||||
- typescript
|
|
||||||
|
|
||||||
> The library is for pattern matching (not regex), similar to F#'s pattern matching, for TypeScript/ESM environments.
|
|
||||||
|
|
||||||
## 9. Code Coverage
|
|
||||||
|
|
||||||
- **Configuration**:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { defineConfig } from 'vitest/config';
|
|
||||||
export default defineConfig({
|
|
||||||
test: {
|
|
||||||
coverage: {
|
|
||||||
reporter: ['text', 'html', 'lcov'],
|
|
||||||
include: ['src/**/*.ts'],
|
|
||||||
exclude: ['src/**/*.test.ts', 'test/**'],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
- Coverage reports: text summary, HTML, and lcov formats
|
|
||||||
|
|
||||||
- Add coverage thresholds if desired
|
|
||||||
|
|
||||||
- **CI**: Ensure coverage is generated and optionally uploaded as an artifact or checked for minimum thresholds
|
|
||||||
|
|
||||||
## 10. Source Structure & Tree Shaking
|
|
||||||
|
|
||||||
- **Source Directory**: All source code resides in `src/` and is exported via `src/index.ts`.
|
|
||||||
- **Configuration**:
|
|
||||||
- Ensure `sideEffects: false` in `package.json`
|
|
||||||
- Use ESM-only exports
|
|
||||||
- Avoid top-level side effects in modules
|
|
||||||
- Prefer explicit exports in `index.ts` for best results
|
|
||||||
- the human will implement the source code
|
|
||||||
|
|
||||||
## 11. Included Templates from typescript-lib-starter-tiny
|
|
||||||
|
|
||||||
### .editorconfig
|
|
||||||
|
|
||||||
```plaintext
|
|
||||||
# Editor configuration, see http://editorconfig.org
|
|
||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
charset = utf-8
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
insert_final_newline = true
|
|
||||||
max_line_length = 80
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
quote_type = double
|
|
||||||
|
|
||||||
[*.md]
|
|
||||||
max_line_length = 0
|
|
||||||
trim_trailing_whitespace = false
|
|
||||||
|
|
||||||
[COMMIT_EDITMSG]
|
|
||||||
max_line_length = 0
|
|
||||||
```
|
|
||||||
|
|
||||||
### commit-message-template
|
|
||||||
|
|
||||||
```plaintext
|
|
||||||
# If applied, this commit will... (Max 50 char)
|
|
||||||
|
|
||||||
|
|
||||||
# Explain why this change is being made (Max 72 Char) [WHAT and WHY vs HOW]
|
|
||||||
|
|
||||||
|
|
||||||
# Provide links or keys to any relevant tickets, articles or other resources
|
|
||||||
Resolves #...
|
|
||||||
|
|
||||||
# --- COMMIT END ---
|
|
||||||
# Remember to
|
|
||||||
# Use the imperative mood in the subject line
|
|
||||||
# Capitalize the subject line
|
|
||||||
# Do not end the subject line with a period
|
|
||||||
# Separate subject from body with a blank line
|
|
||||||
# Use the body to explain what and why vs. how
|
|
||||||
# Can use multiple lines with "-" for bullet points in body
|
|
||||||
```
|
|
||||||
|
|
||||||
### README.md Structure (to scaffold)
|
|
||||||
|
|
||||||
- Project title and description
|
|
||||||
- Development
|
|
||||||
- Build: `npm run build`
|
|
||||||
- Test: `npm run test`, `npm run test:ci`
|
|
||||||
- Checks: `npm run check`, `npm run fix`
|
|
||||||
- VSCode integration
|
|
||||||
- Debugging
|
|
||||||
- Running tests
|
|
||||||
- Document workflows like
|
|
||||||
- Version updates
|
|
||||||
- Changelog automation
|
|
||||||
- Publishing
|
|
||||||
- Contribution guidelines
|
|
||||||
- Commit signing (GPG)
|
|
||||||
- How to set up commit message template
|
|
||||||
- Reference to commit-message-template
|
|
||||||
|
|
||||||
## 12. Project Initialization & Commit Strategy
|
|
||||||
|
|
||||||
- Start by initilizing git with a main branch
|
|
||||||
- Initial commit: add an empty README.md
|
|
||||||
- create a feature branch: `feature/setup`
|
|
||||||
- For each technology or tool added (and its configuration), create a separate commit:
|
|
||||||
- Prepend each commit message with a matching gitmoji (e.g., :sparkles: for new features, :wrench: for config, etc.)
|
|
||||||
- Example commit messages:
|
|
||||||
- :tada: Initial commit with empty README
|
|
||||||
- :sparkles: Configured Vite (Vite-specific setup)
|
|
||||||
- :sparkles: Configured TypeScript (may be merged with Vite if dependent)
|
|
||||||
- :wrench: Configured ESLint
|
|
||||||
- :wrench: Configured Prettier
|
|
||||||
- ...and so on for each technology/tool
|
|
||||||
- Each commit should include only the relevant files and configuration for that technology/tool
|
|
||||||
- This approach ensures a clean, understandable project history and makes it easy to review or revert specific setup steps
|
|
||||||
|
|
||||||
|
|
||||||
## 13. Changelog Automation
|
|
||||||
|
|
||||||
- Use a tool like standard-version or changesets to automate changelog generation from commit messages or PRs.
|
|
||||||
- Ensure changelog is updated as part of the release process.
|
|
||||||
|
|
||||||
## 14. Publishing Public
|
|
||||||
|
|
||||||
- Configure npm publishing to be public by default.
|
|
||||||
- Add `"publishConfig": { "access": "public" }` to package.json.
|
|
||||||
- Ensure CI/CD pipeline publishes with public access.
|
|
||||||
|
|
||||||
## 15. VSCode Integration
|
|
||||||
|
|
||||||
- Add a `.vscode/settings.json` with the following content:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"typescript.tsdk": "node_modules/typescript/lib",
|
|
||||||
"[typescript]": {
|
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
||||||
"editor.formatOnSave": true
|
|
||||||
},
|
|
||||||
"[json]": {
|
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
||||||
"editor.formatOnSave": true
|
|
||||||
},
|
|
||||||
"[mdx]": {
|
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
||||||
"editor.formatOnSave": true
|
|
||||||
},
|
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
||||||
"editor.formatOnSave": true,
|
|
||||||
"[javascript]": {
|
|
||||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
||||||
"editor.formatOnSave": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Add `.vscode/extensions.json` with recommended extensions:
|
|
||||||
- `esbenp.prettier-vscode` (Prettier)
|
|
||||||
- `dbaeumer.vscode-eslint` (ESLint)
|
|
||||||
- `streetsidesoftware.code-spell-checker` (cspell)
|
|
||||||
- `vitest.explorer` (for test integration)
|
|
||||||
- TODO: Native test extension with node test runner
|
|
||||||
- `ms-vscode.vscode-typescript-next` (for latest TS features, optional)
|
|
||||||
|
|
||||||
- Add `.vscode/tasks.json` for common tasks (optional):
|
|
||||||
- Build, test, lint, typecheck, format, spell, check:outdated
|
|
||||||
- Ensure VSCode uses workspace TypeScript version and Prettier for formatting
|
|
||||||
Executable
+124
@@ -0,0 +1,124 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
# Branch front-door. Run as `npm run create:branch -- <prefix>/<desc>`.
|
||||||
|
#
|
||||||
|
# Asserts the branch preconditions — clean tree, no in-progress operation,
|
||||||
|
# current `main`, green baseline — and only then creates the branch, so the
|
||||||
|
# expensive `npm run test` is not paid on a tree that was never eligible.
|
||||||
|
#
|
||||||
|
# Why the front door exists, the rejected prefix names, and the `create:`
|
||||||
|
# decision: development/workflow.md § Branching model and § Script prefix
|
||||||
|
# convention.
|
||||||
|
|
||||||
|
BASE="main"
|
||||||
|
PREFIXES="feature fix chore"
|
||||||
|
NAME="${1:-}"
|
||||||
|
|
||||||
|
if [ -z "${NAME}" ]; then
|
||||||
|
echo "usage: npm run create:branch -- <prefix>/<desc> (prefix: ${PREFIXES})" >&2
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
|
||||||
|
git rev-parse --is-inside-work-tree >/dev/null 2>&1 || {
|
||||||
|
echo "error: not inside a git work tree." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
MATCH=0
|
||||||
|
for p in ${PREFIXES}; do
|
||||||
|
case "${NAME}" in
|
||||||
|
"${p}/"*) MATCH=1 ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
if [ "${MATCH}" -ne 1 ]; then
|
||||||
|
echo "error: '${NAME}' must start with one of: ${PREFIXES}." >&2
|
||||||
|
echo " the prefix is inferred from the task, not defaulted here." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
git check-ref-format --branch "${NAME}" >/dev/null 2>&1 || {
|
||||||
|
echo "error: '${NAME}' is not a valid branch name." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
git show-ref --verify --quiet "refs/heads/${NAME}" && {
|
||||||
|
echo "error: branch '${NAME}' already exists; switch to it instead." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
START_REF=$(git symbolic-ref --quiet --short HEAD || true)
|
||||||
|
if [ -z "${START_REF}" ]; then
|
||||||
|
echo "error: detached HEAD; switch to a branch first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
STATE_ROOT=$(git rev-parse --absolute-git-dir)
|
||||||
|
for state in MERGE_HEAD rebase-merge rebase-apply CHERRY_PICK_HEAD BISECT_LOG; do
|
||||||
|
[ -e "${STATE_ROOT}/${state}" ] && {
|
||||||
|
echo "error: a '${state}' operation is in progress; finish or abort it first." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
done
|
||||||
|
# `--porcelain` is deliberately stricter than `git diff --quiet`: it also reports
|
||||||
|
# untracked files, which would otherwise ride silently onto the new branch.
|
||||||
|
DIRTY=$(git status --porcelain)
|
||||||
|
if [ -n "${DIRTY}" ]; then
|
||||||
|
echo "error: working tree is not clean:" >&2
|
||||||
|
echo "${DIRTY}" | sed 's/^/ /' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
git show-ref --verify --quiet "refs/heads/${BASE}" || {
|
||||||
|
echo "error: no local '${BASE}' to branch from." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Derive the remote rather than hardcoding it: `main` tracks `origin` (ssh)
|
||||||
|
# here; a hardcoded name would check currency against a ref that may not
|
||||||
|
# exist on a differently configured clone.
|
||||||
|
# `--quiet` echoes the unresolved `main@{upstream}` literal to stdout on
|
||||||
|
# failure, so it cannot be paired with a `$(...) || fallback`; the non-quiet
|
||||||
|
# form prints nothing on failure and the fallback runs.
|
||||||
|
UPSTREAM=$(git rev-parse --abbrev-ref --symbolic-full-name "${BASE}@{upstream}" 2>/dev/null) || UPSTREAM=""
|
||||||
|
if [ -n "${UPSTREAM}" ]; then
|
||||||
|
git fetch --quiet "${UPSTREAM%/*}" "${UPSTREAM#*/}" || {
|
||||||
|
echo "error: '${UPSTREAM}' check failed: could not reach '${UPSTREAM%/*}'." >&2
|
||||||
|
echo " refusing to branch on a possibly stale '${BASE}'." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
# Only *behind* is a problem. `create:finish` deliberately leaves the local
|
||||||
|
# merge on '${BASE}' until `create:release` pushes it, so being ahead is the
|
||||||
|
# normal state between a merge and the release that ships it; branching from
|
||||||
|
# those commits is intended. Missing remote commits is not.
|
||||||
|
BEHIND=$(git rev-list --count "${BASE}..${UPSTREAM}")
|
||||||
|
if [ "${BEHIND}" -ne 0 ]; then
|
||||||
|
echo "error: '${BASE}' is behind '${UPSTREAM}' (by ${BEHIND})." >&2
|
||||||
|
echo " update it: git switch ${BASE} && git pull --ff-only" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "warning: '${BASE}' has no upstream; freshness against the remote is unchecked." >&2
|
||||||
|
fi
|
||||||
|
|
||||||
|
restore() {
|
||||||
|
git switch --quiet "${START_REF}" 2>/dev/null || true
|
||||||
|
}
|
||||||
|
trap 'restore' EXIT HUP INT TERM
|
||||||
|
|
||||||
|
if [ "${START_REF}" != "${BASE}" ]; then
|
||||||
|
git switch --quiet "${BASE}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Baseline: npm run test"
|
||||||
|
if ! npm run --silent test; then
|
||||||
|
echo "error: baseline is red on '${BASE}'; fix that first so later failures stay attributable." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
git switch --quiet --no-track -c "${NAME}"
|
||||||
|
trap - EXIT HUP INT TERM
|
||||||
|
|
||||||
|
# push.default=upstream is set here, so an inherited upstream would make a bare
|
||||||
|
# `git push` target main. Branching local-from-local does not set one anyway;
|
||||||
|
# --no-track says so out loud.
|
||||||
|
echo "Created ${NAME} from ${BASE} $(git rev-parse --short "${BASE}")."
|
||||||
Executable
+121
@@ -0,0 +1,121 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
# Feature-finish front door. Run as `npm run create:finish`.
|
||||||
|
#
|
||||||
|
# Mirror image of `create:branch`: asserts the merge-side preconditions, merges
|
||||||
|
# the current `feature/`/`fix/`/`chore/` branch into `main` with `--no-ff`,
|
||||||
|
# proves the result with `npm run verify`, and only then deletes the branch. The
|
||||||
|
# push is owned by `create:release`, so the merge stays local and reviewable.
|
||||||
|
# On a conflict it aborts and returns to the feature branch.
|
||||||
|
#
|
||||||
|
# Rationale and the rejected alternatives: development/workflow.md § Branching
|
||||||
|
# model.
|
||||||
|
|
||||||
|
BASE="main"
|
||||||
|
PREFIXES="feature fix chore"
|
||||||
|
|
||||||
|
git rev-parse --is-inside-work-tree >/dev/null 2>&1 || {
|
||||||
|
echo "error: not inside a git work tree." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
STATE_ROOT=$(git rev-parse --absolute-git-dir)
|
||||||
|
for state in MERGE_HEAD rebase-merge rebase-apply CHERRY_PICK_HEAD BISECT_LOG; do
|
||||||
|
[ -e "${STATE_ROOT}/${state}" ] && {
|
||||||
|
echo "error: a '${state}' operation is in progress; finish or abort it first." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
done
|
||||||
|
|
||||||
|
# `--porcelain` is deliberately stricter than `git diff --quiet`: it also
|
||||||
|
# reports untracked files, which would otherwise not be part of the merge and
|
||||||
|
# silently outlive the branch deletion.
|
||||||
|
DIRTY=$(git status --porcelain)
|
||||||
|
if [ -n "${DIRTY}" ]; then
|
||||||
|
echo "error: working tree is not clean:" >&2
|
||||||
|
echo "${DIRTY}" | sed 's/^/ /' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
START_REF=$(git symbolic-ref --quiet --short HEAD || true)
|
||||||
|
if [ -z "${START_REF}" ]; then
|
||||||
|
echo "error: detached HEAD; switch to the branch you want to finish." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "${START_REF}" = "${BASE}" ]; then
|
||||||
|
echo "error: already on '${BASE}'; switch to the branch to finish." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
MATCH=0
|
||||||
|
for p in ${PREFIXES}; do
|
||||||
|
case "${START_REF}" in
|
||||||
|
"${p}/"*) MATCH=1 ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
if [ "${MATCH}" -ne 1 ]; then
|
||||||
|
echo "error: '${START_REF}' must start with one of: ${PREFIXES}." >&2
|
||||||
|
echo " refusing to merge a branch that is not a unit of work." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
git show-ref --verify --quiet "refs/heads/${BASE}" || {
|
||||||
|
echo "error: no local '${BASE}' to merge into." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Derive the remote rather than hardcoding it: this repo has `origin` (ssh) and
|
||||||
|
# `origin_https`, and `main` tracks the latter — `git fetch origin main` would
|
||||||
|
# check currency against a ref that is never updated here.
|
||||||
|
# `--quiet` echoes the unresolved `main@{upstream}` literal to stdout on
|
||||||
|
# failure, so it cannot be paired with a `$(...) || fallback`; the non-quiet
|
||||||
|
# form prints nothing on failure and the fallback runs.
|
||||||
|
UPSTREAM=$(git rev-parse --abbrev-ref --symbolic-full-name "${BASE}@{upstream}" 2>/dev/null) || UPSTREAM=""
|
||||||
|
BEHIND=0
|
||||||
|
if [ -n "${UPSTREAM}" ]; then
|
||||||
|
git fetch --quiet "${UPSTREAM%/*}" "${UPSTREAM#*/}" || {
|
||||||
|
echo "error: '${UPSTREAM}' check failed: could not reach '${UPSTREAM%/*}'." >&2
|
||||||
|
echo " refusing to merge onto a possibly stale '${BASE}'." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
BEHIND=$(git rev-list --count "${BASE}..${UPSTREAM}")
|
||||||
|
AHEAD=$(git rev-list --count "${UPSTREAM}..${BASE}")
|
||||||
|
if [ "${AHEAD}" -ne 0 ] && [ "${BEHIND}" -ne 0 ]; then
|
||||||
|
echo "error: '${BASE}' has diverged from '${UPSTREAM}' (ahead ${AHEAD}, behind ${BEHIND})." >&2
|
||||||
|
echo " reconcile '${BASE}' with '${UPSTREAM}' before finishing." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "warning: '${BASE}' has no upstream; freshness against the remote is unchecked." >&2
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Finishing into ${BASE}:"
|
||||||
|
git --no-pager log --oneline --no-decorate "${BASE}..${START_REF}" | sed 's/^/ /'
|
||||||
|
|
||||||
|
git switch --quiet "${BASE}"
|
||||||
|
if [ "${BEHIND}" -ne 0 ]; then
|
||||||
|
echo "Fast-forwarding ${BASE} to ${UPSTREAM} (${BEHIND} commit(s))."
|
||||||
|
git merge --quiet --ff-only "${UPSTREAM}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! git merge --quiet --no-ff -m ":twisted_rightwards_arrows: Merge ${START_REF} into ${BASE}" "${START_REF}"; then
|
||||||
|
echo "error: merge of '${START_REF}' failed; aborting and returning to it." >&2
|
||||||
|
git merge --abort 2>/dev/null || true
|
||||||
|
git switch --quiet "${START_REF}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Verify: npm run verify"
|
||||||
|
if ! npm run --silent verify; then
|
||||||
|
echo "error: 'npm run verify' is red after the merge." >&2
|
||||||
|
echo " the merge is local and not yet pushed; fix it on '${BASE}' and commit," >&2
|
||||||
|
echo " then drop the now-merged branch with 'git branch -d ${START_REF}'." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
git branch --delete "${START_REF}" >/dev/null
|
||||||
|
echo "Merged ${START_REF} into ${BASE} and deleted the branch."
|
||||||
|
echo "Next: npm run create:release (or git push, for a merge with no release)."
|
||||||
@@ -0,0 +1,147 @@
|
|||||||
|
import fs from "node:fs";
|
||||||
|
import path from "node:path";
|
||||||
|
import zlib from "node:zlib";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Emit precompressed `.br` / `.gz` / `.zst` sidecars next to every text asset
|
||||||
|
* under the given directories, keeping the originals. The Gitea pages service
|
||||||
|
* (`static-web-server` with `SERVER_COMPRESSION_STATIC=true`) serves the sidecar
|
||||||
|
* matching `Accept-Encoding` and falls back to the original for the rest.
|
||||||
|
*
|
||||||
|
* Usage: node --strip-types scripts/precompress.ts <dir> [<dir>...]
|
||||||
|
*
|
||||||
|
* Why sidecars rather than per-request compression: development/ci.md § Coverage
|
||||||
|
* serving.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only extensions worth compressing. Images, fonts and archives are already
|
||||||
|
* compressed, so a sidecar would only make them bigger.
|
||||||
|
*/
|
||||||
|
const TEXT_EXTENSIONS: ReadonlySet<string> = new Set([
|
||||||
|
".css",
|
||||||
|
".htm",
|
||||||
|
".html",
|
||||||
|
".info",
|
||||||
|
".js",
|
||||||
|
".json",
|
||||||
|
".map",
|
||||||
|
".md",
|
||||||
|
".mjs",
|
||||||
|
".svg",
|
||||||
|
".txt",
|
||||||
|
".xml",
|
||||||
|
".yaml",
|
||||||
|
".yml",
|
||||||
|
]);
|
||||||
|
|
||||||
|
const GZIP_LEVEL = 9;
|
||||||
|
const ZSTD_LEVEL = 19;
|
||||||
|
const INITIAL_COUNT = 0;
|
||||||
|
/** `process.argv` is `[node, script, ...args]`; drop the first two entries. */
|
||||||
|
const ARGV_PREFIX_LENGTH = 2;
|
||||||
|
const FAILURE_EXIT_CODE = 1;
|
||||||
|
|
||||||
|
interface Encoder {
|
||||||
|
readonly suffix: string;
|
||||||
|
readonly encode: (input: Buffer) => Buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
const ENCODERS: readonly Encoder[] = [
|
||||||
|
{
|
||||||
|
suffix: ".br",
|
||||||
|
encode: (input) =>
|
||||||
|
zlib.brotliCompressSync(input, {
|
||||||
|
params: {
|
||||||
|
[zlib.constants.BROTLI_PARAM_QUALITY]:
|
||||||
|
zlib.constants.BROTLI_MAX_QUALITY,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
suffix: ".gz",
|
||||||
|
encode: (input) => zlib.gzipSync(input, { level: GZIP_LEVEL }),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
suffix: ".zst",
|
||||||
|
encode: (input) =>
|
||||||
|
zlib.zstdCompressSync(input, {
|
||||||
|
params: {
|
||||||
|
[zlib.constants.ZSTD_c_compressionLevel]: ZSTD_LEVEL,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
interface Totals {
|
||||||
|
assets: number;
|
||||||
|
sidecars: number;
|
||||||
|
savedBytes: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Depth-first list of every regular file under `directory`, recursively. */
|
||||||
|
const listFiles = (directory: string): string[] => {
|
||||||
|
const files: string[] = [];
|
||||||
|
for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
|
||||||
|
const entryPath = path.join(directory, entry.name);
|
||||||
|
if (entry.isDirectory()) {
|
||||||
|
files.push(...listFiles(entryPath));
|
||||||
|
} else if (entry.isFile()) {
|
||||||
|
files.push(entryPath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return files;
|
||||||
|
};
|
||||||
|
|
||||||
|
const writeSidecar = (
|
||||||
|
target: string,
|
||||||
|
input: Buffer,
|
||||||
|
encoder: Encoder,
|
||||||
|
): number => {
|
||||||
|
const compressed = encoder.encode(input);
|
||||||
|
if (compressed.byteLength < input.byteLength) {
|
||||||
|
fs.writeFileSync(target, compressed);
|
||||||
|
return input.byteLength - compressed.byteLength;
|
||||||
|
}
|
||||||
|
// Drop a stale sidecar: it would still win at the server.
|
||||||
|
fs.rmSync(target, { force: true });
|
||||||
|
return INITIAL_COUNT;
|
||||||
|
};
|
||||||
|
|
||||||
|
const precompress = (file: string, totals: Totals): void => {
|
||||||
|
if (!TEXT_EXTENSIONS.has(path.extname(file).toLowerCase())) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
totals.assets += 1;
|
||||||
|
const input = fs.readFileSync(file);
|
||||||
|
for (const encoder of ENCODERS) {
|
||||||
|
const saved = writeSidecar(`${file}${encoder.suffix}`, input, encoder);
|
||||||
|
if (saved > INITIAL_COUNT) {
|
||||||
|
totals.sidecars += 1;
|
||||||
|
totals.savedBytes += saved;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const main = (directories: readonly string[]): void => {
|
||||||
|
if (directories.length === INITIAL_COUNT) {
|
||||||
|
process.stderr.write("usage: precompress.ts <dir> [<dir>...]\n");
|
||||||
|
process.exitCode = FAILURE_EXIT_CODE;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const totals: Totals = {
|
||||||
|
assets: INITIAL_COUNT,
|
||||||
|
sidecars: INITIAL_COUNT,
|
||||||
|
savedBytes: INITIAL_COUNT,
|
||||||
|
};
|
||||||
|
for (const directory of directories) {
|
||||||
|
for (const file of listFiles(directory)) {
|
||||||
|
precompress(file, totals);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
process.stdout.write(
|
||||||
|
`precompressed ${totals.assets} text assets into ${totals.sidecars} sidecars (saved ${totals.savedBytes} bytes)\n`,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
main(process.argv.slice(ARGV_PREFIX_LENGTH));
|
||||||
Executable
+66
@@ -0,0 +1,66 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
# Print the Keep-a-Changelog section for a release tag, so CI can use it as the
|
||||||
|
# body of the Gitea release page without re-implementing CHANGELOG parsing.
|
||||||
|
#
|
||||||
|
# Run as `scripts/release-notes.sh <tag>`. A leading `v` is tolerated so both
|
||||||
|
# `v1.2.3` and `1.2.3` match the `## [1.2.3]` heading. Prints to stdout and
|
||||||
|
# exits non-zero when the tag has no section, so a release can never publish
|
||||||
|
# with an empty body.
|
||||||
|
#
|
||||||
|
# Why: development/publishing.md § Release notes are extracted from the changelog.
|
||||||
|
|
||||||
|
TAG="${1:-}"
|
||||||
|
CHANGELOG="${CHANGELOG:-CHANGELOG.md}"
|
||||||
|
|
||||||
|
if [ -z "${TAG}" ]; then
|
||||||
|
echo "Error: usage: $0 <tag>" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -f "${CHANGELOG}" ]; then
|
||||||
|
echo "Error: ${CHANGELOG} not found." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# `v1.2.3` and `1.2.3` are the same release; the heading only ever uses the
|
||||||
|
# bare version.
|
||||||
|
VERSION="${TAG#v}"
|
||||||
|
|
||||||
|
awk -v version="${VERSION}" '
|
||||||
|
# A new section ends the one we are printing (or is the one we want).
|
||||||
|
/^## \[/ {
|
||||||
|
if (found) exit
|
||||||
|
heading = $0
|
||||||
|
sub(/^## \[/, "", heading)
|
||||||
|
sub(/\].*$/, "", heading)
|
||||||
|
if (heading == version) found = 1
|
||||||
|
next
|
||||||
|
}
|
||||||
|
|
||||||
|
# Link-reference definitions live at the bottom of the file and are never
|
||||||
|
# part of the section body. Stopping here keeps the last release notes
|
||||||
|
# from picking them up (there is no following heading to stop at).
|
||||||
|
/^\[[^]]+\]:/ { exit }
|
||||||
|
|
||||||
|
found {
|
||||||
|
if ($0 ~ /^[[:space:]]*$/) {
|
||||||
|
# Buffer blank lines so trailing ones at the end of the section
|
||||||
|
# are dropped instead of leaking into the release body.
|
||||||
|
if (started) pending = pending $0 "\n"
|
||||||
|
} else {
|
||||||
|
printf "%s%s\n", pending, $0
|
||||||
|
pending = ""
|
||||||
|
started = 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
END {
|
||||||
|
if (!found) {
|
||||||
|
printf "Error: no CHANGELOG section for [%s].\n", version > "/dev/stderr"
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
' "${CHANGELOG}"
|
||||||
Executable
+102
@@ -0,0 +1,102 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
# Release front-door. Run as `npm run create:release`.
|
||||||
|
#
|
||||||
|
# Graduates the [Unreleased] changelog notes, bumps package.json + the lockfile,
|
||||||
|
# and commits then tags the exact SHA that CI publishes. The notes are finalized
|
||||||
|
# in VS Code before pubv because pubv's bump heuristic reads the [Unreleased]
|
||||||
|
# body.
|
||||||
|
#
|
||||||
|
# Tooling rationale, the rejected alternatives, and the version source of truth:
|
||||||
|
# development/publishing.md.
|
||||||
|
|
||||||
|
CHANGELOG="CHANGELOG.md"
|
||||||
|
BASE="main"
|
||||||
|
|
||||||
|
if ! command -v code >/dev/null 2>&1; then
|
||||||
|
echo "Error: 'code' (VS Code CLI) not found; install it or remove the editor step." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Releases are cut from `main` (see CONTRIBUTING § Publishing workflow). Make
|
||||||
|
# that explicit rather than relying on pubv's default-branch check, so the
|
||||||
|
# error names `main` even when the remote's default is configured differently.
|
||||||
|
CURRENT=$(git symbolic-ref --quiet --short HEAD || true)
|
||||||
|
if [ "${CURRENT}" != "${BASE}" ]; then
|
||||||
|
echo "Error: releases are cut from '${BASE}', but HEAD is '${CURRENT:-detached}'." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# pubv decides the "default branch" by reading the *local*
|
||||||
|
# `refs/remotes/origin/HEAD`, not by asking the remote, and `git fetch` never
|
||||||
|
# updates that ref. After a default-branch change — or a clone from when the
|
||||||
|
# default was different — it goes stale and pubv warns/fails because the
|
||||||
|
# current branch (main) does not match it, even though main *is* the remote
|
||||||
|
# default. Refresh it from the remote first, so pubv's branch preflight
|
||||||
|
# compares against reality. (Without a network this fails, but so would the
|
||||||
|
# push pubv is about to do, so it is a real error rather than one to swallow.)
|
||||||
|
if ! git remote set-head origin --auto >/dev/null 2>&1; then
|
||||||
|
echo "Error: could not refresh origin/HEAD; check connectivity to origin." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# The [Unreleased] body drives pubv's bump heuristic, so finalize it first.
|
||||||
|
echo "Opening ${CHANGELOG} in VS Code to finalize the release notes..."
|
||||||
|
code --wait "${CHANGELOG}"
|
||||||
|
|
||||||
|
# pubv refuses a dirty tree (its "continue with a dirty tree?" prompt defaults
|
||||||
|
# to No), so a changed changelog must be committed before it runs. That commit
|
||||||
|
# is staging only — the fold below rewrites it into the single release commit.
|
||||||
|
NOTES_MSG=":memo: Finalize release notes"
|
||||||
|
if [ -n "$(git status --porcelain -- "${CHANGELOG}")" ]; then
|
||||||
|
echo "Committing finalized release notes..."
|
||||||
|
git add "${CHANGELOG}"
|
||||||
|
git commit -m "${NOTES_MSG}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Running pubv..."
|
||||||
|
pubv --no-tag --no-push --tag-prefix=none
|
||||||
|
|
||||||
|
echo "Reading version from ${CHANGELOG}..."
|
||||||
|
|
||||||
|
VERSION=$(
|
||||||
|
sed -nE 's/^## \[([0-9]+\.[0-9]+\.[0-9]+)\].*/\1/p' "${CHANGELOG}" |
|
||||||
|
head -n 1
|
||||||
|
)
|
||||||
|
|
||||||
|
if [ -z "${VERSION}" ]; then
|
||||||
|
echo "Error: Could not determine release version from ${CHANGELOG}." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Release version: ${VERSION}"
|
||||||
|
|
||||||
|
echo "Updating package.json and package-lock.json..."
|
||||||
|
npm version "${VERSION}" --no-git-tag-version
|
||||||
|
|
||||||
|
# If pubv's graduation commit sits on top of our staging notes commit, drop it
|
||||||
|
# back into the index so the amend below rewrites the notes commit into the one
|
||||||
|
# release commit. A message check, not a flag, so a re-run after pubv aborted
|
||||||
|
# still folds a notes commit left behind by the earlier attempt.
|
||||||
|
if [ "$(git log -1 --format=%s HEAD~1 2>/dev/null || true)" = "${NOTES_MSG}" ]; then
|
||||||
|
git reset --soft HEAD~1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Amending release commit..."
|
||||||
|
git add package.json package-lock.json "${CHANGELOG}"
|
||||||
|
# The exact message format is load-bearing: the `release-gate` job in
|
||||||
|
# .gitea/workflows/ci.yml recognizes `:rocket: Release x.y.z` on main and
|
||||||
|
# skips the full CI run, since the tag push immediately after verifies the
|
||||||
|
# identical SHA (and publishes). Keep the two in sync.
|
||||||
|
git commit --amend -m ":rocket: Release ${VERSION}"
|
||||||
|
|
||||||
|
echo "Creating tag ${VERSION}..."
|
||||||
|
git tag "${VERSION}"
|
||||||
|
|
||||||
|
echo "Pushing release..."
|
||||||
|
git push
|
||||||
|
git push --tags
|
||||||
|
|
||||||
|
echo "Release ${VERSION} completed."
|
||||||
Executable
+36
@@ -0,0 +1,36 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Build (and optionally push) the CI job image from docker/Dockerfile.
|
||||||
|
# Run wherever docker + registry credentials live (the runner host, or any
|
||||||
|
# machine that can reach the registry). The registry/repo below MUST match
|
||||||
|
# the `container.image` references in .gitea/workflows/ci.yml — the runner
|
||||||
|
# pulls the image by name.
|
||||||
|
#
|
||||||
|
# Usage: scripts/runner-image.sh [--push]
|
||||||
|
#
|
||||||
|
# Why the image is baked, its two invariants, and the coordinated Node-bump
|
||||||
|
# steps: development/ci.md.
|
||||||
|
|
||||||
|
IMAGE_REPO="gitea.e1nsnull.de/tmu/act-ci"
|
||||||
|
|
||||||
|
NODE_VERSION="$(tr -d '[:space:]' < .node-version)"
|
||||||
|
if [[ ! "${NODE_VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||||
|
echo "error: .node-version must be pinned to an exact x.y.z, got '${NODE_VERSION}'." >&2
|
||||||
|
echo " setup-node resolves floats like '26' to the latest patch at runtime," >&2
|
||||||
|
echo " which silently busts the tool-cache entry baked into the image." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
IMAGE="${IMAGE_REPO}:${NODE_VERSION}"
|
||||||
|
|
||||||
|
# --pull: refresh the act base layer so the derivative does not float on an
|
||||||
|
# aging default image forever (layer dedup keeps this cheap).
|
||||||
|
docker build --pull --build-arg "NODE_VERSION=${NODE_VERSION}" -t "${IMAGE}" -f docker/Dockerfile .
|
||||||
|
|
||||||
|
if [[ "${1:-}" == "--push" ]]; then
|
||||||
|
docker push "${IMAGE}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "built ${IMAGE}"
|
||||||
|
echo "reminder: bump container.image in .gitea/workflows/ci.yml to this tag"
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
import { test } from "node:test";
|
|
||||||
import { strict as assert } from "node:assert";
|
|
||||||
import { expectTypeOf } from "expect-type";
|
|
||||||
import { match, P, type Matcher } from "./index.ts";
|
|
||||||
|
|
||||||
test("match returns a builder", () => {
|
|
||||||
const builder = match("x");
|
|
||||||
expectTypeOf(builder).toHaveProperty("with");
|
|
||||||
expectTypeOf(builder).toHaveProperty("exhaustive");
|
|
||||||
expectTypeOf(builder).toHaveProperty("otherwise");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("P.literal narrows to its literal type", () => {
|
|
||||||
const matcher = P.literal("yes");
|
|
||||||
expectTypeOf(matcher).toMatchTypeOf<Matcher<"yes">>();
|
|
||||||
assert.equal(matcher.matches("yes"), true);
|
|
||||||
assert.equal(matcher.matches("no"), false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("P.type narrows to the typeof target", () => {
|
|
||||||
const matcher = P.type<string>("string");
|
|
||||||
expectTypeOf(matcher).toMatchTypeOf<Matcher<string>>();
|
|
||||||
assert.equal(matcher.matches("hi"), true);
|
|
||||||
assert.equal(matcher.matches(42), false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("exhaustive() returns the union of handler return types", () => {
|
|
||||||
const result = match<"a" | "b">("a" as "a" | "b")
|
|
||||||
.with(P.literal("a"), () => 1 as const)
|
|
||||||
.with(P.literal("b"), () => "two" as const)
|
|
||||||
.exhaustive();
|
|
||||||
|
|
||||||
expectTypeOf(result).toEqualTypeOf<1 | "two">();
|
|
||||||
assert.equal(result, 1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("otherwise() falls back when no case matches", () => {
|
|
||||||
const result = match<"x" | "y" | "z">("z" as "x" | "y" | "z")
|
|
||||||
.with(P.literal("x"), (v): string => `got ${v}`)
|
|
||||||
.otherwise((v): string => `fallback ${v}`);
|
|
||||||
assert.equal(result, "fallback z");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("exhaustive throws when no case matches", () => {
|
|
||||||
assert.throws(
|
|
||||||
() =>
|
|
||||||
match<"a" | "b" | "c">("c" as "a" | "b" | "c")
|
|
||||||
.with(P.literal("a"), () => "A")
|
|
||||||
.with(P.literal("b"), () => "B")
|
|
||||||
.exhaustive(),
|
|
||||||
/no matching case/,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
+1
-2
@@ -1,2 +1 @@
|
|||||||
export { match, P } from "./match.ts";
|
export { getMatcher, getMatcherW } from "./primitive.ts";
|
||||||
export type { Matcher, Pattern } from "./pattern.ts";
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
import { P, type Matcher, type Pattern } from "./pattern.ts";
|
|
||||||
|
|
||||||
type Cases<R> = ReadonlyArray<
|
|
||||||
readonly [Matcher<unknown>, (value: unknown) => R]
|
|
||||||
>;
|
|
||||||
|
|
||||||
interface MatchBuilder<T, R> {
|
|
||||||
with<U extends T, V>(
|
|
||||||
pattern: Matcher<U>,
|
|
||||||
handler: (value: U) => V,
|
|
||||||
): MatchBuilder<T, R | V>;
|
|
||||||
exhaustive(): R;
|
|
||||||
otherwise(handler: (value: T) => R): R;
|
|
||||||
}
|
|
||||||
|
|
||||||
const buildMatch = <T, R>(value: T, cases: Cases<R>): MatchBuilder<T, R> => {
|
|
||||||
const apply = (): R | undefined => {
|
|
||||||
for (const [matcher, handler] of cases) {
|
|
||||||
if (matcher.matches(value as unknown)) {
|
|
||||||
return handler(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
const builder = {
|
|
||||||
with<U extends T, V>(
|
|
||||||
pattern: Matcher<U>,
|
|
||||||
handler: (value: U) => V,
|
|
||||||
): MatchBuilder<T, R | V> {
|
|
||||||
const nextCases: Cases<R | V> = [
|
|
||||||
...cases,
|
|
||||||
[pattern, handler as (value: unknown) => R | V],
|
|
||||||
];
|
|
||||||
return buildMatch(value, nextCases);
|
|
||||||
},
|
|
||||||
exhaustive(): R {
|
|
||||||
const result = apply();
|
|
||||||
if (result === undefined) {
|
|
||||||
throw new Error(
|
|
||||||
"tiny-pattern-ts: match.exhaustive() called with no matching case",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
},
|
|
||||||
otherwise(handler: (value: T) => R): R {
|
|
||||||
for (const [matcher, run] of cases) {
|
|
||||||
if (matcher.matches(value as unknown)) {
|
|
||||||
return run(value) as R;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return handler(value);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
return builder;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const match = <T>(value: T): MatchBuilder<T, never> =>
|
|
||||||
buildMatch<T, never>(value, []);
|
|
||||||
|
|
||||||
export type { Matcher, Pattern };
|
|
||||||
export { P };
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
/**
|
|
||||||
* Pattern matching primitives. Each constructor returns a lightweight
|
|
||||||
* matcher object whose `matches` method returns a type guard.
|
|
||||||
*/
|
|
||||||
|
|
||||||
export interface Matcher<T> {
|
|
||||||
readonly matches: (value: unknown) => value is T;
|
|
||||||
}
|
|
||||||
|
|
||||||
const literalMatcher = <
|
|
||||||
const L extends string | number | boolean | null | undefined,
|
|
||||||
>(
|
|
||||||
value: L,
|
|
||||||
): Matcher<L> => ({
|
|
||||||
matches: (candidate): candidate is L => candidate === value,
|
|
||||||
});
|
|
||||||
|
|
||||||
const typeMatcher = <T>(
|
|
||||||
type:
|
|
||||||
| "string"
|
|
||||||
| "number"
|
|
||||||
| "boolean"
|
|
||||||
| "bigint"
|
|
||||||
| "symbol"
|
|
||||||
| "undefined"
|
|
||||||
| "object"
|
|
||||||
| "function",
|
|
||||||
): Matcher<T> => {
|
|
||||||
const matches = (value: unknown): value is T => {
|
|
||||||
if (type === "undefined") return value === undefined;
|
|
||||||
if (type === "object")
|
|
||||||
return (
|
|
||||||
(typeof value === "object" && value !== null) ||
|
|
||||||
typeof value === "function"
|
|
||||||
);
|
|
||||||
return typeof value === type;
|
|
||||||
};
|
|
||||||
return { matches };
|
|
||||||
};
|
|
||||||
|
|
||||||
const whenMatcher = <T>(
|
|
||||||
predicate: (value: unknown) => value is T,
|
|
||||||
): Matcher<T> => ({
|
|
||||||
matches: predicate,
|
|
||||||
});
|
|
||||||
|
|
||||||
const whenMatcherAny = <T>(
|
|
||||||
predicate: (value: unknown) => boolean,
|
|
||||||
): Matcher<T> => ({
|
|
||||||
matches: (value: unknown): value is T => predicate(value),
|
|
||||||
});
|
|
||||||
|
|
||||||
const structuralMatcher = <S extends object, T extends S>(
|
|
||||||
shape: S,
|
|
||||||
refine?: (value: S) => value is T,
|
|
||||||
): Matcher<T> => ({
|
|
||||||
matches: (value: unknown): value is T => {
|
|
||||||
if (typeof value !== "object" || value === null) return false;
|
|
||||||
const candidate = value as S;
|
|
||||||
for (const key of Object.keys(shape) as Array<keyof S>) {
|
|
||||||
if (!(key in candidate)) return false;
|
|
||||||
const expected = shape[key];
|
|
||||||
const actual = candidate[key];
|
|
||||||
if (
|
|
||||||
typeof expected === "object" &&
|
|
||||||
expected !== null &&
|
|
||||||
"matches" in expected
|
|
||||||
) {
|
|
||||||
const nested = expected as unknown as Matcher<unknown>;
|
|
||||||
if (!nested.matches(actual)) return false;
|
|
||||||
} else if (actual !== expected) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return refine
|
|
||||||
? refine(candidate)
|
|
||||||
: (true as T extends S ? true : never);
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export const P = {
|
|
||||||
literal: literalMatcher,
|
|
||||||
type: typeMatcher,
|
|
||||||
when: whenMatcher,
|
|
||||||
any: whenMatcherAny,
|
|
||||||
shape: structuralMatcher,
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
export type Pattern<T> = Matcher<T>;
|
|
||||||
@@ -0,0 +1,491 @@
|
|||||||
|
/* oxlint-disable typescript/no-floating-promises -- expectTypeOf() is a sync type-assertion library that the type-aware linter misidentifies as a promise */
|
||||||
|
import { strict as assert } from "node:assert";
|
||||||
|
import path from "node:path";
|
||||||
|
import { test } from "node:test";
|
||||||
|
|
||||||
|
import { expectTypeOf } from "expect-type";
|
||||||
|
|
||||||
|
import {
|
||||||
|
type CompletionTarget,
|
||||||
|
LspSession,
|
||||||
|
} from "#test-utils/lsp-completion.ts";
|
||||||
|
|
||||||
|
import { getMatcher, getMatcherW } from "./primitive.ts";
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// API: getMatcher — ✔️ Exhaustive / ✔️ ReturnsStrict
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcher: exhaustive pattern infers one common return type", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<"a" | "b">();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
b: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b">();
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
// ✔️ ReturnsStrict: R is the best common return type, not a widening union.
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: "a" | "b") => number>();
|
||||||
|
// ❌ a value outside T must not be accepted by the matcher
|
||||||
|
expectTypeOf<"c">().not.toExtend<Parameters<typeof matcher>[0]>();
|
||||||
|
assert.equal(matcher("a"), 1);
|
||||||
|
assert.equal(matcher("b"), 2);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcher: dispatches on numeric literal keys", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<1 | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
1: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<1>();
|
||||||
|
return n + 1;
|
||||||
|
},
|
||||||
|
2: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<2>();
|
||||||
|
return n * 10;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: 1 | 2) => number>();
|
||||||
|
assert.equal(matcher(1), 2);
|
||||||
|
assert.equal(matcher(2), 20);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcher: dispatches on mixed string and numeric keys", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<"a" | "b" | 1 | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
b: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b">();
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
1: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<1>();
|
||||||
|
return 10;
|
||||||
|
},
|
||||||
|
2: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<2>();
|
||||||
|
return 20;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: "a" | "b" | 1 | 2) => number>();
|
||||||
|
assert.equal(matcher("a"), 1);
|
||||||
|
assert.equal(matcher("b"), 2);
|
||||||
|
assert.equal(matcher(1), 10);
|
||||||
|
assert.equal(matcher(2), 20);
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// API: getMatcher — ❌ Exhaustive (fallback) / ✔️ ReturnsStrict
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcher: a `_` fallback receives the unhandled keys", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<"a" | "b" | "c">();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory(
|
||||||
|
{
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return 1 as const;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
(s) => {
|
||||||
|
// The fallback sees only the keys `a` did not handle.
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b" | "c">();
|
||||||
|
return 2 as const;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: "a" | "b" | "c") => 1 | 2>();
|
||||||
|
// ❌ a value outside T must not be accepted by the matcher
|
||||||
|
expectTypeOf<"d">().not.toExtend<Parameters<typeof matcher>[0]>();
|
||||||
|
assert.equal(matcher("a"), 1);
|
||||||
|
assert.equal(matcher("b"), 2);
|
||||||
|
assert.equal(matcher("c"), 2);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcher: a `_` fallback routes mixed string and numeric gaps", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<"a" | "b" | 1 | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory(
|
||||||
|
{
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return "A";
|
||||||
|
},
|
||||||
|
1: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<1>();
|
||||||
|
return "one";
|
||||||
|
},
|
||||||
|
},
|
||||||
|
(s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b" | 2>();
|
||||||
|
return "fallback";
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: "a" | "b" | 1 | 2) => string>();
|
||||||
|
assert.equal(matcher("a"), "A");
|
||||||
|
assert.equal(matcher("b"), "fallback");
|
||||||
|
assert.equal(matcher(1), "one");
|
||||||
|
assert.equal(matcher(2), "fallback");
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// API: getMatcherW — ✔️ Exhaustive / ❌ ReturnsStrict
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcherW: exhaustive pattern widens to the union of handler returns", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcherW<"x" | "y">();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
x: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"x">();
|
||||||
|
return 1 as const;
|
||||||
|
},
|
||||||
|
y: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"y">();
|
||||||
|
return "two" as const;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
// ❌ ReturnsStrict: mixed handler returns widen to their union.
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: "x" | "y") => 1 | "two">();
|
||||||
|
// ❌ a value outside T must not be accepted by the matcher
|
||||||
|
expectTypeOf<"z">().not.toExtend<Parameters<typeof matcher>[0]>();
|
||||||
|
assert.equal(matcher("x"), 1);
|
||||||
|
assert.equal(matcher("y"), "two");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcherW: dispatches on mixed string and numeric keys", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcherW<"a" | "b" | 1 | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return "A" as const;
|
||||||
|
},
|
||||||
|
b: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b">();
|
||||||
|
return "B" as const;
|
||||||
|
},
|
||||||
|
1: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<1>();
|
||||||
|
return 10 as const;
|
||||||
|
},
|
||||||
|
2: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<2>();
|
||||||
|
return 20 as const;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<
|
||||||
|
(shape: "a" | "b" | 1 | 2) => "A" | "B" | 10 | 20
|
||||||
|
>();
|
||||||
|
assert.equal(matcher("a"), "A");
|
||||||
|
assert.equal(matcher("b"), "B");
|
||||||
|
assert.equal(matcher(1), 10);
|
||||||
|
assert.equal(matcher(2), 20);
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// API: getMatcherW — ❌ Exhaustive (fallback) / ❌ ReturnsStrict
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcherW: a `_` fallback widens gaps into the union", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcherW<"x" | "y" | "z">();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory(
|
||||||
|
{
|
||||||
|
x: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"x">();
|
||||||
|
return 1 as const;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
(s) => {
|
||||||
|
// The fallback sees only the keys `x` did not handle.
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"y" | "z">();
|
||||||
|
return "fallback" as const;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<
|
||||||
|
(shape: "x" | "y" | "z") => 1 | "fallback"
|
||||||
|
>();
|
||||||
|
// ❌ a value outside T must not be accepted by the matcher
|
||||||
|
expectTypeOf<"w">().not.toExtend<Parameters<typeof matcher>[0]>();
|
||||||
|
assert.equal(matcher("x"), 1);
|
||||||
|
assert.equal(matcher("y"), "fallback");
|
||||||
|
assert.equal(matcher("z"), "fallback");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcherW: a `_` fallback widens mixed string and numeric returns", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcherW<"a" | "b" | 1 | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory(
|
||||||
|
{
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
return "A" as const;
|
||||||
|
},
|
||||||
|
1: (n) => {
|
||||||
|
expectTypeOf(n).toEqualTypeOf<1>();
|
||||||
|
return 10 as const;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
(s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b" | 2>();
|
||||||
|
return "fallback" as const;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
// ❌ ReturnsStrict: mixed handler returns widen to their union.
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<
|
||||||
|
(shape: "a" | "b" | 1 | 2) => "A" | 10 | "fallback"
|
||||||
|
>();
|
||||||
|
assert.equal(matcher("a"), "A");
|
||||||
|
assert.equal(matcher("b"), "fallback");
|
||||||
|
assert.equal(matcher(1), 10);
|
||||||
|
assert.equal(matcher(2), "fallback");
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Factory contracts — calls that must not compile
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcher factory rejects patterns outside its contract", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcher<"a" | "b">();
|
||||||
|
|
||||||
|
// Act / Assert — the calls below must not compile.
|
||||||
|
// `Parameters<typeof factory>[0]` resolves only the *last* overload, so it
|
||||||
|
// is not a sound "rejected" oracle (an accepted partial pattern does not
|
||||||
|
// extend it either); the call sites are the oracle instead.
|
||||||
|
factory({
|
||||||
|
a: () => 1,
|
||||||
|
b: () => 2,
|
||||||
|
// @ts-expect-error `c` is not part of the universe `"a" | "b"`
|
||||||
|
c: () => 3,
|
||||||
|
});
|
||||||
|
// @ts-expect-error a gap without a `_` fallback is not exhaustive
|
||||||
|
factory({ a: () => 1 });
|
||||||
|
// @ts-expect-error a `string` fallback does not fit the `number` handler
|
||||||
|
factory({ a: () => 1 }, () => "x");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getMatcherW factory rejects patterns outside its contract", () => {
|
||||||
|
// Arrange
|
||||||
|
const factory = getMatcherW<"x" | "y">();
|
||||||
|
|
||||||
|
// Act / Assert — the calls below must not compile
|
||||||
|
factory({
|
||||||
|
x: () => 1 as const,
|
||||||
|
y: () => 2 as const,
|
||||||
|
// @ts-expect-error `z` is not part of the universe `"x" | "y"`
|
||||||
|
z: () => 3 as const,
|
||||||
|
});
|
||||||
|
// @ts-expect-error a gap without a `_` fallback is not exhaustive
|
||||||
|
factory({ x: () => 1 as const });
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Dispatch — runtime behavior
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
test("getMatcher: an unhandled shape throws without a fallback", () => {
|
||||||
|
// Arrange — an open universe types its handler map as an index signature,
|
||||||
|
// so the type system cannot prove the runtime map is exhaustive.
|
||||||
|
const handlers: Record<string, () => number> = { a: () => 1 };
|
||||||
|
const matcher = getMatcher<string>()(handlers);
|
||||||
|
|
||||||
|
// Act / Assert
|
||||||
|
assert.equal(matcher("a"), 1);
|
||||||
|
assert.throws(() => matcher("b"), /Unhandled shape: b/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Autocomplete — the language server is the oracle, not the type system
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
// Completion is a contextual-type property that the type system cannot observe,
|
||||||
|
// so the cases below read the popup from the repo's language server (via the
|
||||||
|
// test helper) rather than pairing `expectTypeOf` with `assert` — see
|
||||||
|
// development/testing.md § Autocomplete. They probe the *matcher's* overloads,
|
||||||
|
// which is why they live with the matcher and not with the helper.
|
||||||
|
const REPO_ROOT = path.resolve(import.meta.dirname, "..");
|
||||||
|
const UNIVERSE = `"a" | "b" | "c"`;
|
||||||
|
|
||||||
|
// One session per probe: the tests share no language-server state (open
|
||||||
|
// documents, project membership), so they pass in any order.
|
||||||
|
interface LabelsProbe {
|
||||||
|
readonly name: string;
|
||||||
|
readonly factory: "getMatcher" | "getMatcherW";
|
||||||
|
readonly body: string;
|
||||||
|
readonly tail?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const labelsFor = ({
|
||||||
|
name,
|
||||||
|
factory,
|
||||||
|
body,
|
||||||
|
tail = "",
|
||||||
|
}: LabelsProbe): Promise<readonly string[]> => {
|
||||||
|
const session = new LspSession(REPO_ROOT);
|
||||||
|
const target: CompletionTarget = {
|
||||||
|
file: `src/__autocomplete_${name}.ts`,
|
||||||
|
source: [
|
||||||
|
`import { ${factory} } from "./index.ts";`,
|
||||||
|
`const m = ${factory}<${UNIVERSE}>()({`,
|
||||||
|
body,
|
||||||
|
`}${tail});`,
|
||||||
|
"",
|
||||||
|
].join("\n"),
|
||||||
|
};
|
||||||
|
return session
|
||||||
|
.completionLabelsAt(target)
|
||||||
|
.then((result) => result.labels)
|
||||||
|
.finally(() => session.close());
|
||||||
|
};
|
||||||
|
|
||||||
|
test("autocomplete: an exhaustive pattern requires the universe", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcher_fresh";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcher",
|
||||||
|
body: " /*COMPLETE*/",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["a", "b", "c"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autocomplete: handled keys drop out of the popup", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcher_after_key";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcher",
|
||||||
|
body: " a: () => 1,\n /*COMPLETE*/",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["b", "c"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autocomplete: a fallback makes the remaining keys optional", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcher_with_fallback";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcher",
|
||||||
|
body: " /*COMPLETE*/",
|
||||||
|
tail: ", () => 0",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["a?", "b?", "c?"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autocomplete: with a fallback, handled keys stay optional", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcher_with_fallback_after_key";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcher",
|
||||||
|
body: " a: () => 1,\n /*COMPLETE*/",
|
||||||
|
tail: ", () => 0",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["b?", "c?"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autocomplete: `getMatcherW` offers the same popup as `getMatcher`", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcherW_fresh";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcherW",
|
||||||
|
body: " /*COMPLETE*/",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["a", "b", "c"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autocomplete: `getMatcherW` also offers optional keys with a fallback", () => {
|
||||||
|
// Arrange
|
||||||
|
const name = "getMatcherW_with_fallback";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const labels = labelsFor({
|
||||||
|
name,
|
||||||
|
factory: "getMatcherW",
|
||||||
|
body: " /*COMPLETE*/",
|
||||||
|
tail: ", () => 0",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
return labels.then((result) => {
|
||||||
|
assert.deepEqual([...result], ["a?", "b?", "c?"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
import type { Exact, ValueOf } from "type-fest";
|
||||||
|
|
||||||
|
type UnaryFn<T, R> = (shape: T) => R;
|
||||||
|
|
||||||
|
// `Extract` drops optional handlers (`undefined`) so `PatternReturns` also works
|
||||||
|
// when `P`'s constraint has optional keys.
|
||||||
|
type PatternReturns<P> = ReturnType<
|
||||||
|
Extract<ValueOf<P>, (...args: never[]) => unknown>
|
||||||
|
>;
|
||||||
|
|
||||||
|
type Handlers<T extends string | number, R> = { [K in T]: UnaryFn<K, R> };
|
||||||
|
|
||||||
|
// The fallback is a *second argument*, not a property of the handler map,
|
||||||
|
// because its parameter is the remainder `Exclude<T, keyof Handled>` and TypeScript
|
||||||
|
// fixes a property's contextual type before it infers its sibling keys. A later
|
||||||
|
// argument, by contrast, is contextually typed from inference on an earlier
|
||||||
|
// one, so the split is what makes the remainder expressible at all.
|
||||||
|
// See development/library.md.
|
||||||
|
type Fallback<T extends string | number, Handled, R> = UnaryFn<
|
||||||
|
Exclude<T, keyof Handled>,
|
||||||
|
R
|
||||||
|
>;
|
||||||
|
|
||||||
|
// TypeScript does not apply the excess-property check to a generic constraint,
|
||||||
|
// so `Exact` restores it for the generic forms: a handler map can otherwise
|
||||||
|
// carry keys outside `T`.
|
||||||
|
|
||||||
|
// oxlint-disable typescript/unified-signatures
|
||||||
|
// Strict returns: one common `R`. Overload order is load-bearing:
|
||||||
|
// #1 Handlers (first) -> the exhaustive form and the autocomplete popup
|
||||||
|
// #2 Fallback (last) -> accepts a partial handler map plus a fallback
|
||||||
|
interface MatcherStrict<T extends string | number> {
|
||||||
|
<R>(handlers: Handlers<T, R>): UnaryFn<T, R>;
|
||||||
|
<R, Handled extends Exact<Partial<Handlers<T, R>>, Handled>>(
|
||||||
|
handlers: Handled & Partial<Handlers<T, R>>,
|
||||||
|
fallback: Fallback<T, Handled, R>,
|
||||||
|
): UnaryFn<T, R>;
|
||||||
|
}
|
||||||
|
// oxlint-enable typescript/unified-signatures
|
||||||
|
|
||||||
|
// Widened returns: the union of every handler's return type. `P` is inferred
|
||||||
|
// from the whole handler map, whose closed constraint supplies the
|
||||||
|
// contextual/autocomplete type.
|
||||||
|
// oxlint-disable typescript/unified-signatures
|
||||||
|
interface MatcherWidening<T extends string | number> {
|
||||||
|
<P extends Exact<Handlers<T, unknown>, P>>(
|
||||||
|
handlers: P,
|
||||||
|
): UnaryFn<T, PatternReturns<P>>;
|
||||||
|
<R, Handled extends Exact<Partial<Handlers<T, unknown>>, Handled>>(
|
||||||
|
handlers: Handled,
|
||||||
|
fallback: Fallback<T, Handled, R>,
|
||||||
|
): UnaryFn<T, PatternReturns<Handled> | R>;
|
||||||
|
}
|
||||||
|
// oxlint-enable typescript/unified-signatures
|
||||||
|
|
||||||
|
type HandlerMap = Record<string | number, UnaryFn<never, unknown> | undefined>;
|
||||||
|
|
||||||
|
const dispatch =
|
||||||
|
(handlers: HandlerMap, fallback?: UnaryFn<never, unknown>) =>
|
||||||
|
(shape: string | number): unknown =>
|
||||||
|
(
|
||||||
|
handlers[shape] ??
|
||||||
|
fallback ??
|
||||||
|
(() => {
|
||||||
|
throw new Error(`Unhandled shape: ${shape}`);
|
||||||
|
})
|
||||||
|
)(
|
||||||
|
// oxlint-disable-next-line typescript/no-unsafe-type-assertion
|
||||||
|
shape as never,
|
||||||
|
);
|
||||||
|
|
||||||
|
export const getMatcher = <T extends string | number>(): MatcherStrict<T> =>
|
||||||
|
dispatch;
|
||||||
|
export const getMatcherW = <T extends string | number>(): MatcherWidening<T> =>
|
||||||
|
dispatch;
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
/* oxlint-disable typescript/no-floating-promises -- expectTypeOf() is a sync type-assertion library that the type-aware linter misidentifies as a promise */
|
||||||
|
import { strict as assert } from "node:assert";
|
||||||
|
import path from "node:path";
|
||||||
|
import { test } from "node:test";
|
||||||
|
|
||||||
|
import { expectTypeOf } from "expect-type";
|
||||||
|
|
||||||
|
import {
|
||||||
|
type CompletionResult,
|
||||||
|
type CompletionTarget,
|
||||||
|
LspSession,
|
||||||
|
} from "#test-utils/lsp-completion.ts";
|
||||||
|
|
||||||
|
const REPO_ROOT = path.resolve(import.meta.dirname, "../../..");
|
||||||
|
|
||||||
|
// The `#test-utils/*` self-reference (package.json#imports) is the one route
|
||||||
|
// scattered test files take to reach test helpers; this pins that it resolves
|
||||||
|
// and types without starting a language server
|
||||||
|
// (development/testing.md § Test helpers).
|
||||||
|
test("test-helper home: `#test-utils/…` resolves to the helper and types it", () => {
|
||||||
|
// Arrange
|
||||||
|
const target: CompletionTarget = {
|
||||||
|
file: "src/util/__tests__/lsp-completion.ts",
|
||||||
|
source: "",
|
||||||
|
};
|
||||||
|
|
||||||
|
// Assert — no session is constructed: the constructor spawns `tsc --lsp`,
|
||||||
|
// so only the resolved values and their types are checked here.
|
||||||
|
expectTypeOf(LspSession).toBeConstructibleWith("repo-root");
|
||||||
|
expectTypeOf<CompletionResult>().toMatchTypeOf<{
|
||||||
|
labels: readonly string[];
|
||||||
|
}>();
|
||||||
|
assert.equal(typeof LspSession, "function");
|
||||||
|
assert.equal(target.file, "src/util/__tests__/lsp-completion.ts");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The helper drives a language server, so its contract is asserted against the
|
||||||
|
// server. Every document below is probed from memory and carries its
|
||||||
|
// contextual type inline, so the helper is tested without the library's code.
|
||||||
|
const probe = (source: string, marker?: string): Promise<CompletionResult> => {
|
||||||
|
const session = new LspSession(REPO_ROOT);
|
||||||
|
const target: CompletionTarget =
|
||||||
|
marker === undefined
|
||||||
|
? { file: "src/__probe.ts", source }
|
||||||
|
: { file: "src/__probe.ts", source, marker };
|
||||||
|
return session.completionLabelsAt(target).finally(() => session.close());
|
||||||
|
};
|
||||||
|
|
||||||
|
const HANDLERS = [
|
||||||
|
"type Handlers = { a: () => number; b: () => number; _?: () => number };",
|
||||||
|
"declare const apply: (handlers: Handlers) => Handlers;",
|
||||||
|
];
|
||||||
|
|
||||||
|
test("helper: a fresh object literal completes with its contextual keys", () => {
|
||||||
|
// Arrange
|
||||||
|
const source = [
|
||||||
|
...HANDLERS,
|
||||||
|
"const done = apply({",
|
||||||
|
" /*COMPLETE*/",
|
||||||
|
"});",
|
||||||
|
"export { done };",
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const probed = probe(source);
|
||||||
|
|
||||||
|
// Assert — the position is the marker's, which the helper strips
|
||||||
|
expectTypeOf(probed).toEqualTypeOf<Promise<CompletionResult>>();
|
||||||
|
return probed.then((result) => {
|
||||||
|
assert.deepEqual(result.position, { line: 3, character: 4 });
|
||||||
|
assert.deepEqual([...result.labels], ["_?", "a", "b"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("helper: a handled key drops out of the popup", () => {
|
||||||
|
// Arrange
|
||||||
|
const source = [
|
||||||
|
...HANDLERS,
|
||||||
|
"const done = apply({",
|
||||||
|
" b: () => 1,",
|
||||||
|
" /*COMPLETE*/",
|
||||||
|
"});",
|
||||||
|
"export { done };",
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const probed = probe(source);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf<CompletionResult["labels"]>().toEqualTypeOf<
|
||||||
|
readonly string[]
|
||||||
|
>();
|
||||||
|
return probed.then((result) => {
|
||||||
|
assert.deepEqual([...result.labels], ["_?", "a"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("helper: a custom marker is located at the line start", () => {
|
||||||
|
// Arrange
|
||||||
|
const source = [
|
||||||
|
"type Handlers = { a: () => number; _?: () => number };",
|
||||||
|
"declare const apply: (handlers: Handlers) => Handlers;",
|
||||||
|
"const done = apply({",
|
||||||
|
"@@@",
|
||||||
|
"});",
|
||||||
|
"export { done };",
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const probed = probe(source, "@@@");
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(probed).resolves.toEqualTypeOf<CompletionResult>();
|
||||||
|
return probed.then((result) => {
|
||||||
|
assert.deepEqual(result.position, { line: 3, character: 0 });
|
||||||
|
assert.deepEqual([...result.labels], ["_?", "a"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("helper: labels are read from the server, not from a pattern literal", () => {
|
||||||
|
// Arrange
|
||||||
|
const source = [
|
||||||
|
'const text = "x";',
|
||||||
|
"const upper = text./*COMPLETE*/;",
|
||||||
|
"export { upper };",
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const probed = probe(source);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(probed).resolves.toHaveProperty("labels");
|
||||||
|
return probed.then((result) => {
|
||||||
|
assert.ok(result.labels.includes("toUpperCase"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("helper: a source without the marker rejects", () => {
|
||||||
|
// Arrange
|
||||||
|
const source = "const text = 1;\nexport { text };\n";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const probed = probe(source);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(probed).resolves.toEqualTypeOf<CompletionResult>();
|
||||||
|
return assert.rejects(probed, /marker not found/);
|
||||||
|
});
|
||||||
@@ -0,0 +1,254 @@
|
|||||||
|
// oxlint-disable no-magic-numbers unicorn/no-null - tolerable here, this is a helper
|
||||||
|
import { spawn, type ChildProcessWithoutNullStreams } from "node:child_process";
|
||||||
|
import fs from "node:fs";
|
||||||
|
import path from "node:path";
|
||||||
|
import { setTimeout as delay } from "node:timers/promises";
|
||||||
|
import { pathToFileURL } from "node:url";
|
||||||
|
|
||||||
|
import {
|
||||||
|
type CompletionItem,
|
||||||
|
type CompletionList,
|
||||||
|
CompletionRequest,
|
||||||
|
ConfigurationRequest,
|
||||||
|
createMessageConnection,
|
||||||
|
DidOpenTextDocumentNotification,
|
||||||
|
InitializedNotification,
|
||||||
|
InitializeRequest,
|
||||||
|
type MessageConnection,
|
||||||
|
ShutdownRequest,
|
||||||
|
StreamMessageReader,
|
||||||
|
StreamMessageWriter,
|
||||||
|
} from "vscode-languageserver-protocol/node";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Print the completion labels TypeScript's language server offers at a marker
|
||||||
|
* inside a source file.
|
||||||
|
*
|
||||||
|
* Usage: node --strip-types src/util/__tests__/lsp-completion.ts <file> [<marker>]
|
||||||
|
*
|
||||||
|
* The marker (default `DEFAULT_MARKER`, a `COMPLETE` block comment) is stripped
|
||||||
|
* from the source before it is sent; the request position is where the marker
|
||||||
|
* stood. Point it at a scratch file whose expected type is a matcher pattern to
|
||||||
|
* inspect the popup.
|
||||||
|
*
|
||||||
|
* `LspSession` exposes the same probe to the test suite, so completion is
|
||||||
|
* asserted against the server rather than the type system.
|
||||||
|
*
|
||||||
|
* Why a script and not a type assertion: completion is a contextual-type
|
||||||
|
* property that `expect-type` cannot observe, and `Parameters<…>` resolves only
|
||||||
|
* a single overload. The server is the only ground truth. See
|
||||||
|
* development/testing.md § Autocomplete.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const DEFAULT_MARKER = "/*COMPLETE*/";
|
||||||
|
const ARGV_PREFIX_LENGTH = 2;
|
||||||
|
const EXIT_DELAY_MS = 200;
|
||||||
|
const FAILURE_EXIT_CODE = 1;
|
||||||
|
const USAGE = "usage: lsp-completion.ts <file> [<marker>]";
|
||||||
|
|
||||||
|
export interface Position {
|
||||||
|
readonly line: number;
|
||||||
|
readonly character: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A document to probe: `source` carries `marker`, which is stripped. */
|
||||||
|
export interface CompletionTarget {
|
||||||
|
/** Path relative to the session's repo root; drives URI and resolution. */
|
||||||
|
readonly file: string;
|
||||||
|
readonly source: string;
|
||||||
|
readonly marker?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CompletionResult {
|
||||||
|
readonly position: Position;
|
||||||
|
readonly labels: readonly string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
const completionLabels = (
|
||||||
|
result: CompletionItem[] | CompletionList | null,
|
||||||
|
): readonly string[] => {
|
||||||
|
if (result === null) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
const items = Array.isArray(result) ? result : result.items;
|
||||||
|
return items
|
||||||
|
.map((item) => item.label)
|
||||||
|
.toSorted((left, right) => left.localeCompare(right));
|
||||||
|
};
|
||||||
|
|
||||||
|
const markerPosition = (source: string, marker: string): Position => {
|
||||||
|
const index = source.indexOf(marker);
|
||||||
|
if (index === -1) {
|
||||||
|
throw new Error(`marker not found: ${marker}`);
|
||||||
|
}
|
||||||
|
const lines = source.slice(0, index).split("\n");
|
||||||
|
const lineIndex = lines.length - 1;
|
||||||
|
const line = lines[lineIndex];
|
||||||
|
return { line: lineIndex, character: line === undefined ? 0 : line.length };
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One language server, initialized on first use, shared across probes. Callers
|
||||||
|
* own the lifecycle and must `close()` it.
|
||||||
|
*/
|
||||||
|
export class LspSession {
|
||||||
|
readonly #child: ChildProcessWithoutNullStreams;
|
||||||
|
readonly #connection: MessageConnection;
|
||||||
|
readonly #repoRoot: string;
|
||||||
|
#ready: Promise<void> | undefined;
|
||||||
|
|
||||||
|
public constructor(repoRoot: string) {
|
||||||
|
this.#repoRoot = repoRoot;
|
||||||
|
this.#child = spawn(
|
||||||
|
path.join(repoRoot, "node_modules", ".bin", "tsc"),
|
||||||
|
["--lsp", "--stdio"],
|
||||||
|
{ cwd: repoRoot },
|
||||||
|
);
|
||||||
|
this.#child.stderr.on("data", (chunk: Buffer) => {
|
||||||
|
process.stderr.write(chunk);
|
||||||
|
});
|
||||||
|
this.#connection = createMessageConnection(
|
||||||
|
new StreamMessageReader(this.#child.stdout),
|
||||||
|
new StreamMessageWriter(this.#child.stdin),
|
||||||
|
);
|
||||||
|
// Server -> client requests the server waits on: answer so it proceeds.
|
||||||
|
// `workspace/configuration` wants one reply per requested item; a
|
||||||
|
// catch-all covers the rest (e.g. `client/registerCapability`).
|
||||||
|
this.#connection.onRequest(ConfigurationRequest.type, ({ items }) =>
|
||||||
|
items.map(() => null),
|
||||||
|
);
|
||||||
|
this.#connection.onRequest(() => null);
|
||||||
|
this.#connection.listen();
|
||||||
|
}
|
||||||
|
|
||||||
|
public completionLabelsAt(
|
||||||
|
target: CompletionTarget,
|
||||||
|
): Promise<CompletionResult> {
|
||||||
|
return this.#ensureInitialized()
|
||||||
|
.then(() => this.#open(target))
|
||||||
|
.then(({ uri, position }) =>
|
||||||
|
this.#connection
|
||||||
|
.sendRequest(CompletionRequest.type, {
|
||||||
|
textDocument: { uri },
|
||||||
|
position,
|
||||||
|
context: { triggerKind: 1 },
|
||||||
|
})
|
||||||
|
.then((result) => ({
|
||||||
|
position,
|
||||||
|
labels: completionLabels(result),
|
||||||
|
})),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** `shutdown` + close stdin, then kill the server; safe after a failed probe. */
|
||||||
|
public close(): Promise<void> {
|
||||||
|
return (
|
||||||
|
this.#connection
|
||||||
|
.sendRequest(ShutdownRequest.type)
|
||||||
|
// The TS 7 Go server logs a bare `context canceled` to stderr
|
||||||
|
// when it handles `exit`; EOF on stdin shuts it down cleanly
|
||||||
|
// (exit 0, no output) instead.
|
||||||
|
.then(() => {
|
||||||
|
this.#child.stdin.end();
|
||||||
|
})
|
||||||
|
.then(() => delay(EXIT_DELAY_MS))
|
||||||
|
.finally(() => {
|
||||||
|
this.#connection.dispose();
|
||||||
|
this.#child.kill();
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ensureInitialized(): Promise<void> {
|
||||||
|
this.#ready ??= this.#initialize();
|
||||||
|
return this.#ready;
|
||||||
|
}
|
||||||
|
|
||||||
|
#initialize(): Promise<void> {
|
||||||
|
return this.#connection
|
||||||
|
.sendRequest(InitializeRequest.type, {
|
||||||
|
processId: process.pid,
|
||||||
|
rootUri: pathToFileURL(this.#repoRoot).href,
|
||||||
|
workspaceFolders: [
|
||||||
|
{ uri: pathToFileURL(this.#repoRoot).href, name: "repo" },
|
||||||
|
],
|
||||||
|
capabilities: {
|
||||||
|
textDocument: {
|
||||||
|
completion: {
|
||||||
|
completionItem: { snippetSupport: false },
|
||||||
|
},
|
||||||
|
publishDiagnostics: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.then(() =>
|
||||||
|
this.#connection.sendNotification(
|
||||||
|
InitializedNotification.type,
|
||||||
|
{},
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#open(target: CompletionTarget): Promise<{
|
||||||
|
readonly uri: string;
|
||||||
|
readonly position: Position;
|
||||||
|
}> {
|
||||||
|
const absolute = path.resolve(this.#repoRoot, target.file);
|
||||||
|
const marker = target.marker ?? DEFAULT_MARKER;
|
||||||
|
const position = markerPosition(target.source, marker);
|
||||||
|
const text = target.source.replace(marker, "");
|
||||||
|
const uri = pathToFileURL(absolute).href;
|
||||||
|
// The server handles `didOpen` in order before the completion request,
|
||||||
|
// so no settle delay is needed.
|
||||||
|
return this.#connection
|
||||||
|
.sendNotification(DidOpenTextDocumentNotification.type, {
|
||||||
|
textDocument: {
|
||||||
|
uri,
|
||||||
|
languageId: "typescript",
|
||||||
|
version: 1,
|
||||||
|
text,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.then(() => ({ uri, position }));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const main = (args: readonly string[]): Promise<void> => {
|
||||||
|
const [file, markerArgument] = args;
|
||||||
|
if (file === undefined) {
|
||||||
|
process.stderr.write(`${USAGE}\n`);
|
||||||
|
process.exitCode = FAILURE_EXIT_CODE;
|
||||||
|
return Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
const repoRoot = path.resolve(import.meta.dirname, "../../..");
|
||||||
|
const absolute = path.resolve(repoRoot, file);
|
||||||
|
const source = fs.readFileSync(absolute, "utf8");
|
||||||
|
const session = new LspSession(repoRoot);
|
||||||
|
return session
|
||||||
|
.completionLabelsAt({
|
||||||
|
file,
|
||||||
|
source,
|
||||||
|
marker: markerArgument ?? DEFAULT_MARKER,
|
||||||
|
})
|
||||||
|
.then(({ position, labels }) => {
|
||||||
|
process.stdout.write(
|
||||||
|
`\n[${file}] completions @ ${position.line}:${position.character}:\n${labels.join(", ")}\n`,
|
||||||
|
);
|
||||||
|
})
|
||||||
|
.finally(() => session.close());
|
||||||
|
};
|
||||||
|
|
||||||
|
const isEntryPoint = (): boolean => {
|
||||||
|
const [entry] = process.argv.slice(1, 2);
|
||||||
|
return entry !== undefined && import.meta.url === pathToFileURL(entry).href;
|
||||||
|
};
|
||||||
|
|
||||||
|
if (isEntryPoint()) {
|
||||||
|
main(process.argv.slice(ARGV_PREFIX_LENGTH)).catch((error: unknown) => {
|
||||||
|
process.stderr.write(
|
||||||
|
`${error instanceof Error ? error.message : String(error)}\n`,
|
||||||
|
);
|
||||||
|
process.exitCode = FAILURE_EXIT_CODE;
|
||||||
|
});
|
||||||
|
}
|
||||||
+7
-2
@@ -2,9 +2,14 @@
|
|||||||
"extends": "./tsconfig.json",
|
"extends": "./tsconfig.json",
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"noEmit": false,
|
"noEmit": false,
|
||||||
|
"target": "es2024",
|
||||||
|
"declaration": true,
|
||||||
|
"sourceMap": true,
|
||||||
|
"inlineSources": true,
|
||||||
|
"outDir": "dist",
|
||||||
"rewriteRelativeImportExtensions": true,
|
"rewriteRelativeImportExtensions": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src"
|
||||||
"outDir": "dist"
|
|
||||||
},
|
},
|
||||||
|
"include": ["src"],
|
||||||
"exclude": ["src/**/*.test.ts", "src/**/__tests__/**"]
|
"exclude": ["src/**/*.test.ts", "src/**/__tests__/**"]
|
||||||
}
|
}
|
||||||
+7
-33
@@ -1,38 +1,12 @@
|
|||||||
{
|
{
|
||||||
|
"extends": [
|
||||||
|
"@tsconfig/node26/tsconfig.json",
|
||||||
|
"@tsconfig/strictest/tsconfig.json"
|
||||||
|
],
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "es2024",
|
"noEmit": true,
|
||||||
"module": "nodenext",
|
|
||||||
"moduleResolution": "nodenext",
|
|
||||||
"moduleDetection": "force",
|
|
||||||
"lib": ["es2024"],
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"strict": true,
|
|
||||||
"noImplicitAny": true,
|
|
||||||
"noImplicitThis": true,
|
|
||||||
"alwaysStrict": true,
|
|
||||||
"strictNullChecks": true,
|
|
||||||
"strictFunctionTypes": true,
|
|
||||||
"strictBindCallApply": true,
|
|
||||||
"strictPropertyInitialization": true,
|
|
||||||
"noImplicitReturns": true,
|
|
||||||
"noFallthroughCasesInSwitch": true,
|
|
||||||
"noUncheckedIndexedAccess": true,
|
|
||||||
"noImplicitOverride": true,
|
|
||||||
"forceConsistentCasingInFileNames": true,
|
|
||||||
"noUnusedLocals": true,
|
|
||||||
"noUnusedParameters": true,
|
|
||||||
"isolatedModules": true,
|
|
||||||
"verbatimModuleSyntax": true,
|
|
||||||
"allowImportingTsExtensions": true,
|
"allowImportingTsExtensions": true,
|
||||||
"declaration": true,
|
"verbatimModuleSyntax": true
|
||||||
"declarationMap": true,
|
|
||||||
"sourceMap": true,
|
|
||||||
"outDir": "dist",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"allowSyntheticDefaultImports": true,
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"composite": false,
|
|
||||||
"types": ["node"]
|
|
||||||
},
|
},
|
||||||
"include": ["src"]
|
"include": ["src", "scripts"]
|
||||||
}
|
}
|
||||||
Reference in new issue
Block a user