#3 shellcheck（静的解析）と shfmt（lint）の実装

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/alpine/.devcontainer/base.Dockerfile
+
+# [Choice] Alpine version: 3.13, 3.12, 3.11, 3.10
+ARG VARIANT="3.13"
+FROM mcr.microsoft.com/vscode/devcontainers/base:0-alpine-${VARIANT}
+
+RUN apk update \
+     && apk add --no-cache \
+        shellcheck \
+        shfmt

.devcontainer/README.md

@@ -0,0 +1,5 @@
+# 開発用ディレクトリ
+
+このディレクトリは [Docker](https://ja.wikipedia.org/wiki/Docker) の Alpine Linux コンテナ上でスクリプトの開発をするためのものです。
+
+[VSCode](https://code.visualstudio.com/) と、その [Remote - Containers](https://code.visualstudio.com/docs/remote/remote-overview) 拡張機能がインストールされていれば、同じ開発環境を利用することができます。

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/alpine
+{
+    "name": "Alpine",
+    "build": {
+        "dockerfile": "Dockerfile",
+        // Update 'VARIANT' to pick an Alpine version: 3.10, 3.11, 3.12, 3.13
+        "args": { "VARIANT": "3.13" }
+    },
+
+    // Set *default* container specific settings.json values on container create.
+    "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash"
+    },
+
+    // Add the IDs of extensions you wanït installed when the container is created.
+    // Note that some extensions may not work in Alpine Linux. See https://aka.ms/vscode-remote/linux.
+    "extensions": ["foxundermoon.shell-format", "esbenp.prettier-vscode"],
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "uname -a",
+
+    // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+    // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
+
+    // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "vscode"
+}

.editorconfig

@@ -0,0 +1,34 @@
+# -----------------------------------------------------------------------------
+#  editorconfig 互換用設定ファイル
+# -----------------------------------------------------------------------------
+
+root = true
+
+# Default/Common settings
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# Shell-format
+[*.sh]
+indent_style       = space  # shfmt -i=4
+indent_size        = 4      # shfmt -i=4
+shell_variant      = posix  # shfmt -ln=posix
+binary_next_line   = true   # shfmt -bn
+switch_case_indent = true   # shfmt -ci
+space_redirects    = false  # shfmt -sr
+keep_padding       = true   # shfmt -kp
+function_next_line = false  # disable shfmt -fn
+
+[*.json]
+indent_size = 4
+quote_type = single
+
+
+[*.{yml,yaml}]
+indent_size = 2
+quote_type = single

.github/run-lint.sh

@@ -0,0 +1,136 @@
+#!/bin/sh
+# =============================================================================
+#  ShellCheck & ShellFormat(shfmt) の一括実行スクリプト
+# =============================================================================
+
+# -----------------------------------------------------------------------------
+#  Constants
+# -----------------------------------------------------------------------------
+PATH_DIR_REPO="$(dirname "$(cd "$(dirname "${BASH_SOURCE:-$0}")" && pwd)")"
+PATH_DIR_BIN="${PATH_DIR_REPO}/bin"
+PATH_DIR_RETURN="$(cd . && pwd)"
+SUCCESS=0
+FAILURE=1
+
+# 拡張子のないスクリプトファイル一覧（テスト対象リスト）
+LIST_SCRIPT_NO_EXT="archive check dec enc keygen sign verify"
+
+echo '-------------------------------------------------------------------------------'
+echo ' Requirement Check'
+echo '-------------------------------------------------------------------------------'
+
+# ShellCheck のインストールチェック
+which shellcheck 1>/dev/null 2>/dev/null || {
+    echo >&2 "shellcheck がインストールされていません"
+    echo >&2 "参考文献: https://github.com/Qithub-BOT/QiiCipher/issues/3"
+
+    exit $FAILURE
+}
+echo "ShellCheck $(shellcheck --version | grep version:)"
+
+# shfmt のインストールチェック
+which shfmt 1>/dev/null 2>/dev/null || {
+    echo >&2 "shfmt がインストールされていません"
+    echo >&2 "参考文献: https://github.com/Qithub-BOT/QiiCipher/issues/3"
+
+    exit $FAILURE
+}
+echo "shfmt version: $(shfmt --version)"
+
+# -----------------------------------------------------------------------------
+#  Functions
+# -----------------------------------------------------------------------------
+indentStdIn() {
+    indent="\t"
+    while IFS= read -r line; do
+        printf "${indent}%s\n" "${line}"
+    done
+    echo
+}
+
+runShfmt() {
+    printf "%s" '- Shellformat ... '
+
+    runShfmtForShExt && runShfmtForNoExt && echo 'OK'
+}
+
+# 拡張子 .sh ありのスクリプトの shfmt
+runShfmtForShExt() {
+    find . -name '*.sh' -type f -print0 | xargs -0 shfmt -d
+}
+
+# 拡張子 .sh なしのスクリプトの shfmt
+runShfmtForNoExt() {
+    result=$SUCCESS
+
+    # shellcheck disable=SC2086
+    set -- $LIST_SCRIPT_NO_EXT
+
+    while [ "${1:+none}" ]; do
+        path_file_target="${PATH_DIR_BIN}/${1}"
+
+        shfmt -d "$path_file_target" || {
+            echo >&2 "shfmt fail: ${path_file_target}"
+            result=$FAILURE
+        }
+
+        shift
+    done
+
+    return $result
+}
+
+runShellCheck() {
+    printf "%s" '- ShellCheck ... '
+
+    runShellCheckShExt && runShellCheckForNoExt && echo 'OK'
+}
+
+# 拡張子 .sh ありのスクリプトの shellcheck
+runShellCheckShExt() {
+    find . -name '*.sh' -type f -print0 | xargs -0 shellcheck --external-sources
+}
+
+# 拡張子 .sh なしのスクリプトの shellcheck
+runShellCheckForNoExt() {
+    result=$SUCCESS
+
+    # shellcheck disable=SC2086
+    set -- $LIST_SCRIPT_NO_EXT
+
+    while [ "${1:+none}" ]; do
+        path_file_target="${PATH_DIR_BIN}/${1}"
+
+        shellcheck --external-sources "$path_file_target" || {
+            echo >&2 "shellcheck fail: ${path_file_target}"
+            result=$FAILURE
+        }
+
+        shift
+    done
+
+    return $result
+}
+
+# -----------------------------------------------------------------------------
+#  Main
+# -----------------------------------------------------------------------------
+set -eu
+
+cd "$PATH_DIR_REPO" || {
+    echo >&2 "Failed to change dir to: ${PATH_DIR_REPO}"
+
+    exit $FAILURE
+}
+
+echo '-------------------------------------------------------------------------------'
+echo ' Running linters'
+echo '-------------------------------------------------------------------------------'
+runShfmt
+runShellCheck
+
+cd "$PATH_DIR_RETURN" || {
+    echo >&2 "Failed to change dir to: ${PATH_DIR_RETURN}"
+
+    exit $FAILURE
+}

.github/workflows/shellcheck_linux.yml

@@ -0,0 +1,23 @@
+name: shellcheck
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  lint_check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.15.x
+
+      - name: Install latest shfmt
+        run: GO111MODULE=on go get mvdan.cc/sh/v3/cmd/shfmt
+
+      - name: Run shfmt and shellcheck
+        run: |
+          ./.github/run-lint.sh

.shellcheckrc

@@ -0,0 +1,8 @@
+# =============================================================================
+#  ShellCheck Configuration
+# =============================================================================
+#  See: https://github.com/koalaman/shellcheck/wiki/
+
+# Disable
+#   SC2230: https://github.com/koalaman/shellcheck/wiki/SC2230
+disable=SC2230