Initial release, exposing a simple proxy script for ShellCheck

Author: stevegrunwell

.gitattributes

@@ -0,0 +1 @@
+.* export-ignore

.github/workflows/continuous-integration.yml

@@ -0,0 +1,24 @@
+name: CI Pipeline
+
+# Execute on pushes to develop or main, as well as all PRs.
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+
+jobs:
+
+  # Run ShellCheck against ShellCheck, pray we don't collapse the universe.
+  shellcheck:
+    name: Run ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Validate composer.json
+        run: composer validate
+
+      - name: Check coding standards
+        run: composer test

.gitignore

@@ -0,0 +1,4 @@
+composer.lock
+vendor
+
+*.DS_Store

LICENSE.md

@@ -0,0 +1,11 @@
+# License
+
+Copyright © 2022 AssertWell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ShellCheck is the copyright of Vidar Holden and made available under [the GPLv3 license](https://github.com/koalaman/shellcheck/blob/master/LICENSE).

README.md

@@ -0,0 +1,55 @@
+# ShellCheck
+
+[Vidar Holen's ShellCheck is an invaluable tool for troubleshooting shell scripts](https://www.shellcheck.net), and this package makes it easy to import into the testing pipeline of your PHP-based project!
+
+## How it works
+
+This package contains a `bin/shellcheck` script that serves as a proxy to the system-installed copy of ShellCheck; if the ShellCheck binary is found, arguments pass through to it normally. If ShellCheck is **not** found locally, users are presented with the following notice:
+
+> ShellCheck was not found in your $PATH!
+> Please visit https://github.com/koalaman/shellcheck#installing for installation instructions.
+
+Normally, this would result in a non-zero exit code (2), though this behavior may be suppressed with the `--ignore-missing` option:
+
+```none
+$ vendor/bin/shellcheck --ignore-missing some-script.sh
+
+ShellCheck was not found in your $PATH!
+Please visit https://github.com/koalaman/shellcheck#installing for installation instructions.
+
+$ echo $?
+0
+```
+
+## Installation
+
+The easiest way to install this package is via [Composer](https://getcomposer.org):
+
+```sh
+$ composer require --dev assertwell/shellcheck
+```
+
+You may wish to add a [Composer script](https://getcomposer.org/doc/articles/scripts.md) to make it easier for team members to run ShellCheck:
+
+```jsonc
+# composer.json
+{
+    // ...
+    "scripts": {
+        "test:shellcheck": [
+            "shellcheck bin/*"
+        ]
+    },
+    "scripts-descriptions": [
+        "test:shellcheck": "Lint shell scripts via ShellCheck"
+    ]
+}
+```
+
+As for the installation of ShellCheck itself, please [see the instructions most-relevant to your environment in the ShellCheck documentation](https://github.com/koalaman/shellcheck#installing).
+
+## License
+
+[The assertwell/shellcheck Composer package is available under the MIT license](LICENSE.md).
+
+ShellCheck itself is the copyright of Vidar Holden and made [available under the GPLv3 license](https://github.com/koalaman/shellcheck/blob/master/LICENSE).

bin/shellcheck

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+#
+# Locate ShellCheck in the current environment and pass it the given arguments.
+#
+# If ShellCheck is not found, provide instructions for how to install it in the given environment.
+#
+# To remain consistent with ShellCheck's exit codes, this script will exit with a code of 2 if
+# ShellCheck cannot be found locally (unless the `--ignore-missing` option is present).
+#
+# Reference: https://github.com/koalaman/shellcheck/wiki/Integration#exit-codes
+#
+# OPTIONS:
+#
+# Note: All options other than those listed below will be passed directly to the ShellCheck binary.
+#
+#   -i, --ignore-missing    Print a warning, but consider the script successful if a local instance
+#                           of ShellCheck could not be found.
+#
+# This script is part of the assertwell/shellcheck package.
+#
+# URL: https://github.com/assertwell/shellcheck
+# Author: Steve Grunwell
+# License: MIT
+
+declare -a args
+
+# Default exit code if ShellCheck cannot be found.
+exit_code=2
+
+# Look for any arguments specific to this script, and put everything else into $args.
+while [ $# -gt 0 ]; do
+    case "$1" in
+        -i|--ignore-missing)
+            exit_code=0
+            shift
+            ;;
+        *)
+            args+=("$1")
+            shift
+            ;;
+    esac
+done
+
+# Find the local ShellCheck binary.
+shellcheck="$(command -v shellcheck)"
+
+# Print installation instructions if ShellCheck was not found.
+if [[ -z "$shellcheck" ]]; then
+    echo -e "\n\033[0;33mShellCheck was not found in your \$PATH!\033[0;0m"
+    echo -e "Please visit \033[4mhttps://github.com/koalaman/shellcheck#installing\033[0m for installation instructions.\n"
+    exit "$exit_code"
+fi
+
+"$shellcheck" "${args[@]}"

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "assertwell/shellcheck",
+    "description": "Expose ShellCheck as a vendor binary for PHP projects",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Steve Grunwell",
+            "homepage": "https://stevegrunwell.com"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/assertwell/shellcheck/issues",
+        "source": "https://github.com/assertwell/shellcheck"
+    },
+    "bin": [
+        "bin/shellcheck"
+    ],
+    "scripts": {
+        "test": "shellcheck bin/shellcheck"
+    },
+    "scripts-descriptions": {
+        "test": "Run ShellCheck against the ShellCheck proxy script"
+    },
+    "minimum-stability": "stable",
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
+    }
+}