Skip to content

feat: make the first Offing run useful without configuration - #319

Merged
arminazimi merged 1 commit into
mainfrom
feat/119-first-run
Nov 18, 2026
Merged

arminazimi merged 1 commit into
mainfrom
feat/119-first-run

Conversation

@arminazimi

Copy link
Copy Markdown
Contributor

Closes #119
Closes #169
Closes #191
Closes #192
Closes #217
Closes #193
Closes #194
Closes #195
Closes #218
Closes #236
Closes #253

What changed

  • Run a local scan and concise forecast when no subcommand is supplied. The text ends with two next steps, handles empty directories and missing Git history, and never prompts. --json uses the existing forecast document unchanged.
  • Snapshot three examples and cover bare execution in CI. Benchmark bare invocation on a clean copy of every example and measure compressed package downloads from a clean npm cache.
  • Update the Quickstart with real demo output and the published package size. Explicit subcommands and README are unchanged.

Quality bar

Reviewed against Reference quality and the review rubric.

Checks CI cannot make

  • Tests added or updated for changed behavior
  • Changelog fragment added in changes/ for user-visible changes

Verification

  • npm run check
  • node --test dist/tests/first-run*.test.js dist/tests/forecast-snapshots.test.js
  • node dist/benchmarks/first-run.js: all 67 examples finished under the 5-second budget on macOS arm64 with Node.js 22; the slowest took 1.81 seconds.
  • node dist/benchmarks/first-run.js --npx-size: 5,208,351 compressed bytes across 12 tarballs for the published @velella/offing@0.1.1 on macOS arm64.
  • node dist/benchmarks/first-run.js --check: existing smoke fixture reported four findings.
  • npm run example --silent -- demo --as-of 2026-10-25: matched the Quickstart output.

Notes for reviewers

The example timings already meet the budget with a real scan and the scan cache disabled, so no detector or scan-engine optimization was necessary. The download measurement is for the published package, not an unreleased tarball from this PR.

@arminazimi
arminazimi merged commit f9bf191 into main Nov 18, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment