7x31
/
shellcheck
mirror of https://github.com/koalaman/shellcheck.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Update Copyright to year 2019 and Markdown linting 

- [x] 📝 Update Copyright to year 2019

- [x] 📝 MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1]
- [x] 📝 MD034/no-bare-urls: Bare URL used

- [ ] 📝 ~MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]~
- [ ] ~add missing TOC entries~
This commit is contained in:
Virgil 2019-05-14 02:32:02 +10:00
parent 5fb1da6814
commit ea05271fa3
18 changed files with 50 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -8,46 +8,45 @@ ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell
The goals of ShellCheck are 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 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. 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. 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! 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](#table-of-contents) * [How to use](#how-to-use)
- [How to use](#how-to-use) * [On the web](#on-the-web)
- [On the web](#on-the-web) * [From your terminal](#from-your-terminal)
- [From your terminal](#from-your-terminal) * [In your editor](#in-your-editor)
- [In your editor](#in-your-editor) * [In your build or test suites](#in-your-build-or-test-suites)
- [In your build or test suites](#in-your-build-or-test-suites) * [Installing](#installing)
- [Installing](#installing) * [Compiling from source](#compiling-from-source)
- [Compiling from source](#compiling-from-source) * [Installing Cabal](#installing-cabal)
- [Installing Cabal](#installing-cabal) * [Compiling ShellCheck](#compiling-shellcheck)
- [Compiling ShellCheck](#compiling-shellcheck) * [Running tests](#running-tests)
- [Running tests](#running-tests) * [Gallery of bad code](#gallery-of-bad-code)
- [Gallery of bad code](#gallery-of-bad-code) * [Quoting](#quoting)
- [Quoting](#quoting) * [Conditionals](#conditionals)
- [Conditionals](#conditionals) * [Frequently misused commands](#frequently-misused-commands)
- [Frequently misused commands](#frequently-misused-commands) * [Common beginner's mistakes](#common-beginners-mistakes)
- [Common beginner's mistakes](#common-beginners-mistakes) * [Style](#style)
- [Style](#style) * [Data and typing errors](#data-and-typing-errors)
- [Data and typing errors](#data-and-typing-errors) * [Robustness](#robustness)
- [Robustness](#robustness) * [Portability](#portability)
- [Portability](#portability) * [Miscellaneous](#miscellaneous)
- [Miscellaneous](#miscellaneous) * [Testimonials](#testimonials)
- [Testimonials](#testimonials) * [Ignoring issues](#ignoring-issues)
- [Ignoring issues](#ignoring-issues) * [Reporting bugs](#reporting-bugs)
- [Reporting bugs](#reporting-bugs) * [Contributing](#contributing)
- [Contributing](#contributing) * [Copyright](#copyright)
- [Copyright](#copyright) * [Other Resources](#other-resources)
- [Other Resources](#other-resources)
## How to use ## How to use
@ -101,7 +100,7 @@ or in a Travis CI `.travis.yml` file:
```yaml ```yaml
script: script:
# Fail if any of these files have warnings # 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: Services and platforms that have ShellCheck pre-installed and ready to use:
@ -179,7 +178,7 @@ On openSUSE
zypper in ShellCheck zypper in ShellCheck
Or use OneClickInstall - https://software.opensuse.org/package/ShellCheck Or use OneClickInstall - <https://software.opensuse.org/package/ShellCheck>
On Solus: 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 brew cask install haskell-platform
cabal install cabal-install 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 <https://www.haskell.org/platform/>
Verify that `cabal` is installed and update its dependency list with 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). 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! Happy ShellChecking!

2
shellcheck.1.md
View File

@ -294,7 +294,7 @@ Bugs and issues can be reported on GitHub:
https://github.com/koalaman/shellcheck/issues https://github.com/koalaman/shellcheck/issues
# COPYRIGHT # COPYRIGHT
Copyright 2012-2015, Vidar Holen. Copyright 2012-2019, Vidar Holen.
Licensed under the GNU General Public License version 3 or later, Licensed under the GNU General Public License version 3 or later,
see https://gnu.org/licenses/gpl.html see https://gnu.org/licenses/gpl.html

2
shellcheck.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/AST.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/ASTLib.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Analytics.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Analyzer.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/AnalyzerLib.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Checker.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Checks/Commands.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Formatter/CheckStyle.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Formatter/Format.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Formatter/GCC.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Formatter/JSON.hs
View File

@ -1,6 +1,6 @@
{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE OverloadedStrings #-}
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Formatter/TTY.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Interface.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Parser.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net

2
src/ShellCheck/Regex.hs
View File

@ -1,5 +1,5 @@
{- {-
Copyright 2012-2015 Vidar Holen Copyright 2012-2019 Vidar Holen
This file is part of ShellCheck. This file is part of ShellCheck.
https://www.shellcheck.net https://www.shellcheck.net