sniff-qa 0.9.0 → 0.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +2 -2
- package/CHANGELOG.md +56 -0
- package/NOTICE +7 -4
- package/README.md +70 -20
- package/THIRD-PARTY-NOTICES.md +1800 -0
- package/dist/{accessibility-JXRMWF5Y.js → accessibility-42JOUOGH.js} +8 -2
- package/dist/{anthropic-api-7PHYF6PN.js → anthropic-api-VSG2X6FS.js} +7 -5
- package/dist/assert-budget-WG4BRCLX.js +10 -0
- package/dist/{caps-G3ZGJI7B.js → caps-YZPFNPIN.js} +3 -2
- package/dist/{chunk-VEI2O6AK.js → chunk-33JL2AB5.js} +14 -6
- package/dist/{chunk-64FUDSRY.js → chunk-3E4W4H6S.js} +8 -5
- package/dist/{chunk-T72SLMTY.js → chunk-3NR2K5B3.js} +2 -1
- package/dist/chunk-3ROWRVZE.js +422 -0
- package/dist/{chunk-MYWWSM3V.js → chunk-3YFE3H23.js} +2 -1
- package/dist/{chunk-MMISGY2Q.js → chunk-4F6ZXOPE.js} +2 -1
- package/dist/chunk-A4TTASVS.js +27862 -0
- package/dist/{chunk-IXDUD2UG.js → chunk-AA744N7E.js} +2 -1
- package/dist/chunk-DZMX3VT2.js +267 -0
- package/dist/{chunk-NG2IGCAK.js → chunk-FR5QCJLH.js} +2 -1
- package/dist/{chunk-GV27IOMC.js → chunk-GC47B6MM.js} +2 -1
- package/dist/chunk-HP4TY3UY.js +80 -0
- package/dist/chunk-LZAPYYNR.js +4595 -0
- package/dist/{chunk-ZM6MGWO4.js → chunk-NBJLMLDA.js} +2 -1
- package/dist/chunk-RAGYZ54R.js +15480 -0
- package/dist/{chunk-GX36BPK7.js → chunk-RSGFFRXQ.js} +2 -2
- package/dist/chunk-SOBWDC35.js +38 -0
- package/dist/{chunk-7BLJCICM.js → chunk-US4HFUCH.js} +3 -2
- package/dist/chunk-YM22FEIA.js +5807 -0
- package/dist/{ci-ISCWZJD3.js → ci-F6FUXT3O.js} +5 -3
- package/dist/{classifier-MWQMQ727.js → classifier-5FQ2FBTO.js} +3 -1
- package/dist/{claude-code-GJPWO6DN.js → claude-code-J43C22IR.js} +7 -5
- package/dist/{claude-exploration-provider-XOVJPJ23.js → claude-exploration-provider-EWQNNE7D.js} +3 -2
- package/dist/cli/index.js +69 -31
- package/dist/compiler-sfc.cjs-JX56AWNS.js +48568 -0
- package/dist/crawl-KN7SW753.js +26 -0
- package/dist/{crawl-command-JHZN4GK7.js → crawl-command-Y45FIXNK.js} +7 -6
- package/dist/{cross-reference-MHNPSLEN.js → cross-reference-XOOBW6UZ.js} +3 -1
- package/dist/{dev-server-detector-XQ5AYPDT.js → dev-server-detector-FMFVKDJR.js} +3 -1
- package/dist/{discover-QKGMYPHK.js → discover-HA63UA4K.js} +20 -18
- package/dist/dist-3CYER35S.js +8 -0
- package/dist/{domain-UQ34YE4B.js → domain-FU3WIW64.js} +45 -30
- package/dist/{edge-cases-ZADKDZHL.js → edge-cases-B6IV3IKK.js} +3 -1
- package/dist/{element-extractor-OZTFBVKZ.js → element-extractor-QAG4MRUO.js} +18 -6
- package/dist/engine-AXB5O4ZH.js +39 -0
- package/dist/{ensure-browsers-5NAQQMEC.js → ensure-browsers-TNMHMLRS.js} +59 -12
- package/dist/errors-NWB25P4K.js +8 -0
- package/dist/esm-IMWPYLSN.js +3469 -0
- package/dist/{fix-R33D34NP.js → fix-IXOEHAOS.js} +12 -5
- package/dist/{flakiness-OLJAY7CS.js → flakiness-7SSSM4SW.js} +3 -2
- package/dist/flakiness-CBKV4U54.js +12 -0
- package/dist/{formatter-4VI3ZX5Y.js → formatter-N4CC7SCM.js} +29 -22
- package/dist/{framework-detector-ISSM2Q2I.js → framework-detector-4ZVHNT7N.js} +3 -1
- package/dist/generator-GGJYWYI2.js +8 -0
- package/dist/index.js +9 -6
- package/dist/{init-IQKT4ANC.js → init-POX5ZJ6V.js} +4 -2
- package/dist/json-4VOVHDQG.js +10 -0
- package/dist/{junit-GL44ATRR.js → junit-V24COOSR.js} +3 -1
- package/dist/{llm-VJAI6H6G.js → llm-TZ2WZGRZ.js} +3 -1
- package/dist/{loader-Z2DUGG5Z.js → loader-AMM63AOJ.js} +12 -3
- package/dist/mcp/server.js +13035 -72
- package/dist/{model-SP6HJN6J.js → model-BL2AID5Q.js} +6 -5
- package/dist/page-hooks-SECSGZR6.js +14 -0
- package/dist/{page-state-extractor-GYYLYRFR.js → page-state-extractor-AP4FQVLY.js} +3 -1
- package/dist/{performance-7HWKY5O2.js → performance-JVEYVBTV.js} +9 -3
- package/dist/{persistence-XLFJ5EY4.js → persistence-SHKJVSIS.js} +5 -4
- package/dist/{persistence-KTCRIGHU.js → persistence-SQ6QT3HP.js} +3 -1
- package/dist/picocolors-3W2AX5TJ.js +6 -0
- package/dist/pixelmatch-GATIVDQX.js +188 -0
- package/dist/png-HTC2G4ZG.js +2093 -0
- package/dist/{prompt-builder-JT3GQBYP.js → prompt-builder-EI2BFKLZ.js} +3 -1
- package/dist/{provider-MMQ6EIBV.js → provider-O3UOALQH.js} +14 -12
- package/dist/{quality-run-KJMBBAQT.js → quality-run-CTLX5YA5.js} +12 -10
- package/dist/{redaction-CHAIVPCF.js → redaction-QNBV5QZ3.js} +4 -3
- package/dist/{registry-5XCXUAYJ.js → registry-JBBTSD7I.js} +3 -1
- package/dist/{repo-analyzer-4OURSITY.js → repo-analyzer-4XITIIAF.js} +6 -4
- package/dist/{report-SDZWX25B.js → report-4UVJL7QV.js} +3 -1
- package/dist/{report-XK2MCX2N.js → report-BOVSPRCR.js} +8 -6
- package/dist/{response-parser-PUGNWF7S.js → response-parser-GHVJSYXQ.js} +3 -2
- package/dist/{route-discoverer-QBZCRQLJ.js → route-discoverer-ZXYJQIYE.js} +15 -8
- package/dist/{runner-RDVVIGBU.js → runner-DOLCFA3S.js} +10 -5
- package/dist/{runner-QHSYX7J2.js → runner-MCSDHFLN.js} +12 -7
- package/dist/{runner-AXZXNWYH.js → runner-MUBXHOIG.js} +10 -4
- package/dist/{scenarios-I7YYVTD2.js → scenarios-T2U6ZDRL.js} +3 -1
- package/dist/sdk-FQKA5HSQ.js +7184 -0
- package/dist/{source-5LS2B7TN.js → source-T5MHBY5G.js} +14 -7
- package/dist/{tiebreak-L5UFNKU2.js → tiebreak-SXBXPT7B.js} +3 -1
- package/dist/{unified-OEGLPOGE.js → unified-NUR2X5JV.js} +23 -21
- package/dist/{update-baselines-JYKUUIZG.js → update-baselines-TMERPIDV.js} +4 -2
- package/dist/version-FEHABGAH.js +10 -0
- package/dist/{visual-EUZG2STF.js → visual-XHFPFQFX.js} +5 -3
- package/dist/{workflow-template-6DADGPHA.js → workflow-template-7C5CCK67.js} +13 -7
- package/dist/{write-report-Y4UPVXUO.js → write-report-6Q4MXBYD.js} +5 -4
- package/package.json +19 -10
- package/dist/accessibility-JXRMWF5Y.js.map +0 -1
- package/dist/anthropic-api-7PHYF6PN.js.map +0 -1
- package/dist/assert-budget-NBF3JYM7.js +0 -9
- package/dist/assert-budget-NBF3JYM7.js.map +0 -1
- package/dist/caps-G3ZGJI7B.js.map +0 -1
- package/dist/chunk-64FUDSRY.js.map +0 -1
- package/dist/chunk-7BLJCICM.js.map +0 -1
- package/dist/chunk-GV27IOMC.js.map +0 -1
- package/dist/chunk-GX36BPK7.js.map +0 -1
- package/dist/chunk-IXDUD2UG.js.map +0 -1
- package/dist/chunk-MMISGY2Q.js.map +0 -1
- package/dist/chunk-MYWWSM3V.js.map +0 -1
- package/dist/chunk-NG2IGCAK.js.map +0 -1
- package/dist/chunk-T72SLMTY.js.map +0 -1
- package/dist/chunk-VEI2O6AK.js.map +0 -1
- package/dist/chunk-ZM6MGWO4.js.map +0 -1
- package/dist/ci-ISCWZJD3.js.map +0 -1
- package/dist/classifier-MWQMQ727.js.map +0 -1
- package/dist/claude-code-GJPWO6DN.js.map +0 -1
- package/dist/claude-exploration-provider-XOVJPJ23.js.map +0 -1
- package/dist/cli/index.js.map +0 -1
- package/dist/crawl-XPHT3KIZ.js +0 -23
- package/dist/crawl-XPHT3KIZ.js.map +0 -1
- package/dist/crawl-command-JHZN4GK7.js.map +0 -1
- package/dist/cross-reference-MHNPSLEN.js.map +0 -1
- package/dist/dev-server-detector-XQ5AYPDT.js.map +0 -1
- package/dist/discover-QKGMYPHK.js.map +0 -1
- package/dist/domain-UQ34YE4B.js.map +0 -1
- package/dist/edge-cases-ZADKDZHL.js.map +0 -1
- package/dist/element-extractor-OZTFBVKZ.js.map +0 -1
- package/dist/ensure-browsers-5NAQQMEC.js.map +0 -1
- package/dist/errors-RFEOR527.js +0 -7
- package/dist/errors-RFEOR527.js.map +0 -1
- package/dist/fix-R33D34NP.js.map +0 -1
- package/dist/flakiness-OLJAY7CS.js.map +0 -1
- package/dist/flakiness-OVC7KGN2.js +0 -11
- package/dist/flakiness-OVC7KGN2.js.map +0 -1
- package/dist/formatter-4VI3ZX5Y.js.map +0 -1
- package/dist/framework-detector-ISSM2Q2I.js.map +0 -1
- package/dist/generator-AFHVMWC3.js +0 -7
- package/dist/generator-AFHVMWC3.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/init-IQKT4ANC.js.map +0 -1
- package/dist/json-YDWEB33Q.js +0 -8
- package/dist/json-YDWEB33Q.js.map +0 -1
- package/dist/junit-GL44ATRR.js.map +0 -1
- package/dist/llm-VJAI6H6G.js.map +0 -1
- package/dist/loader-Z2DUGG5Z.js.map +0 -1
- package/dist/mcp/server.js.map +0 -1
- package/dist/model-SP6HJN6J.js.map +0 -1
- package/dist/page-hooks-6RALVZB5.js +0 -13
- package/dist/page-hooks-6RALVZB5.js.map +0 -1
- package/dist/page-state-extractor-GYYLYRFR.js.map +0 -1
- package/dist/performance-7HWKY5O2.js.map +0 -1
- package/dist/persistence-KTCRIGHU.js.map +0 -1
- package/dist/persistence-XLFJ5EY4.js.map +0 -1
- package/dist/prompt-builder-JT3GQBYP.js.map +0 -1
- package/dist/provider-MMQ6EIBV.js.map +0 -1
- package/dist/quality-run-KJMBBAQT.js.map +0 -1
- package/dist/redaction-CHAIVPCF.js.map +0 -1
- package/dist/registry-5XCXUAYJ.js.map +0 -1
- package/dist/repo-analyzer-4OURSITY.js.map +0 -1
- package/dist/report-SDZWX25B.js.map +0 -1
- package/dist/report-XK2MCX2N.js.map +0 -1
- package/dist/response-parser-PUGNWF7S.js.map +0 -1
- package/dist/route-discoverer-QBZCRQLJ.js.map +0 -1
- package/dist/runner-AXZXNWYH.js.map +0 -1
- package/dist/runner-QHSYX7J2.js.map +0 -1
- package/dist/runner-RDVVIGBU.js.map +0 -1
- package/dist/scenarios-I7YYVTD2.js.map +0 -1
- package/dist/source-5LS2B7TN.js.map +0 -1
- package/dist/tiebreak-L5UFNKU2.js.map +0 -1
- package/dist/unified-OEGLPOGE.js.map +0 -1
- package/dist/update-baselines-JYKUUIZG.js.map +0 -1
- package/dist/version-FLE7ZHDX.js +0 -7
- package/dist/version-FLE7ZHDX.js.map +0 -1
- package/dist/visual-EUZG2STF.js.map +0 -1
- package/dist/workflow-template-6DADGPHA.js.map +0 -1
- package/dist/write-report-Y4UPVXUO.js.map +0 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sniff",
|
|
3
|
-
"version": "0.9.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.9.2",
|
|
4
|
+
"description": "Walks your running app in a real browser and lists what is broken: dead pages, console errors, broken forms. Each page bug comes with repro steps and a fix.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Adam Boudjemaa",
|
|
7
7
|
"url": "https://github.com/Aboudjem/sniff"
|
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,62 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.9.2] - 2026-11-17
|
|
11
|
+
|
|
12
|
+
A clearer first screen and truer wording. No behaviour change: the code is the same as 0.9.1.
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- **README first screen.** It now opens with the outcome, the command and the real report. Under
|
|
17
|
+
the report, a short `Why use it` block gives three benefits, each with its proof. The limit sits
|
|
18
|
+
next to the promise: a walk submits real forms, so use a dev or staging app.
|
|
19
|
+
- **Listing descriptions.** The plugin, npm, Gemini and MCP registry descriptions are now one plain
|
|
20
|
+
sentence instead of a feature list.
|
|
21
|
+
- **Truer wording.** The README no longer says every finding has a screenshot. On the fixture, 23 of
|
|
22
|
+
27 findings have one, and source-scan findings have no route. The first-run size is now measured:
|
|
23
|
+
on a Mac, `npx sniff-qa install` left 193 MB of engine and 528 MB of Chromium on disk.
|
|
24
|
+
- **Translations, hero banners, social preview, `llms.txt`, `AGENTS.md` and the Pages site** carry
|
|
25
|
+
the same one-liner.
|
|
26
|
+
|
|
27
|
+
## [0.9.1] - 2026-11-17
|
|
28
|
+
|
|
29
|
+
The MCP server now connects on a new machine's first start.
|
|
30
|
+
|
|
31
|
+
### Fixed
|
|
32
|
+
|
|
33
|
+
- **First start of the MCP server.** `npx -y sniff-qa --mcp` had to download about 250 MB of
|
|
34
|
+
dependencies before it could answer the handshake. On a cold machine that took 23 to 92 s, past
|
|
35
|
+
Claude Code's 30 s connect timeout, and a killed download could leave a broken npx cache. Two
|
|
36
|
+
changes fix it. The browser engine (Playwright, axe-core for Playwright, Lighthouse,
|
|
37
|
+
chrome-launcher) is no longer an npm dependency: sniff downloads it on first use. The other
|
|
38
|
+
runtime dependencies are bundled into `dist/`, so the package depends on `zod` alone. The first
|
|
39
|
+
start now downloads two small packages. `npm run cold-start` re-measures it.
|
|
40
|
+
- **Licenses of bundled code.** `THIRD-PARTY-NOTICES.md` ships in the package with the license
|
|
41
|
+
text of every bundled package.
|
|
42
|
+
- **No "packages it lists are not installed" note in `claude plugin list`.** Claude Code installs
|
|
43
|
+
a plugin's npm dependencies when it caches the plugin. The old dependency tree was too large for
|
|
44
|
+
that step; the new one installs in seconds.
|
|
45
|
+
- `--help` printed the `--fail-on` default twice.
|
|
46
|
+
|
|
47
|
+
### Added
|
|
48
|
+
|
|
49
|
+
- **`sniff install [browsers...]`** downloads the browser engine (about 200 MB, once per sniff
|
|
50
|
+
version, into `~/.cache/sniff-qa/engine/<version>`) and Chromium, so the first walk starts at
|
|
51
|
+
once. `--with-deps` also installs the Linux system libraries; `--deps-only` installs only those.
|
|
52
|
+
`SNIFF_ENGINE_DIR` moves the engine folder.
|
|
53
|
+
- The first CLI walk still downloads everything it needs by itself, with progress on stderr.
|
|
54
|
+
- The `sniff_install` MCP tool now downloads the engine too. Browser tools still answer
|
|
55
|
+
`needsSetup: playwright-browsers` until it has run, so no tool call blocks on a silent download.
|
|
56
|
+
- `sniff doctor` says where the engine loads from, or that it is not downloaded yet.
|
|
57
|
+
|
|
58
|
+
### Changed
|
|
59
|
+
|
|
60
|
+
- Install hints say `npx -y sniff-qa@<version> install <browser>` instead of
|
|
61
|
+
`npx playwright install <browser>`, which could fetch a Playwright that does not match sniff's.
|
|
62
|
+
- `sniff ci` writes a workflow that runs `sniff-qa install --with-deps chromium` and caches
|
|
63
|
+
`~/.cache/sniff-qa` next to the Playwright browsers.
|
|
64
|
+
- A project that installs `playwright` or `lighthouse` itself keeps using its own copy.
|
|
65
|
+
|
|
10
66
|
## [0.9.0] - 2026-11-17
|
|
11
67
|
|
|
12
68
|
Every report now opens with the answer. The first walk on a new machine works.
|
package/NOTICE
CHANGED
|
@@ -8,7 +8,10 @@ If you use Sniff in your project, a mention or attribution is appreciated:
|
|
|
8
8
|
- "QA powered by Sniff (https://github.com/Aboudjem/sniff)"
|
|
9
9
|
|
|
10
10
|
Third-party licenses:
|
|
11
|
-
-
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
11
|
+
- The packages bundled into dist/ are listed, with their license texts, in
|
|
12
|
+
THIRD-PARTY-NOTICES.md.
|
|
13
|
+
- pixelmatch (ISC) - https://github.com/mapbox/pixelmatch (bundled)
|
|
14
|
+
- The browser engine is downloaded on first use, with its own licenses, not bundled:
|
|
15
|
+
- Playwright (Apache-2.0) - https://playwright.dev
|
|
16
|
+
- axe-core (MPL-2.0) - https://www.deque.com/axe/
|
|
17
|
+
- Lighthouse (Apache-2.0) - https://developer.chrome.com/docs/lighthouse
|
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
<p align="center"><b>English</b> · <a href="READMEs/zh-CN.md">简体中文</a> · <a href="READMEs/ja.md">日本語</a> · <a href="READMEs/es.md">Español</a> · <a href="READMEs/fr.md">Français</a></p>
|
|
14
14
|
|
|
15
|
-
<p align="center"><b>
|
|
15
|
+
<p align="center"><b>Catch what is broken in your web app before your users do.</b></p>
|
|
16
16
|
|
|
17
17
|
<p align="center"><a href="#what-you-get">What you get</a> · <a href="#install">Install</a> · <a href="#how-it-works">How it works</a> · <a href="#works-with">Works with</a> · <a href="#proof">Proof</a> · <a href="#faq">FAQ</a> · <a href="#limits">Limits</a></p>
|
|
18
18
|
|
|
@@ -23,7 +23,7 @@ npx sniff-qa --url http://localhost:3000
|
|
|
23
23
|
## What you get
|
|
24
24
|
|
|
25
25
|
A report that opens with the verdict, then the three things to fix first, then every finding.
|
|
26
|
-
This is the
|
|
26
|
+
This is the report from a real run on this repo's planted-bug fixture (2026-11-17, sniff 0.9.0).
|
|
27
27
|
|
|
28
28
|
```text
|
|
29
29
|
VERDICT FAIL: 26 findings (1 critical, 13 high, 11 medium, 1 low)
|
|
@@ -45,19 +45,25 @@ This is the top of a real run on this repo's planted-bug fixture (2026-11-17, sn
|
|
|
45
45
|
shot: sniff-reports/crawl/_crash-desktop.png
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
You changed one form, and now a page you never opened throws a 500. sniff opens your running app
|
|
49
|
+
in a real browser and clicks through it like a user would. Each page bug it reports comes with
|
|
50
|
+
the steps that reproduce it.
|
|
49
51
|
|
|
50
|
-
|
|
51
|
-
| :-------------- | :---------- | :------------------------------------------ |
|
|
52
|
-
| Terminal report | (default) | Reading the result now |
|
|
53
|
-
| HTML page | `--report` | Sending to someone, one self-contained file |
|
|
54
|
-
| JSON | `--json` | Scripts and other tools |
|
|
55
|
-
| Exit code | `--fail-on` | Failing CI on real bugs |
|
|
52
|
+
### Why use it
|
|
56
53
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
54
|
+
- **Fix it, do not hunt for it.** Each page finding names the route, the steps and a fix, most with a screenshot.
|
|
55
|
+
- **Proof it catches real bugs.** Tested on bugs planted on purpose: 21 of 21 found, 0 false findings on the clean page (`npm run build && npm run proof`).
|
|
56
|
+
- **Block bad merges.** `--fail-on` exits 1 on critical or high findings, and `npx sniff-qa ci` writes the GitHub Actions file. No API key.
|
|
57
|
+
|
|
58
|
+
It needs your app running, and it submits real forms, so use a dev or staging app.
|
|
59
|
+
The first walk downloads a browser once, about 720 MB on disk on a Mac.
|
|
60
|
+
|
|
61
|
+
To reproduce the sample from a clone, start the fixture, then walk it from a second terminal:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
node sniff-tests/planted-bugs/server.mjs 4517
|
|
65
|
+
npx sniff-qa --url http://localhost:4517
|
|
66
|
+
```
|
|
61
67
|
|
|
62
68
|
<img alt="sniff walking a buggy app and streaming findings with severity, confidence, steps to reproduce, and a fix" src="https://raw.githubusercontent.com/Aboudjem/sniff/main/.github/assets/demo.gif" width="100%">
|
|
63
69
|
|
|
@@ -92,8 +98,43 @@ npx skills add Aboudjem/sniff
|
|
|
92
98
|
claude mcp add sniff-qa -- npx -y sniff-qa --mcp
|
|
93
99
|
```
|
|
94
100
|
|
|
95
|
-
The first walk downloads
|
|
96
|
-
|
|
101
|
+
The first walk downloads two things, once: the browser engine (Playwright, axe-core and
|
|
102
|
+
Lighthouse) and Chromium. To do it ahead of time, run:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
npx sniff-qa install
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
It ends with the time it took. On a Mac with an empty npm cache it printed 34 s (2026-11-17, sniff 0.9.1).
|
|
109
|
+
It left 193 MB of engine and 528 MB of Chromium on disk. To re-measure on macOS:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
du -sm ~/.cache/sniff-qa/engine/* ~/Library/Caches/ms-playwright
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
`npx sniff-qa doctor` checks Node, the browser and your dev server.
|
|
116
|
+
|
|
117
|
+
The MCP server starts before those downloads. With an empty npm cache, `npx -y sniff-qa@0.9.1 --mcp`
|
|
118
|
+
answered its first handshake in 3.1 to 4.9 s (5 runs, 2026-11-17). Version 0.9.0 took 37 to 93 s,
|
|
119
|
+
past Claude Code's 30 s connect limit. To re-measure, in a clone of this repo:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
npm run cold-start -- 0.9.1 5
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
A walk prints progress lines, then the report. You can take the result four ways:
|
|
126
|
+
|
|
127
|
+
| Output | Flag | Use it for |
|
|
128
|
+
| :-------------- | :---------- | :------------------------------------------ |
|
|
129
|
+
| Terminal report | (default) | Reading the result now |
|
|
130
|
+
| HTML page | `--report` | Sending to someone, one self-contained file |
|
|
131
|
+
| JSON | `--json` | Scripts and other tools |
|
|
132
|
+
| Exit code | `--fail-on` | Failing CI on real bugs |
|
|
133
|
+
|
|
134
|
+
| Exit code | Meaning |
|
|
135
|
+
| :-------- | :------------------------------------------------------------------------------ |
|
|
136
|
+
| `0` | No finding reached the `--fail-on` severities (default: critical and high) |
|
|
137
|
+
| `1` | A finding reached them, an `assert` budget was breached, or sniff could not run |
|
|
97
138
|
|
|
98
139
|
<details>
|
|
99
140
|
<summary>Project install and CI</summary>
|
|
@@ -109,7 +150,7 @@ with browser caching and report artifacts.
|
|
|
109
150
|
1. **Find the app.** It uses `--url`, or a dev server on a common port.
|
|
110
151
|
2. **Walk it.** A headless Chromium follows your links, clicks buttons and fills forms, like a user.
|
|
111
152
|
3. **Judge what happened.** Each page is checked for 12 classes of bugs.
|
|
112
|
-
4. **Prove it.** A finding needs a route
|
|
153
|
+
4. **Prove it.** A finding needs a route and the steps. It adds a screenshot and the console or network lines when it has them.
|
|
113
154
|
5. **Report.** Verdict first, then the fix-first list, then the detail.
|
|
114
155
|
|
|
115
156
|
The 12 classes:
|
|
@@ -134,7 +175,7 @@ The MCP server exposes these tools:
|
|
|
134
175
|
| `sniff_install` | Downloads the Playwright browser |
|
|
135
176
|
| `sniff_report` | Reads the last saved results |
|
|
136
177
|
|
|
137
|
-
`--caps scan,report` narrows the server to
|
|
178
|
+
`--caps scan,report` narrows the server to `sniff_scan`, `sniff_report` and the unified `sniff` tool, with no browser at all.
|
|
138
179
|
|
|
139
180
|
## Works with
|
|
140
181
|
|
|
@@ -153,7 +194,7 @@ Their snippets are in [docs/editors.md](docs/editors.md).
|
|
|
153
194
|
|
|
154
195
|
## Proof
|
|
155
196
|
|
|
156
|
-
|
|
197
|
+
Three commands re-print the numbers on this page. The first prints the fixture score.
|
|
157
198
|
|
|
158
199
|
```bash
|
|
159
200
|
npm run build && npm run proof
|
|
@@ -168,6 +209,8 @@ It starts the planted-bug fixture, walks it, and scores the report. Output on 20
|
|
|
168
209
|
Hard FP on clean page (/clean): 0
|
|
169
210
|
```
|
|
170
211
|
|
|
212
|
+
The sample above shows 26 findings and this run counts 27. The proof run uses `--all`, which adds the 1 low-confidence finding.
|
|
213
|
+
|
|
171
214
|
The fixture holds 21 planted bugs across all 12 classes, plus a clean control page.
|
|
172
215
|
The scorer is [sniff-tests/score-fixture.mjs](sniff-tests/score-fixture.mjs).
|
|
173
216
|
The bugs are listed in [sniff-tests/planted-bugs/MANIFEST.json](sniff-tests/planted-bugs/MANIFEST.json).
|
|
@@ -176,10 +219,16 @@ The bugs are listed in [sniff-tests/planted-bugs/MANIFEST.json](sniff-tests/plan
|
|
|
176
219
|
npm test
|
|
177
220
|
```
|
|
178
221
|
|
|
179
|
-
Prints `Test Files
|
|
222
|
+
Prints `Test Files 52 passed (52)` and `Tests 555 passed (555)` on 2026-11-17.
|
|
180
223
|
The suite includes the fixture gate. It fails the build if recall drops below 85%.
|
|
181
224
|
It also fails on any finding on the clean page.
|
|
182
225
|
|
|
226
|
+
```bash
|
|
227
|
+
node sniff-tests/mcp-smoke.mjs
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Prints the 6 MCP tools and the 20 findings quoted in the table above.
|
|
231
|
+
|
|
183
232
|
## FAQ
|
|
184
233
|
|
|
185
234
|
**Do I need an API key or an account?**
|
|
@@ -202,7 +251,8 @@ More answers are in [docs/faq.md](docs/faq.md).
|
|
|
202
251
|
## Limits
|
|
203
252
|
|
|
204
253
|
- It needs a running app for the walk. Without one you only get the source scan.
|
|
205
|
-
- The first walk needs internet to download Chromium once.
|
|
254
|
+
- The first walk needs internet to download the browser engine and Chromium once, 721 MB on disk on a Mac.
|
|
255
|
+
- Until then, MCP browser tools answer `needsSetup` and the agent calls `sniff_install` first.
|
|
206
256
|
- Dead-link checking follows external links, so a walk requests the third-party URLs your pages link to.
|
|
207
257
|
- Redaction covers report text, not screenshot pixels. A screenshot of a logged-in page can show private data.
|
|
208
258
|
- It finds what a user would see. It does not read your server logs or measure load.
|