zshellcheck

module
v0.0.94 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2025 License: MIT

README

ZShellCheck

zshellcheck is a static analysis tool (linter) specifically designed for Zsh scripts. Unlike shellcheck, which focuses on POSIX sh/bash compatibility, zshellcheck understands Zsh syntax, best practices, and common pitfalls.

It parses Zsh scripts into an Abstract Syntax Tree (AST) and runs a series of checks ("Katas") to identify issues.

Features

  • Zsh-Specific Parsing: Handles Zsh constructs like [[ ... ]], (( ... )), arrays, associative arrays, and modifiers.
  • Extensible Katas: Rules are implemented as independent "Katas" that can be easily added or disabled.
  • Configurable: Disable specific checks via .zshellcheckrc configuration file.
  • Integration Ready: Designed to work with pre-commit and CI pipelines.

Documentation

For comprehensive documentation, including detailed usage, configuration, and a full list of implemented Katas, please visit the GitHub Wiki.

Directories

Path Synopsis
cmd
zshellcheck command
pkg
ast

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL