Skip to content

feat: add live inspector, CLI and quality toolkit documentation - #48

Merged
atherdon merged 5 commits into
mainfrom
feat/inspector-and-cli
Oct 23, 2026
Merged

atherdon merged 5 commits into
mainfrom
feat/inspector-and-cli

Conversation

@atherdon

Copy link
Copy Markdown
Contributor

Summary

  • Applied the changes from the uploaded patch.txt: introduces a live inspector (dev server) and one-shot inspect CLI command, with supporting modules under src/cli/ and src/inspect/, new examples, tests, fixtures, and updated documentation/configs.
  • Moved the email quality toolkit proposal (issue-email-quality-toolkit.md) into docs/email-quality-toolkit.md as an addon for the documentation (planned future work for lint, plain-text, dark-mode and size checks).
  • Deleted the temporary source files (issue-email-quality-toolkit.md and patch.txt) from the repository root.

The inspector lets you see exactly which part broke, preview at multiple widths, and diff renders. Quality checks are documented as next steps.

Test plan

  • npm run check passes (format, lint, typecheck, build, test, smoke, publint)
  • npm run demo starts the live inspector on the example
  • npx template-runtime-display inspect ./examples/inspect-demo.mjs produces a report and exits non-zero due to the broken part
  • Docs link to the quality toolkit proposal works

Closes the temporary files that were added for this work.

Apply the inspector and CLI changes from the uploaded patch:
- New src/cli/ for dev server and one-shot inspect command
- src/inspect/ for HTML reports, diffs and styles
- Examples, tests, fixtures and updated configs
- Docs updated for the new commands

Move the email quality toolkit proposal into docs/email-quality-toolkit.md
as planned future work and remove the temporary source files.
@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Rendered emails

This PR rendered email templates.

Open the run → Artifacts → download → open index.html.

Comment thread test/fixtures/worker-dies.mjs Fixed
Comment thread test/fixtures/worker-dies.mjs Fixed
Comment thread test/fixtures/worker-loops.mjs Fixed
Comment thread test/fixtures/worker-reports.mjs Fixed
Comment thread test/fixtures/worker-reports.mjs Fixed
The worker fixtures intentionally use console, process, and timers.
Extend the existing Node globals config so CI lint and code scanning pass.

Copy link
Copy Markdown
Contributor Author

Addressed the CI failures and the security notice:

  • ESLint / code scanning: The worker fixtures (test/fixtures/worker-*.mjs) intentionally use Node globals (console, process, setInterval). Extended the existing Node globals configuration in eslint.config.js to cover test/fixtures/**/*.mjs so lint and Advanced Security scanning pass.

  • Dependabot alert Dependency Dashboard #3 (sprintf-js): The advisory GHSA-hp3w-g68c-fv3c was withdrawn on 2026-10-22 (it was not a real vulnerability; application responsibility for handling exceptions). It is a transitive devDependency via markup-generator → gray-matter → js-yaml → argparse. No code change required; the alert can be dismissed as false_positive or wont_fix.

Pushed c0f5dba. Re-running checks should clear the ESLint and Node 24 failures.

Export small pure helpers (withReload, isLoopbackHost, requestPath,
appendStderr) so every defensive branch is unit-tested, and add
fixtures that exercise the remaining CLI edge cases.
Agents must run npm run test:coverage and keep 100% on every metric,
and must run Prettier (write then check) before handing work back.
Also reformat test/diff.test.ts so format:check is clean.
@atherdon
atherdon merged commit ddd89a9 into main Oct 23, 2026
7 checks passed
@atherdon
atherdon deleted the feat/inspector-and-cli branch October 23, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants