Blame: ShellCheck.cabal - koalaman/shellcheck

ShellCheck, a static analysis tool for shell scripts

39175 0 1 Haskell

Initial Cabal file 2013-06-18 09:29:39 -07:00			`Name: ShellCheck`
Stable version v0.11.0 This release is dedicated to Satisfactory, even though my giant 3D ball of rat's nest conveyor belt spaghetti is anything but. CHANGELOG ## v0.11.0 - 2025-08-03 ### Added - SC2327/SC2328: Warn about capturing the output of redirected commands. - SC2329: Warn when (non-escaping) functions are never invoked. - SC2330: Warn about unsupported glob matches with [[ .. ]] in BusyBox. - SC2331: Suggest using standard -e instead of unary -a in tests. - SC2332: Warn about `[ ! -o opt ]` being unconditionally true in Bash. - SC3062: Warn about bashism `[ -o opt ]`. - Optional `avoid-negated-conditions`: suggest replacing `[ ! a -eq b ]` with `[ a -ne b ]`, and similar for -ge/-lt/=/!=/etc (SC2335). - Precompiled binaries for Linux riscv64 (linux.riscv64) ### Changed - SC2002 about Useless Use Of Cat is now disabled by default. It can be re-enabled with `--enable=useless-use-of-cat` or equivalent directive. - SC2236/SC2237 about replacing `[ ! -n .. ]` with `[ -z ]` and vice versa is now optional under `avoid-negated-conditions`. - SC2015 about `A && B \|\| C` no longer triggers when B is a test command. - SC3012: Do not warn about `\<` and `\>` in test/[] as specified in POSIX.1-2024 - Diff output now uses / as path separator on Windows ### Fixed - SC2218 about function use-before-define is now more accurate. - SC2317 about unreachable commands is now less spammy for nested ones. - SC2292, optional suggestion for [[ ]], now triggers for Busybox. - Updates for Bash 5.3, including `${\| cmd; }` and `source -p` ### Removed - SC3013: removed since the operators `-ot/-nt/-ef` are specified in POSIX.1-2024 2025-08-03 16:19:11 -07:00			`Version: 0.11.0`
expanded cabal file 2014-01-13 19:14:18 -08:00			`Synopsis: Shell script analysis tool`
Relicense from AGPL v3 to GPL v3. 2015-06-20 09:52:07 -07:00			`License: GPL-3`
Initial Cabal file 2013-06-18 09:29:39 -07:00			`License-file: LICENSE`
Cleaned up cabal file to make 'cabal check' pass. 2014-01-19 13:03:05 -08:00			`Category: Static Analysis`
Initial Cabal file 2013-06-18 09:29:39 -07:00			`Author: Vidar Holen`
			`Maintainer: vidar@vidarholen.net`
convert http:// URIs to https:// Also update the ShellCheck homepage to the new dedicated domain. 2017-12-14 01:06:43 -05:00			`Homepage: https://www.shellcheck.net/`
Support Cabal 3. Man page no longer autobuilds. 2019-11-16 10:44:48 -08:00			`Build-Type: Simple`
move readme to extra-doc-files and add changelog to releases 2021-05-18 11:06:12 +08:00			`Cabal-Version: 1.18`
expanded cabal file 2014-01-13 19:14:18 -08:00			`Bug-reports: https://github.com/koalaman/shellcheck/issues`
			`Description:`
			`The goals of ShellCheck are:`
			`.`
			`* To point out and clarify typical beginner's syntax issues,`
			`that causes a shell to give cryptic error messages.`
			`.`
			`* To point out and clarify typical intermediate level semantic problems,`
			`that causes a shell to behave strangely and counter-intuitively.`
			`.`
			`* To point out subtle caveats, corner cases and pitfalls, that may cause an`
			`advanced user's otherwise working script to fail under future circumstances.`

Add latest/lts Ubuntu GHC releases to CI 2026-03-11 19:47:56 -07:00			`tested-with: GHC == 8.0, GHC == 8.10, GHC == 9.0.1, GHC == 9.4.7, GHC == 9.6.6`
chore(cabal): add tested-with field 2026-02-09 13:16:26 +09:00
move readme to extra-doc-files and add changelog to releases 2021-05-18 11:06:12 +08:00			`Extra-Doc-Files:`
			`README.md`
			`CHANGELOG.md`
Add extra source files in the source tarball This way ShellCheck can be entirely built (including the test suite) from the Hackage tarball. The source tarball can be generated using: cabal sdist 2014-06-01 17:53:16 +02:00			`Extra-Source-Files:`
			`-- documentation`
			`shellcheck.1.md`
Support Cabal 3. Man page no longer autobuilds. 2019-11-16 10:44:48 -08:00			`-- A script to build the man page using pandoc`
			`manpage`
Add 'striptests' script to Cabal package 2018-12-02 18:40:56 -08:00			`-- convenience script for stripping tests`
			`striptests`
Add extra source files in the source tarball This way ShellCheck can be entirely built (including the test suite) from the Hackage tarball. The source tarball can be generated using: cabal sdist 2014-06-01 17:53:16 +02:00			`-- tests`
Updated Extra-Source-Files accordingly with #165 2014-06-01 21:35:45 +02:00			`test/shellcheck.hs`
Add extra source files in the source tarball This way ShellCheck can be entirely built (including the test suite) from the Hackage tarball. The source tarball can be generated using: cabal sdist 2014-06-01 17:53:16 +02:00
expanded cabal file 2014-01-13 19:14:18 -08:00			`source-repository head`
			`type: git`
Use https:// for source-repository With Cabal >= 3.14, `cabal test` warns: ``` Warning: [git-protocol] Cloning over git:// might lead to an arbitrary code execution vulnerability. Furthermore, popular forges like GitHub do not support it. Use https:// or ssh:// instead. ``` https:// should work fine, so use that as suggested. 2025-09-30 18:49:48 +01:00			`location: https://github.com/koalaman/shellcheck.git`
Initial Cabal file 2013-06-18 09:29:39 -07:00
			`library`
Move library into src/ 2018-03-08 19:57:40 +02:00			`hs-source-dirs: src`
bump to latest ghc 2018-04-02 11:44:18 -05:00			`if impl(ghc < 8.0)`
			`build-depends:`
			`semigroups`
Reformat ShellCheck.cabal for readability Uses one line per `build-depends' or `exposed-modules'. Also got them sorted by name. Folded `base' dependencies into a single one. 2014-02-28 19:44:09 +01:00			`build-depends:`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`-- The lower bounds are based on GHC 7.10.3`
Update dependencies 2025-07-22 14:40:25 -07:00			`-- The upper bounds are based on GHC 9.12.1`
Adjust bounds to compile on 9.8 You'll need --allow-newer=fgl:deepseq for it to work too, until haskell/fgl#111 gets merged. 2023-10-14 18:12:51 -04:00			`aeson >= 1.4.0 && < 2.3,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`array >= 0.5.1 && < 0.6,`
			`base >= 4.8.0.0 && < 5,`
Adjust bounds to compile on 9.8 You'll need --allow-newer=fgl:deepseq for it to work too, until haskell/fgl#111 gets merged. 2023-10-14 18:12:51 -04:00			`bytestring >= 0.10.6 && < 0.13,`
Update dependencies 2025-07-22 14:40:25 -07:00			`containers >= 0.5.6 && < 0.9,`
build: bump deepseq minimum version and remove workaround 2026-02-07 20:06:17 +09:00			`deepseq >= 1.4.2 && < 1.6,`
Update Diff dependency (fixes #3075) 2024-11-03 13:56:51 -08:00			`Diff >= 0.4.0 && < 1.1,`
Fix #2734: adjust bounds to compile on 9.6 The whole test suite passes for me, including prop_checkOverwrittenExitCode8, and I get the same set of findings with this build and shellcheck.net on tools/testing/selftests/net/icmp_redirect.sh. 2023-05-01 00:02:53 -04:00			`fgl (>= 5.7.0 && < 5.8.1.0) \|\| (>= 5.8.1.1 && < 5.9),`
Update filepath dependency 2024-11-03 14:19:08 -08:00			`filepath >= 1.4.0 && < 1.6,`
Fix #2734: adjust bounds to compile on 9.6 The whole test suite passes for me, including prop_checkOverwrittenExitCode8, and I get the same set of findings with this build and shellcheck.net on tools/testing/selftests/net/icmp_redirect.sh. 2023-05-01 00:02:53 -04:00			`mtl >= 2.2.2 && < 2.4,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`parsec >= 3.1.14 && < 3.2,`
allow QuickCheck-2.16 see also commercialhaskell/stackage#7787 2025-07-18 19:27:05 +08:00			`QuickCheck >= 2.14.2 && < 2.17,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`regex-tdfa >= 1.2.0 && < 1.4,`
Fix #2734: adjust bounds to compile on 9.6 The whole test suite passes for me, including prop_checkOverwrittenExitCode8, and I get the same set of findings with this build and shellcheck.net on tools/testing/selftests/net/icmp_redirect.sh. 2023-05-01 00:02:53 -04:00			`transformers >= 0.4.2 && < 0.7,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00
			`-- getXdgDirectory from 1.2.3.0`
			`directory >= 1.2.3 && < 1.4,`

Use system over callCommand to allow linking on ghc 7.6.3. 2016-01-13 14:10:21 -08:00			`-- When cabal supports it, move this to setup-depends:`
			`process`
Reformat ShellCheck.cabal for readability Uses one line per `build-depends' or `exposed-modules'. Also got them sorted by name. Folded `base' dependencies into a single one. 2014-02-28 19:44:09 +01:00			`exposed-modules:`
			`ShellCheck.AST`
Moved the various AST convenience functions to a separate module. 2015-08-16 12:53:23 -07:00			`ShellCheck.ASTLib`
Separated formatters into multiple files. 2015-08-15 12:51:13 -07:00			`ShellCheck.Analytics`
			`ShellCheck.Analyzer`
Separate out command specific checks. The checks use a better interface and give an overall speed boost of 10%. 2016-04-10 17:01:40 -07:00			`ShellCheck.AnalyzerLib`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`ShellCheck.CFG`
			`ShellCheck.CFGAnalysis`
Separated formatters into multiple files. 2015-08-15 12:51:13 -07:00			`ShellCheck.Checker`
Separate out command specific checks. The checks use a better interface and give an overall speed boost of 10%. 2016-04-10 17:01:40 -07:00			`ShellCheck.Checks.Commands`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`ShellCheck.Checks.ControlFlow`
Add an empty Custom.hs to simplify site-specific patching 2019-07-02 20:07:05 -07:00			`ShellCheck.Checks.Custom`
Some cleanup and refactoring. 2016-11-12 15:51:36 -08:00			`ShellCheck.Checks.ShellSupport`
Reformat ShellCheck.cabal for readability Uses one line per `build-depends' or `exposed-modules'. Also got them sorted by name. Folded `base' dependencies into a single one. 2014-02-28 19:44:09 +01:00			`ShellCheck.Data`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`ShellCheck.Debug`
Add ShellCheck.Fixer to the cabal file 2018-12-17 20:14:49 -08:00			`ShellCheck.Fixer`
Separated formatters into multiple files. 2015-08-15 12:51:13 -07:00			`ShellCheck.Formatter.Format`
Fixed the cabal file, which didn't include formatters :\| 2015-09-05 19:17:22 -07:00			`ShellCheck.Formatter.CheckStyle`
Add a Diff output format 2019-06-23 19:05:12 -07:00			`ShellCheck.Formatter.Diff`
Fixed the cabal file, which didn't include formatters :\| 2015-09-05 19:17:22 -07:00			`ShellCheck.Formatter.GCC`
			`ShellCheck.Formatter.JSON`
Add JSON1 as a separate format, wrap result in an object 2019-06-02 10:28:37 -07:00			`ShellCheck.Formatter.JSON1`
Fixed the cabal file, which didn't include formatters :\| 2015-09-05 19:17:22 -07:00			`ShellCheck.Formatter.TTY`
Issue 1393 quiet flag Issue https://github.com/koalaman/shellcheck/issues/1393 Provide '-q' and '--quiet' flags that suppress all normal output, but keep the return status, similar to 'grep -q'. 2019-01-18 19:21:17 -08:00			`ShellCheck.Formatter.Quiet`
Some cleanup to make room for future improvements. 2015-08-15 09:34:19 -07:00			`ShellCheck.Interface`
Separated formatters into multiple files. 2015-08-15 12:51:13 -07:00			`ShellCheck.Parser`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`ShellCheck.Prelude`
Switch from regex-compat to regex-tdfa 2015-04-04 16:26:28 -07:00			`ShellCheck.Regex`
Use version from generated cabal Paths module 2014-05-30 00:08:09 +00:00			`other-modules:`
			`Paths_ShellCheck`
build: bump to Haskell2010 2025-10-08 09:05:07 +09:00			`default-language: Haskell2010`
Initial Cabal file 2013-06-18 09:29:39 -07:00
			`executable shellcheck`
bump to latest ghc 2018-04-02 11:44:18 -05:00			`if impl(ghc < 8.0)`
			`build-depends:`
			`semigroups`
Make the executable depend on the library It needed a bump to 1.8 for the minimum `Cabal-Version'. One downside is that the executable also build-depends on the same libraries. Alphabetical order is kept, except for the dependency to the ShellCheck library itself. 2014-02-28 19:55:04 +01:00			`build-depends:`
Change to aeson (fixes #1085) Adds bytestring as a dependency for putStrLn encoded values. 2018-05-06 16:07:53 -07:00			`aeson,`
Process replacements according to AST depth (fixes #1431) 2019-01-08 17:22:39 -08:00			`array,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`base,`
Change to aeson (fixes #1085) Adds bytestring as a dependency for putStrLn encoded values. 2018-05-06 16:07:53 -07:00			`bytestring,`
Make the executable depend on the library It needed a bump to 1.8 for the minimum `Cabal-Version'. One downside is that the executable also build-depends on the same libraries. Alphabetical order is kept, except for the dependency to the ShellCheck library itself. 2014-02-28 19:55:04 +01:00			`containers,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`deepseq,`
			`Diff,`
			`directory,`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`fgl,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`mtl,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`filepath,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`parsec,`
			`QuickCheck,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`regex-tdfa,`
Add missing imports for later GHC versions 2022-12-10 10:46:49 -08:00			`transformers,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`ShellCheck`
build: bump to Haskell2010 2025-10-08 09:05:07 +09:00			`default-language: Haskell2010`
Initial Cabal file 2013-06-18 09:29:39 -07:00			`main-is: shellcheck.hs`
Use version from generated cabal Paths module 2014-05-30 00:08:09 +00:00
Test Suite in Cabal (cabal test) Please run using "cabal test --show-details=streaming", there's a known issue about this that was fixed in the latest version of cabal: https://github.com/haskell/cabal/issues/1810 2014-05-31 01:30:23 +00:00			`test-suite test-shellcheck`
			`type: exitcode-stdio-1.0`
			`build-depends:`
Change to aeson (fixes #1085) Adds bytestring as a dependency for putStrLn encoded values. 2018-05-06 16:07:53 -07:00			`aeson,`
Process replacements according to AST depth (fixes #1431) 2019-01-08 17:22:39 -08:00			`array,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`base,`
Change to aeson (fixes #1085) Adds bytestring as a dependency for putStrLn encoded values. 2018-05-06 16:07:53 -07:00			`bytestring,`
Test Suite in Cabal (cabal test) Please run using "cabal test --show-details=streaming", there's a known issue about this that was fixed in the latest version of cabal: https://github.com/haskell/cabal/issues/1810 2014-05-31 01:30:23 +00:00			`containers,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`deepseq,`
			`Diff,`
			`directory,`
Control Flow Graph / Data Flow Analysis support 2022-07-19 14:23:27 -07:00			`fgl,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`filepath,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`mtl,`
Test Suite in Cabal (cabal test) Please run using "cabal test --show-details=streaming", there's a known issue about this that was fixed in the latest version of cabal: https://github.com/haskell/cabal/issues/1810 2014-05-31 01:30:23 +00:00			`parsec,`
Tighten bounds on packages 2022-12-11 12:29:05 -08:00			`QuickCheck,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`regex-tdfa,`
Add missing imports for later GHC versions 2022-12-10 10:46:49 -08:00			`transformers,`
Add support for `.shellcheckrc` files 2019-03-03 18:53:43 -08:00			`ShellCheck`
build: bump to Haskell2010 2025-10-08 09:05:07 +09:00			`default-language: Haskell2010`
Test Suite in Cabal (cabal test) Please run using "cabal test --show-details=streaming", there's a known issue about this that was fixed in the latest version of cabal: https://github.com/haskell/cabal/issues/1810 2014-05-31 01:30:23 +00:00			`main-is: test/shellcheck.hs`