@descent-vtt/spec-guard 0.15.0 → 0.17.0

package/CHANGELOG.md

@@ -1,9 +1,131 @@
 # Changelog
 
-All notable changes to this project are documented here. Versions follow
-[semantic versioning](https://semver.org), with the 0.x caveat that behaviour
-may change in a minor release — each such change is listed under **Changed**
-with the flag that restores the previous behaviour.
+All notable changes to this project are documented here. Before 1.0 a minor
+release (0.16.x to 0.17.0) carries anything that can turn a passing run red or
+change what a script reads - a finding or a failure that was not there, a
+changed exit code or JSON field, input refused that was accepted - and a patch
+only what reports less, crashes, performance and documentation, so `^0.17.0`
+takes no release that can turn a run red. Each entry under **Changed** says
+what to do when upgrading; the family's policy, including how a flag or field
+is deprecated before it goes, is spec-core's
+[ADR-0009](https://github.com/DescentVTT/spec-core/blob/main/docs/adr/0009-versions-before-1-0.md).
+
+## 0.17.0
+
+Chinese statuses and status tables are read, `--strict` refuses a run that
+verified nothing, a hint travels with every finding to GitLab and GitHub,
+fingerprints no longer follow a message's wording, and spec-core is at
+5666c96.
+
+### Changed
+
+- A status written in Chinese is read as the English word it translates
+  (`已取代` superseded, `草稿` draft, `延後` deferred), from a heading, a
+  label with `:` or `：`, a table, or front matter (`狀態:`); only the six
+  English words withhold a document ([ADR-0010](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0010-spec-status.md)).
+  Upgrading: a Chinese ADR marked superseded, deprecated, rejected, archived,
+  draft or proposed stops running its rules; write its status in English or
+  run with `--ignore-status` to keep them.
+- A two-column table before the first section whose left cell is `Status`,
+  `State`, `狀態` or `状态` gives the status, after a `## Status` section.
+  Upgrading: as above.
+- A `## Status` section or label that cannot be read keeps its document in
+  force with a warning, where it fell through to a later label. Upgrading:
+  write the status in the section.
+- Under `--strict`, a run or `prove` that executed no assertion exits 1, with
+  a `nothing-verified` finding in every format; a selection that picks no
+  rule still passes (ADR-0010). Upgrading: put a rule in force, fix the spec
+  patterns, or pass `--no-strict`.
+- `cites --strict` that read no source file writes a `nothing-read` finding
+  in every format; its exit code is unchanged
+  ([ADR-0017](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0017-citations-in-comments.md)).
+  Upgrading: a code-scanning or GitLab report shows one finding where it
+  showed none.
+- GitLab descriptions and GitHub messages carry the hint after the message.
+  Upgrading: nothing, unless a script compares a description whole.
+- The GitLab and SARIF fingerprints of a directive that cannot be read are
+  built from the directive as written, never its message. Upgrading: each
+  such issue or alert closes and reopens once.
+- spec-core at 5666c96: `.//f.ts` is `f.ts` at any depth, as `./f.ts` is,
+  in every pattern and under both engines, where it meant the root
+  ([ADR-0015](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0015-globs-from-spec-core.md),
+  [ADR-0013](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0013-structure-assertions.md)).
+  Upgrading: write `/f.ts` for the root.
+
+### Fixed
+
+- `glob="./!a"` and the spec pattern `./!*.md` name files called `!a` and
+  `!*.md`, where they were refused as negations.
+- `impact` lines up paths in Chinese, Japanese or Korean.
+- The README describes the GitLab fingerprint as the code builds it, lists
+  the `spec-warning` severity, says how to install ripgrep on GitLab runners
+  and Windows, and uploads SARIF with `upload-sarif@v4`.
+
+### Documentation
+
+- The README is reorganised: the directive reference sits under Directives,
+  Design decisions is an index of the ADRs, and development, mutation testing
+  and releasing moved to CONTRIBUTING.md, with the release flow in
+  [ADR-0019](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0019-releases-are-staged-by-ci.md);
+  SECURITY.md says how to report a vulnerability privately.
+
+## 0.16.0
+
+spec-core is at 7e41240: a leading `/` on a brace alternative anchors it, at
+every door, as one on the whole pattern does, in both engines; a glob that
+starts with `/` is judged with its slash, so `glob="/!a"` reads the root's
+`!a` and the advice for a rooted glob keeps the root.
+
+### Changed
+
+- **A leading `/` on a brace alternative anchors that alternative at the
+  root, as one on the whole pattern does.** spec-core, copied again from
+  `7e41240`, reads the slash on an alternative as it reads one on the
+  pattern, where it read it as nothing, and every pattern here follows.
+  `glob="{/f.ts}"` found `f.ts` at any depth, and now finds it at the root
+  only, as `glob="/f.ts"` does; so does `{/f.ts,x}` given whole to
+  `createGlobMatcher`, beside `x` at any depth. `{/build,x}` in the
+  configuration's `exclude`, and `{/build}` in `exclude=`, `--exclude`,
+  `module=` or a layer, left out every `build`, and now the one at the root,
+  as `/build` does, under both engines. A spec pattern `{/a.md,README.md}` -
+  on the command line, `--spec` or in `specs` - found every `a.md`, and now
+  the root's. `dirs="{/a/,d}"` chose `a` and `d`, and now chooses `d`, as
+  `dirs="/a"` chooses nothing. `{/src/*.ts,*.md}` and `/{a,/src}/a.ts` as
+  globs, a spec pattern `docs/{/adr/*.md,a.md}`, whose slash follows the
+  base as spec-core reads the whole pattern, and `a/{/b,c}`, whose slash
+  follows a segment, find what they found. `glob="././/f.ts"`, which found
+  nothing, finds the root's `f.ts`, as `.//f.ts` does. A directive's list
+  attribute and `--exclude` split on commas, so a group written there has
+  one alternative. Nothing restores the old reading: the alternative without
+  its slash, `{f.ts,x}` or `{build,x}`, says what it said. A run, `prove`,
+  `cites`, `query` and `impact` of the five spec-* repositories answer as
+  they did.
+  [ADR-0015](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0015-globs-from-spec-core.md)'s
+  and [ADR-0013](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0013-structure-assertions.md)'s
+  amendments of 2026-09-29.
+
+### Fixed
+
+- **A glob that starts with `/` is judged with its slash, as spec-core
+  reads it.** The slash was taken off before spec-core was asked whether the
+  glob could be read, so what it said was about the rest. `glob="/!a"` was
+  an invalid directive, `a negated pattern is a list entry, not a glob`,
+  where `{/!a,x}` read the name `!a` at the root; it now reads that name, as
+  spec-core does. `glob="/**.md"` was told to write `**/*.md` or `*.md`,
+  the second a name at any depth; it is now told `/**/*.md` or `/*.md`. A
+  spec pattern whose base is the root - `/**.md`, `/{a,b}/**.md`, `/!*.md`,
+  on the command line, `--spec` or in `specs` - was judged by what is below
+  the root alone, and is now judged whole and read from the root: `/!*.md`
+  finds the names `!*.md` at the root, where it was exit 2, and `/**.md` is
+  told `/**/*.md` or `/*.md`. `exclude`, `module`, a layer, `dirs` and a
+  spec pattern below a named directory kept the root already. A glob
+  beginning `/./` before braces that name no path, `/./{./,docs}`, is told
+  `the braces expand to "././"`, spec-core's words for it, where it was told
+  `"./"`, and a rooted glob of 65,535 characters after the slash is refused
+  for its size, as spec-core refuses it. `!a`, `**.md` and `docs/**.md` read
+  and are refused as they were.
+  [ADR-0015](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0015-globs-from-spec-core.md)'s
+  amendment of 2026-09-29.
 
 ## 0.15.0