From ea05271fa33966c749bb516dd65365b36ba1a88c Mon Sep 17 00:00:00 2001 From: Virgil Date: Tue, 14 May 2019 02:32:02 +1000 Subject: [PATCH 1/2] :memo: Update Copyright to year 2019 and Markdown linting - [x] :memo: Update Copyright to year 2019 - [x] :pencil: MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1] - [x] :pencil: MD034/no-bare-urls: Bare URL used - [ ] :pencil: ~MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]~ - [ ] ~add missing TOC entries~ --- README.md | 67 +++++++++++++------------- shellcheck.1.md | 2 +- shellcheck.hs | 2 +- src/ShellCheck/AST.hs | 2 +- src/ShellCheck/ASTLib.hs | 2 +- src/ShellCheck/Analytics.hs | 2 +- src/ShellCheck/Analyzer.hs | 2 +- src/ShellCheck/AnalyzerLib.hs | 2 +- src/ShellCheck/Checker.hs | 2 +- src/ShellCheck/Checks/Commands.hs | 2 +- src/ShellCheck/Formatter/CheckStyle.hs | 2 +- src/ShellCheck/Formatter/Format.hs | 2 +- src/ShellCheck/Formatter/GCC.hs | 2 +- src/ShellCheck/Formatter/JSON.hs | 2 +- src/ShellCheck/Formatter/TTY.hs | 2 +- src/ShellCheck/Interface.hs | 2 +- src/ShellCheck/Parser.hs | 2 +- src/ShellCheck/Regex.hs | 2 +- 18 files changed, 50 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index a88aa31..541c790 100644 --- a/README.md +++ b/README.md @@ -8,46 +8,45 @@ ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell The goals of ShellCheck are -- To point out and clarify typical beginner's syntax issues that cause a shell +* To point out and clarify typical beginner's syntax issues that cause a shell to give cryptic error messages. -- To point out and clarify typical intermediate level semantic problems that +* To point out and clarify typical intermediate level semantic problems that cause a shell to behave strangely and counter-intuitively. -- To point out subtle caveats, corner cases and pitfalls that may cause an +* To point out subtle caveats, corner cases and pitfalls that may cause an advanced user's otherwise working script to fail under future circumstances. See [the gallery of bad code](README.md#user-content-gallery-of-bad-code) for examples of what ShellCheck can help you identify! ## Table of Contents -- [Table of Contents](#table-of-contents) -- [How to use](#how-to-use) - - [On the web](#on-the-web) - - [From your terminal](#from-your-terminal) - - [In your editor](#in-your-editor) - - [In your build or test suites](#in-your-build-or-test-suites) -- [Installing](#installing) -- [Compiling from source](#compiling-from-source) - - [Installing Cabal](#installing-cabal) - - [Compiling ShellCheck](#compiling-shellcheck) - - [Running tests](#running-tests) -- [Gallery of bad code](#gallery-of-bad-code) - - [Quoting](#quoting) - - [Conditionals](#conditionals) - - [Frequently misused commands](#frequently-misused-commands) - - [Common beginner's mistakes](#common-beginners-mistakes) - - [Style](#style) - - [Data and typing errors](#data-and-typing-errors) - - [Robustness](#robustness) - - [Portability](#portability) - - [Miscellaneous](#miscellaneous) -- [Testimonials](#testimonials) -- [Ignoring issues](#ignoring-issues) -- [Reporting bugs](#reporting-bugs) -- [Contributing](#contributing) -- [Copyright](#copyright) -- [Other Resources](#other-resources) +* [How to use](#how-to-use) + * [On the web](#on-the-web) + * [From your terminal](#from-your-terminal) + * [In your editor](#in-your-editor) + * [In your build or test suites](#in-your-build-or-test-suites) +* [Installing](#installing) +* [Compiling from source](#compiling-from-source) + * [Installing Cabal](#installing-cabal) + * [Compiling ShellCheck](#compiling-shellcheck) + * [Running tests](#running-tests) +* [Gallery of bad code](#gallery-of-bad-code) + * [Quoting](#quoting) + * [Conditionals](#conditionals) + * [Frequently misused commands](#frequently-misused-commands) + * [Common beginner's mistakes](#common-beginners-mistakes) + * [Style](#style) + * [Data and typing errors](#data-and-typing-errors) + * [Robustness](#robustness) + * [Portability](#portability) + * [Miscellaneous](#miscellaneous) +* [Testimonials](#testimonials) +* [Ignoring issues](#ignoring-issues) +* [Reporting bugs](#reporting-bugs) +* [Contributing](#contributing) +* [Copyright](#copyright) +* [Other Resources](#other-resources) ## How to use @@ -101,7 +100,7 @@ or in a Travis CI `.travis.yml` file: ```yaml script: # Fail if any of these files have warnings - - shellcheck myscripts/*.sh + * shellcheck myscripts/*.sh ``` Services and platforms that have ShellCheck pre-installed and ready to use: @@ -179,7 +178,7 @@ On openSUSE zypper in ShellCheck -Or use OneClickInstall - https://software.opensuse.org/package/ShellCheck +Or use OneClickInstall - On Solus: @@ -262,7 +261,7 @@ On MacOS (OS X), you can do a fast install of Cabal using brew, which takes a co brew cask install haskell-platform cabal install cabal-install -On MacPorts, the package is instead called `hs-cabal-install`, while native Windows users should install the latest version of the Haskell platform from https://www.haskell.org/platform/ +On MacPorts, the package is instead called `hs-cabal-install`, while native Windows users should install the latest version of the Haskell platform from Verify that `cabal` is installed and update its dependency list with @@ -505,7 +504,7 @@ The contributor retains the copyright. ShellCheck is licensed under the GNU General Public License, v3. A copy of this license is included in the file [LICENSE](LICENSE). -Copyright 2012-2018, Vidar 'koala_man' Holen and contributors. +Copyright 2012-2019, [Vidar 'koala_man' Holen](https://github.com/koalaman/) and contributors. Happy ShellChecking! diff --git a/shellcheck.1.md b/shellcheck.1.md index f8cbd44..1612526 100644 --- a/shellcheck.1.md +++ b/shellcheck.1.md @@ -294,7 +294,7 @@ Bugs and issues can be reported on GitHub: https://github.com/koalaman/shellcheck/issues # COPYRIGHT -Copyright 2012-2015, Vidar Holen. +Copyright 2012-2019, Vidar Holen. Licensed under the GNU General Public License version 3 or later, see https://gnu.org/licenses/gpl.html diff --git a/shellcheck.hs b/shellcheck.hs index c8ea7fb..bef4101 100644 --- a/shellcheck.hs +++ b/shellcheck.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/AST.hs b/src/ShellCheck/AST.hs index 5b4254f..1459ca6 100644 --- a/src/ShellCheck/AST.hs +++ b/src/ShellCheck/AST.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/ASTLib.hs b/src/ShellCheck/ASTLib.hs index 7e8023e..d264d02 100644 --- a/src/ShellCheck/ASTLib.hs +++ b/src/ShellCheck/ASTLib.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Analytics.hs b/src/ShellCheck/Analytics.hs index ac8fcdb..7926b53 100644 --- a/src/ShellCheck/Analytics.hs +++ b/src/ShellCheck/Analytics.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Analyzer.hs b/src/ShellCheck/Analyzer.hs index 442daba..01440d8 100644 --- a/src/ShellCheck/Analyzer.hs +++ b/src/ShellCheck/Analyzer.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/AnalyzerLib.hs b/src/ShellCheck/AnalyzerLib.hs index 5783820..6142475 100644 --- a/src/ShellCheck/AnalyzerLib.hs +++ b/src/ShellCheck/AnalyzerLib.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Checker.hs b/src/ShellCheck/Checker.hs index a231242..2ea950d 100644 --- a/src/ShellCheck/Checker.hs +++ b/src/ShellCheck/Checker.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Checks/Commands.hs b/src/ShellCheck/Checks/Commands.hs index 346d880..f9f38ea 100644 --- a/src/ShellCheck/Checks/Commands.hs +++ b/src/ShellCheck/Checks/Commands.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Formatter/CheckStyle.hs b/src/ShellCheck/Formatter/CheckStyle.hs index b3f2074..f3fea88 100644 --- a/src/ShellCheck/Formatter/CheckStyle.hs +++ b/src/ShellCheck/Formatter/CheckStyle.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Formatter/Format.hs b/src/ShellCheck/Formatter/Format.hs index 57b9d71..61c5025 100644 --- a/src/ShellCheck/Formatter/Format.hs +++ b/src/ShellCheck/Formatter/Format.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Formatter/GCC.hs b/src/ShellCheck/Formatter/GCC.hs index b8a0bb0..9c5fa5f 100644 --- a/src/ShellCheck/Formatter/GCC.hs +++ b/src/ShellCheck/Formatter/GCC.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Formatter/JSON.hs b/src/ShellCheck/Formatter/JSON.hs index 02a549d..0c3185b 100644 --- a/src/ShellCheck/Formatter/JSON.hs +++ b/src/ShellCheck/Formatter/JSON.hs @@ -1,6 +1,6 @@ {-# LANGUAGE OverloadedStrings #-} {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Formatter/TTY.hs b/src/ShellCheck/Formatter/TTY.hs index c0d5841..845feeb 100644 --- a/src/ShellCheck/Formatter/TTY.hs +++ b/src/ShellCheck/Formatter/TTY.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Interface.hs b/src/ShellCheck/Interface.hs index e60433e..aa12fc2 100644 --- a/src/ShellCheck/Interface.hs +++ b/src/ShellCheck/Interface.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Parser.hs b/src/ShellCheck/Parser.hs index a403bea..5f41c90 100644 --- a/src/ShellCheck/Parser.hs +++ b/src/ShellCheck/Parser.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net diff --git a/src/ShellCheck/Regex.hs b/src/ShellCheck/Regex.hs index f1262b4..9367ee7 100644 --- a/src/ShellCheck/Regex.hs +++ b/src/ShellCheck/Regex.hs @@ -1,5 +1,5 @@ {- - Copyright 2012-2015 Vidar Holen + Copyright 2012-2019 Vidar Holen This file is part of ShellCheck. https://www.shellcheck.net From f5892f2d0d77296d1deebd404204a5014b29d3d8 Mon Sep 17 00:00:00 2001 From: Virgil Date: Fri, 17 May 2019 07:41:12 +1000 Subject: [PATCH 2/2] (docs)Fix typo in yaml markdown Was aligned as per TOC 2nd. Reverted to - --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 541c790..6b789cd 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ or in a Travis CI `.travis.yml` file: ```yaml script: # Fail if any of these files have warnings - * shellcheck myscripts/*.sh + - shellcheck myscripts/*.sh ``` Services and platforms that have ShellCheck pre-installed and ready to use: