README
¶
Zsh Lint
A standalone Go-based semantic analyzer for Zsh (see #5). It parses Zsh scripts and reports greppable static-analysis diagnostics.
📖 Canonical docs live on the Z-Shell Wiki: wiki.zshell.dev — Zsh Lint
For repo-local pointers and the contributor quickstart, see
docs/README.md.
License
Copyright (c) 2021 Z-Shell Community. Licensed under the GPL-3.0 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
wikidoc
command
Command wikidoc is a CI/dev tool (not product code) that reads a gomarkdoc-generated Markdown file, sanitizes it for MDX compatibility, and injects the result into a marked region of a Docusaurus .mdx page in place.
|
Command wikidoc is a CI/dev tool (not product code) that reads a gomarkdoc-generated Markdown file, sanitizes it for MDX compatibility, and injects the result into a marked region of a Docusaurus .mdx page in place. |
|
zsh-lint
command
Command zsh-lint performs static analysis of Zsh shell scripts.
|
Command zsh-lint performs static analysis of Zsh shell scripts. |
|
zsh-lint-survey
command
Command zsh-lint-survey runs the parser front end across Zsh files and reports parser gaps without evaluating static-analysis rules.
|
Command zsh-lint-survey runs the parser front end across Zsh files and reports parser gaps without evaluating static-analysis rules. |
|
internal
|
|
|
diag
Package diag defines the renderer-agnostic, parser-neutral diagnostics model shared by zsh-lint's analyzer: rule identity, severity, message, and source range.
|
Package diag defines the renderer-agnostic, parser-neutral diagnostics model shared by zsh-lint's analyzer: rule identity, severity, message, and source range. |
|
parse
Package parse wraps the mvdan.cc/sh parser as the analyzer's front end.
|
Package parse wraps the mvdan.cc/sh parser as the analyzer's front end. |
|
projectconfig
Package projectconfig loads and resolves explicit zsh-lint project metadata.
|
Package projectconfig loads and resolves explicit zsh-lint project metadata. |
|
suppress
Package suppress implements the inline suppression contract defined in docs/project/suppression.md (#19, implemented under #65).
|
Package suppress implements the inline suppression contract defined in docs/project/suppression.md (#19, implemented under #65). |
|
survey
Package survey runs the parser front end across a set of Zsh files and reports, per file, whether parsing succeeded.
|
Package survey runs the parser front end across a set of Zsh files and reports, per file, whether parsing succeeded. |
|
wikidoc
Package wikidoc transforms gomarkdoc-generated Markdown into MDX-safe content and injects it into a marked region of a Docusaurus .mdx page.
|
Package wikidoc transforms gomarkdoc-generated Markdown into MDX-safe content and injects it into a marked region of a Docusaurus .mdx page. |
Click to show internal directories.
Click to hide internal directories.