Skip to content

docs(zsh-lint): update the guide for v1.6.1 - #951

Merged
ss-o merged 1 commit into
mainfrom
feature-949-zsh-lint-guide
Oct 25, 2026
Merged

ss-o merged 1 commit into
mainfrom
feature-949-zsh-lint-guide

Conversation

@ss-o

@ss-o ss-o commented Oct 25, 2026

Copy link
Copy Markdown
Member

Summary

Closes #949.

The Zsh Lint guide described v1.6.0. This moves it to the published v1.6.1 (z-shell/zsh-lint#751), a patch release with rule and parser fixes and no new options. The generated rule reference (08_rule_reference.mdx) is unchanged here; #950 updated it to v1.6.1.

  • The install commands for zsh-lint (index, Getting started, CI and JSON) and zsh-lint-survey (Parser survey) use @v1.6.1.
  • The statements that describe the current release name v1.6.1: the guide index, the Getting started description, --help behaviour, the quoting/unquoted-var scope, file-argument handling, and the published-CLI rule in Choosing files.
  • Statements about the release in which a behaviour changed keep their versions: --help printing an error before v1.6.0, --config since v1.2.0, and configuration discovery since v1.3.0.
  • The guide pages do not describe the two rules fixed in v1.6.1 (declarations after builtin, noglob, - and nocorrect, [bug]: a declaration after builtin, noglob, - or nocorrect is missed by the declaration rules zsh-lint#688; the subscript advice of quoting/unquoted-var, [bug]: quoting/unquoted-var gives array advice for a single subscripted element zsh-lint#747) beyond what the rule reference covers, so no rule text changes here. The print -r -- $name example keeps its scalar message.

Verification

Verified commit: the head of this pull request, based on main at 889ec9dfb0cea5a587e9ea5fb125a3fe519a5a6b.

  • Each v1.6.1 statement was checked against binaries installed with go install ...@v1.6.1 (module v1.6.1, the tag commit 136df81) and the v1.6.1 go.mod (go 1.27.0). With those binaries: -h and --help print usage to standard output and exit 0, also for zsh-lint mcp; no arguments print the usage line to standard error and exit 2; the hello.zsh example is clean; print -r -- $name on line 4 reports hello.zsh:4:13: [quoting/unquoted-var] Variable expansion should be double-quoted at Info with exit 0 under a project configuration and nothing without one; a directory argument and - are rejected; zsh-lint-survey prints OK <file> lines and 2 file(s) surveyed, 2 ok, 0 failed.
  • Passed: node scripts/validate-frontmatter.mjs, node scripts/validate-code-fences.mjs, no-fix Trunk on the six changed pages, and git diff --check.
  • Not run locally: a full Docusaurus build. The Cloudflare Pages preview build on this pull request compiles the pages.

Agent handoff

No handoff needed.

Move the install commands and current-release statements of the Zsh Lint
guide to v1.6.1. Release-history statements keep their versions, and the
generated rule reference stays with the release sync.

Closes #949
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: 442f22f
Status: ✅  Deploy successful!
Preview URL: https://1071f6f6.zsh.pages.dev
Branch Preview URL: https://feature-949-zsh-lint-guide.zsh.pages.dev

View logs

@ss-o ss-o moved this to In Review in Z-shell Delivery Oct 25, 2026

@ss-o ss-o left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fallback review under ADR-0026: Copilot request not registered on 442f22f

Sole-maintainer exception

The maintainer elected the ADR-0035 sole-maintainer exception for this pull request at head 442f22f. No second human reviewer is available, and the configured Copilot request on this head did not register (requested 2026-10-25T00:42:22Z, no review_requested event for Copilot; cause unconfirmed). A new head voids this election and this review.

Findings

No actionable findings.

Scope: the complete diff from main at 889ec9d, the head's only parent, to 442f22f: 11 version statements in index.mdx, 01_getting_started.mdx, 02_choosing_files.mdx, 05_ci_and_json.mdx, 06_troubleshooting.mdx and 07_parser_survey.mdx under community/04_zsh_lint/, against the acceptance criteria of #949.

Note

This fallback review and the exact-head review below are not a human review or an approval to merge.

Exact-head read-only review

A read-only exact-head review of this commit, in its own reviewing session using the organization code-review skill and checklist, reported no actionable findings. Its evidence:

  • Every changed v1.6.1 statement traces to the v1.6.1 source: help handling in cmd/zsh-lint/main.go and mcp.go, explicit file arguments with no directory, extension, shebang or standard-input handling, configuration discovery, and the configured-only Info scope of quoting/unquoted-var in internal/rules/unquoted_var.go. go.mod requires Go 1.27.0, as the guide and the CI example say.
  • With the installed v1.6.1 binary and a survey binary built from the v1.6.1 source: --help, -h and mcp --help exit 0 on standard output; no arguments exit 2 with the usage line on standard error; the configured print -r -- $name example reports hello.zsh:4:13: [quoting/unquoted-var] Variable expansion should be double-quoted at Info with exit 0, and nothing without configuration; a directory and - are rejected; the survey prints the documented OK lines and summary.
  • A search of the whole guide finds one remaining v1.6.0, in 06_troubleshooting.mdx, which describes help behaviour before that release; the v1.1.0, v1.2.0 and v1.3.0 history in 03_project_configuration.mdx and 06_troubleshooting.mdx is kept.
  • The guide pages do not describe the declaration and subscript-advice fixes of v1.6.1; the rule reference updated by #950 does, so no rule text needed to change here.

Validation

  • Passed on the head: all 12 pull-request checks, including Branch Name, Issue Link, PR Title, Commits, Trunk Code Quality, CodeQL, Org Routing, Validate Corpus and the Cloudflare Pages preview build. No review threads are open.
  • Reproduced for this review: the binary probes above with the same results, node scripts/validate-frontmatter.mjs, node scripts/validate-code-fences.mjs, no-fix Trunk on the six pages and git diff --check.
  • Unavailable: a local Docusaurus build and rendered-page inspection at desktop and narrow widths; the Cloudflare Pages preview build is the build evidence.
Checklist verdicts and supporting evidence
  • Accuracy: pass. Each statement now naming v1.6.1 matches the v1.6.1 source and the binary runs above.
  • Acceptance criteria: pass. Install commands and current-release statements name v1.6.1; release-history statements keep their versions; the generated 08_rule_reference.mdx is untouched; the change follows the published release (z-shell/zsh-lint#751).
  • Scope: pass. Only six guide pages under community/04_zsh_lint/ change; no configuration, component, localization or other content root.
  • MDX validity and navigation: pass. Frontmatter keeps id, title, sidebar_position, description and keywords; changed text is plain prose or existing typed code fences; links, headings and routes are unchanged.
  • Security and supply chain: pass. Exact module versions replace exact module versions; the CI example keeps its SHA-pinned actions and read-only permissions.
  • Deployment: pass. A merge to main runs the production build and publishes to Cloudflare Pages only after the build succeeds.
  • Traceability: pass. The body and commit close #949.

Limits and recovery

  • Unavailable: a local Docusaurus build and rendered-page inspection; the preview build compiled the pages.
  • Recovery: if a deployed page is wrong after merge, revert the squash commit on main; the previous guide text returns with the next successful build and deployment.
  • Deployment is verified on the merged main commit, separately from this review.

@ss-o
ss-o merged commit 1b5ae83 into main Oct 25, 2026
12 checks passed
@ss-o
ss-o deleted the feature-949-zsh-lint-guide branch October 25, 2026 01:03
@github-project-automation github-project-automation Bot moved this from In Review to Done in Z-shell Delivery Oct 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[docs]: update the Zsh Lint guide for v1.6.1

1 participant