Skip to content

Releases: WLDKK/snippet-fidelity

Snippet Fidelity v0.4.0

Choose a tag to compare

@WLDKK WLDKK released this 31 Aug 11:42
2b04c23

Snippet Fidelity v0.4.0 introduces a versioned four-stage Proof Graph, explicit evidence availability, all six pairwise comparisons, and graph-aware Markdown and JUnit output while preserving existing report fields. It also strengthens Node.js 22 and 24 CI coverage and composite Action installation reliability.

What's Changed

  • chore: keep Dependabot major upgrades reviewable by @WLDKK in #7
  • chore: harden the supported runtime baseline by @WLDKK in #8
  • feat: add proof graph evidence by @WLDKK in #9
  • chore: prepare v0.4.0 release by @WLDKK in #10

Full Changelog: v0.3.0...v0.4.0

Snippet Fidelity v0.3.0

Choose a tag to compare

@WLDKK WLDKK released this 30 Aug 16:09
631c69c

Highlights

  • See clipboard fidelity results directly in the GitHub workflow summary.
  • Get one escaped GitHub error annotation for every non-passing check.
  • Consume outcome, total, passed, failed, and errors from later workflow steps.
  • Try any public documentation URL in one Action step before committing a source-aware gate.
  • Keep the original audit result authoritative if optional GitHub summary publishing is unavailable.

Reliability and maintenance

  • Internal Actions are pinned to immutable commits and run natively on Node 24.
  • The repository Action smoke test now verifies the complete output contract in CI.
  • Weekly Dependabot updates cover npm and grouped GitHub Action dependencies.
  • The configuration JSON Schema is available from the moving v0 release line.
  • Security support guidance now tracks the latest published 0.x release.

Verification

  • 6 test files and 23 tests passed locally and on GitHub-hosted Ubuntu runners.
  • The committed distribution was rebuilt and verified unchanged.
  • A clean consumer install passed from the packed snippet-fidelity-0.3.0.tgz archive.
  • Positive and adversarial Chromium fixtures verified summaries, outputs, opt-out behavior, and exit codes.

Install

npm install --save-dev snippet-fidelity@0.3.0
npx playwright install chromium

GitHub Action users can continue using WLDKK/snippet-fidelity@v0 for compatible pre-1.0 updates.

Full changelog: v0.2.0...v0.3.0

Snippet Fidelity v0.2.0

Choose a tag to compare

@WLDKK WLDKK released this 26 Aug 07:45

Snippet Fidelity v0.2.0 turns the source-to-clipboard prototype into an installable release gate for documentation projects.

Highlights

  • Published as snippet-fidelity:

    npm install --save-dev snippet-fidelity
    npx playwright install chromium
    npx snippet-fidelity audit https://docs.example.com/
  • Added a reusable composite GitHub Action. Pin WLDKK/snippet-fidelity@v0 and supply either a source-aware config or a live URL.

  • Added Markdown, JSON, and JUnit report support to the Action workflow.

  • Added clean package-consumer and Action smoke verification to the release gate.

  • Expanded the dated competitor ledger with Doc Detective, Playwright Clipboard, and custom Playwright tests.

  • Published a responsible public-site pilot study covering Astro Starlight, Material for MkDocs, and Doc Detective.

Reliability fixes found during the pilot

  • Automatic discovery now excludes hidden code blocks and copy controls left mounted by tab and responsive layouts.
  • Hover-revealed controls remain eligible for fidelity checks.
  • Copy probes activate the selected control directly, so unrelated visual overlap is not misreported as a clipboard-fidelity failure.
  • npm package metadata now preserves the installed snippet-fidelity command, and the release gate requires the generated .bin shim.

Verification

  • Formatting and TypeScript checks passed.
  • 20 tests passed, including real Chromium end-to-end coverage.
  • The composite Action passed in GitHub Actions against the repository fixture.
  • The package passed pack inspection and a clean tarball install.
  • The public npm package was installed in a fresh directory and its command reported 0.2.0.

Evidence boundaries

Rendered-DOM discovery is intended for reconnaissance. A dependable merge gate should declare canonical text or a canonical UTF-8 source file. This release supports Chromium only and does not test pointer hit-targeting or native paste applications.

See the GitHub Action guide, pilot study, and changelog for details.

Snippet Fidelity v0.1.0

Choose a tag to compare

@WLDKK WLDKK released this 26 Aug 03:18

Snippet Fidelity's first public pre-release verifies that documentation copy buttons preserve the
text maintainers intended to ship.

Highlights

  • Compares canonical text, rendered code, copy-handler payloads, and the browser clipboard at
    Unicode code-point precision.
  • Detects terminal newlines, indentation loss, tab/space substitution, invisible characters,
    punctuation substitution, and Unicode normalization changes.
  • Emits bounded Markdown, JSON, and JUnit evidence without including complete snippets by default.
  • Exercises real copy controls in Chromium and refuses ambiguous selectors.
  • Ships a six-case adversarial fixture corpus: one correct control and five intentional regressions.

Install

npm install --save-dev https://github.com/WLDKK/snippet-fidelity/releases/download/v0.1.0/snippet-fidelity-0.1.0.tgz
npx playwright install chromium
npx snippet-fidelity audit https://docs.example.com/

Verification

  • Node.js 24.14.0 and pnpm 10.18.0
  • 5 test files and 19 tests passed, including real Chromium end-to-end coverage
  • type check, build, package dry-run, and production dependency audit passed
  • no known production dependency vulnerabilities reported at release time

Known limitations

  • Chromium is the only supported browser in 0.1.x.
  • Explicit selectors and canonical text or files are required for a dependable source-aware release
    gate.
  • Automatic discovery is intended for reconnaissance and regression triage.

Integrity

SHA-256 (snippet-fidelity-0.1.0.tgz):
3C2850B8BFA8712BB518D24017DDF24D30586631CD49AFF0CC59BC74A4DE8DBB