Repository navigation
docs(zsh-lint): update the guide for v1.6.1 - #951
Conversation
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
Deploying zsh with
|
| 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 |
ss-o
left a comment
There was a problem hiding this comment.
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.1statement traces to thev1.6.1source: help handling incmd/zsh-lint/main.goandmcp.go, explicit file arguments with no directory, extension, shebang or standard-input handling, configuration discovery, and the configured-only Info scope ofquoting/unquoted-varininternal/rules/unquoted_var.go.go.modrequires Go 1.27.0, as the guide and the CI example say. - With the installed
v1.6.1binary and a survey binary built from thev1.6.1source:--help,-handmcp --helpexit 0 on standard output; no arguments exit 2 with the usage line on standard error; the configuredprint -r -- $nameexample reportshello.zsh:4:13: [quoting/unquoted-var] Variable expansion should be double-quotedat Info with exit 0, and nothing without configuration; a directory and-are rejected; the survey prints the documentedOKlines and summary. - A search of the whole guide finds one remaining
v1.6.0, in06_troubleshooting.mdx, which describes help behaviour before that release; thev1.1.0,v1.2.0andv1.3.0history in03_project_configuration.mdxand06_troubleshooting.mdxis 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 andgit 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.1matches thev1.6.1source 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 generated08_rule_reference.mdxis 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
mainruns 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
maincommit, separately from this review.
Summary
Closes #949.
The Zsh Lint guide described
v1.6.0. This moves it to the publishedv1.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 tov1.6.1.zsh-lint(index, Getting started, CI and JSON) andzsh-lint-survey(Parser survey) use@v1.6.1.v1.6.1: the guide index, the Getting started description,--helpbehaviour, thequoting/unquoted-varscope, file-argument handling, and the published-CLI rule in Choosing files.--helpprinting an error beforev1.6.0,--configsincev1.2.0, and configuration discovery sincev1.3.0.v1.6.1(declarations afterbuiltin,noglob,-andnocorrect, [bug]: a declaration after builtin, noglob, - or nocorrect is missed by the declaration rules zsh-lint#688; the subscript advice ofquoting/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. Theprint -r -- $nameexample keeps its scalar message.Verification
Verified commit: the head of this pull request, based on
mainat889ec9dfb0cea5a587e9ea5fb125a3fe519a5a6b.v1.6.1statement was checked against binaries installed withgo install ...@v1.6.1(modulev1.6.1, the tag commit136df81) and thev1.6.1go.mod(go 1.27.0). With those binaries:-hand--helpprint usage to standard output and exit 0, also forzsh-lint mcp; no arguments print the usage line to standard error and exit 2; thehello.zshexample is clean;print -r -- $nameon line 4 reportshello.zsh:4:13: [quoting/unquoted-var] Variable expansion should be double-quotedat Info with exit 0 under a project configuration and nothing without one; a directory argument and-are rejected;zsh-lint-surveyprintsOK <file>lines and2 file(s) surveyed, 2 ok, 0 failed.node scripts/validate-frontmatter.mjs,node scripts/validate-code-fences.mjs, no-fix Trunk on the six changed pages, andgit diff --check.Agent handoff
No handoff needed.