Skip to content

Add shellcheck to pre-commit and devcontainers #8287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trxcllnt wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add shellcheck to pre-commit and devcontainers #8287

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
960d844
add .shellcheckrc and add shellcheck to .pre-commit-config.yaml
trxcllnt Apr 2, 2026
0b2e136
add shellcheck plugin to devcontainers
trxcllnt Apr 2, 2026
2af95e2
fix shellcheck lint
trxcllnt Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ repos:
exclude_types: [python]
- id: check-yaml

- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.11.0.1
hooks:
- id: shellcheck
exclude: |
(?x)^(
^.*libcudacxx/cmake/config\.guess$
Copy link
Copy Markdown
Member

@gonidelis gonidelis Apr 6, 2026

Choose a reason for hiding this comment

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

why do we exclude this specific cmake facility? in case shellcheck confused it as shell script we can add a comment about it still

Copy link
Copy Markdown
Contributor

@Jacobfaib Jacobfaib Apr 6, 2026

Choose a reason for hiding this comment

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

Shellcheck recognizes it as a shell script (from the shebang), but it's vendored so we shouldn't touch it.

)
- repo: https://github.com/pre-commit/mirrors-clang-format
rev: v20.1.7
Expand Down
20 changes: 20 additions & 0 deletions .shellcheckrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# -*- conf -*-
enable=all
color=never
external-sources=true
severity=style
source-path=SCRIPTDIR
# Consider invoking this command separately to avoid masking its return value (or use '||
# true' to ignore).
#
# This just clutters up the code. We usually have `set -eo pipefail` enabled.
disable=SC2312
# This function is invoked in an 'if' condition so set -e will be disabled. Invoke
# separately if failures should cause the script to exit.
#
# We don't want to exit if errors happen inside an if, that's why we have the if
# statement...
disable=SC2310
# Don't suggest putting braces around all variable references
disable=SC2250
shell=bash