Question 1

How to ignore a specific ShellCheck warning in my script?

Accepted Answer

You can disable warnings using directives in the script (e.g., # shellcheck disable=SC2034), command-line flags, or environment variables. Detailed ignore methods are documented on the project's wiki.

Question 2

ShellCheck vs shfmt: which one should I use?

Accepted Answer

ShellCheck is a linter that finds bugs and issues, while shfmt is a formatter that handles code style and indentation. They are complementary; use ShellCheck for correctness and shfmt for consistency in formatting.

Question 3

How to install ShellCheck on macOS without Homebrew?

Accepted Answer

You can use MacPorts ('sudo port install shellcheck'), download pre-compiled binaries from GitHub releases, or run it via Docker. The README lists all installation options for different platforms.

Question 4

Does ShellCheck work with zsh scripts?

Accepted Answer

ShellCheck is optimized for bash and sh; it may catch some issues in zsh but isn't designed for zsh-specific features and could miss relevant warnings or produce false positives.

Question 5

How to run ShellCheck on all shell files in a directory recursively?

Accepted Answer

Use a command like 'shellcheck **/*.sh' with globstar enabled in bash, or combine with find: 'find . -name "*.sh" -exec shellcheck {} +'. This ensures all scripts are checked in one go.

Question 6

Can ShellCheck be used in a pre-commit hook?

Accepted Answer

Yes, a pre-commit hook is available; add the configuration from the README to your .pre-commit-config.yaml to automatically lint scripts before commits, helping catch issues early.

shellcheck

What is shellcheck?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions