lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-22 01:22:09 +02:00
Code Activity

shellcheck: edit page (#12491)

Browse source 
* shellcheck: edit page

* shellcheck: simplify description

* Update pages/common/shellcheck.md

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

* Update pages/common/shellcheck.md

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

* Update pages/common/shellcheck.md

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

---------

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
This commit is contained in:
Fazle Arefin 2024-03-13 03:52:57 +11:00 • committed by GitHub
parent f74eea3996
commit 21a0502972
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
pages/common/shellcheck.md
View file

@ -1,33 +1,36 @@
# shellcheck
> Shell script static analysis tool.
> Check shell scripts for errors, usage of deprecated/insecure features, and bad practices.
> More information: <https://www.shellcheck.net>.
> Statically check shell scripts for errors, usage of deprecated/insecure features, and bad practices.
> More information: <https://github.com/koalaman/shellcheck/wiki>.
- Check a shell script:
`shellcheck {{path/to/script.sh}}`
- Check a shell script interpreting it as the specified shell dialect (overrides the shebang at the top of the script):
- Check a shell script interpreting it as the specified [s]hell dialect (overrides the shebang at the top of the script):
`shellcheck --shell {{sh|bash|dash|ksh}} {{path/to/script.sh}}`
- Ignore one or more error types:
- Ignor[e] one or more error types:
`shellcheck --exclude {{SC1009,SC1073}} {{path/to/script.sh}}`
`shellcheck --exclude {{SC1009,SC1073,...}} {{path/to/script.sh}}`
- Also check any sourced shell scripts:
`shellcheck --check-sourced {{path/to/script.sh}}`
- Display output in the specified format (defaults to `tty`):
- Display output in the specified [f]ormat (defaults to `tty`):
`shellcheck --format {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}`
- Enable one or more optional checks:
- Enable one or more [o]ptional checks:
`shellcheck --enable={{add-default-case|avoid-nullary-conditions}}`
`shellcheck --enable {{add-default-case,avoid-nullary-conditions,...}} {{path/to/script.sh}}`
- List all available optional checks that are disabled by default:
`shellcheck --list-optional`
- Adjust the level of [S]everity to consider (defaults to `style`):
`shellcheck --severity {{error|warning|info|style}} {{path/to/script.sh}}`