シェルスクリプトを書く技術

ちょっとした処理などのために急に必要になり、都度調べるが抜け漏れがあっても嫌だし、調べるのにも時間がかかったりするので事前にまとめておく

ShellCheck

ShellCheck – shell script analysis tool
https://www.shellcheck.net/

オープンソースの静的解析ツールで、シェルスクリプト内のバグを自動的に検出する機能を提供する。
公式ページにテキストエリアがあるので、そこで試すことができる。

pre-commit を使っているなら…

  - repo: https://github.com/shellcheck-py/shellcheck-py
    rev: v0.10.0.1
    hooks:
      - id: shellcheck

GitHub Actions を使っているなら…

      - name: Run ShellCheck
        uses: ludeeus/action-shellcheck@2.0.0
        with:
          check_together: 'yes'

TODO: reviewdog 版も確認する
reviewdog/action-shellcheck: Run shellcheck with reviewdog
https://github.com/reviewdog/action-shellcheck

VSCode を使っているなら…
ShellCheck - Visual Studio Marketplace
https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck

shfmt

mvdan/sh: A shell parser, formatter, and interpreter with bash support; includes shfmt
https://github.com/mvdan/sh

フォーマッター、このスクラップのために調べたら出てきたので、使うときに詳細更新します。

checkbashisms

POSIX準拠のシェルスクリプトとなるように、bash 依存のコマンドや構文をある程度指摘してくれる。
#!/bin/sh とするときに大事そう。
このスクラップのために調べたら出てきたので、使うときに詳細更新します。

pushd,popd

複雑なディレクトリ間移動を可能にするpushd,popd
https://zenn.dev/apple_nktn/articles/1e2a4a068c73be

これは他の人のスクリプトを見ていたら書いてあったのでメモ
普段使いにも良さそうです

snippets