Skip to content

chore: clean marks in CLI output strings + document CLI-only release rule#44

Merged
Shu-Wan merged 1 commit into
mainfrom
chore/cli-string-marks-and-dev-note
Jul 17, 2026
Merged

chore: clean marks in CLI output strings + document CLI-only release rule#44
Shu-Wan merged 1 commit into
mainfrom
chore/cli-string-marks-and-dev-note

Conversation

@Shu-Wan

@Shu-Wan Shu-Wan commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Follow-up to #43, which converted docs and code comments to devflow style but deliberately left the CLI's own output strings. This finishes the job so the CLI speaks devflow style too, and records a release-process rule you asked for.

1. Clean marks in CLI output strings

Converted the remaining - and ... in user-facing message literals and their test assertions:

  • side.rs (NOT_SOL_MESSAGE), jobs.rs (dry-run - would run:, - specify a JOBID:, nesting/non-interactive notices, allocation...), keep.rs (no flagged directories matched - ..., non-interactive, ... and N more), config.rs (the solx init starter-config header), and the matching cli.rs stderr assertions.
  • Left as-is: output.rs's json!("café — ok…") unicode round-trip test — the em-dash is the test subject (it asserts JSON escapes it to ). I also restored that test's explanatory comment, which chore: normalize prose + comments to devflow style (no em-dash/arrow/ellipsis) #43 had over-eagerly converted so its documented input no longer matched the it produces.
  • Verified: cargo build output now prints dry-run - would run:.

2. Document the CLI-only release rule (DEVELOPMENT.md)

Per your point — when a change is only about the solx crate and the skill's guidance content is unchanged (everything under skills/sol-skill/ identical apart from the shared version: line), the L1/L2/L3 skill evals don't need re-running; they still hold because the skill is unchanged. The gate for such a release is the crate's cargo test suite plus an L3 CLI smoke on real Sol. A release that touches skill prose/references/rules must still run the skill evals. (1.0.2 was CLI-only.)

Not a release

Cosmetic CLI-output punctuation + a doc note — no behavior/logic change, so no version bump (consistent with treating mark-cleaning as non-release). Ships with the next tagged release.

Verification

cargo test 104 unit + 40 integration pass · clippy -D warnings clean · fmt --check clean.

🤖 Generated with Claude Code

Follow-up to #43 (docs + code comments). Converts the remaining em-dash /
ellipsis marks in the CLI's own output strings and their test assertions,
so the CLI speaks devflow style too: side.rs, jobs.rs, keep.rs, the
config.rs starter config, and the matching cli.rs stderr assertions.

The unicode round-trip test fixture in output.rs (json!("café — ok...")) is
left as-is - the em-dash there is the test subject.

Also documents in DEVELOPMENT.md that a CLI-only release (skill guidance
unchanged) does not need the skill evals re-run - the crate test suite plus
an L3 CLI smoke is the gate. Cosmetic output only, so no version bump.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 17, 2026 00:25
@Shu-Wan
Shu-Wan merged commit b5d9d2d into main Jul 17, 2026
4 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Finishes the devflow-style punctuation sweep by converting remaining unicode marks in CLI user-facing output strings (and matching test assertions), and documents a release-process exception for “CLI-only” releases in DEVELOPMENT.md.

Changes:

  • Replace remaining CLI output literals using / with devflow-style - / ... across the solx crate.
  • Update solx/tests/cli.rs assertions to match the new stderr/status output text.
  • Add a DEVELOPMENT.md note clarifying when skill eval re-runs can be skipped for CLI-only releases.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
solx/tests/cli.rs Updates CLI stderr assertions to match the normalized output strings.
solx/src/side.rs Normalizes the “Sol-only” guard message shown when run off-cluster.
solx/src/jobs.rs Normalizes dry-run/status/error messaging and an allocation wait message.
solx/src/keep.rs Normalizes keep-plan status/error messaging, including truncation text.
solx/src/config.rs Normalizes the starter config header string emitted by solx init.
solx/src/output.rs Restores the unicode em-dash in a test comment to accurately reflect the test input under discussion.
DEVELOPMENT.md Documents the CLI-only release rule for skipping skill eval re-runs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Shu-Wan added a commit that referenced this pull request Jul 17, 2026
Completes the devflow mark sweep (#43, #44). #43 preserved fenced code
blocks verbatim; this converts the em-dash / arrow / ellipsis marks in
their `#` comment/annotation portions only - never command text (every
changed line is a shell comment). 41 marks across 9 docs.

`references/cheatsheet.md` is embedded in `solx cheatsheet`, so its output
now shows `->` in those annotations. The committed `docs/cheatsheet.pdf` is
unaffected: only arrows changed there, and `build-cheatsheet.sh` already
rewrites the arrow to `->` for the PDF.

Docs only, no version bump. `cargo test` 104+40 green (incl. the cheatsheet
needle test).

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Shu-Wan
Shu-Wan deleted the chore/cli-string-marks-and-dev-note branch July 17, 2026 00:35
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