test

Author: aiya000

.clinerules

@@ -0,0 +1,211 @@
+# .clinerules
+
+## Creating ShellScript files
+
+When creating a ShellScript file:
+
+- Always include `./LICENSE` content as a comment at the end of the file
+
+- Minimize dependencies on other ShellScript files whenever possible
+    - `./README.md` にて、「環境に独立してインストール可能」と明示しているためです
+    - ただし`./define-options.sh`と`./lib/fun.sh`は例外です。これらには依存してかまいません
+        - これも`./README.md`にて、依存性を明示しているためです
+    - `./lib/fun.sh`の用法については`./lib/fun.sh`の内容、もしくは[公式のREADME.md](https://raw.githubusercontent.com/ssledz/bash-fun/refs/heads/master/README.md)を参照してください
+
+- `./lib`ディレクトリにあるライブラリが使えそうな場合は、優先的に使用してください
+    - `./lib/fun.sh`は特に便利です。関数型プログラミングを意識してください
+
+- 1行目には`#!/bin/bash`を記述してください
+
+- その次に説明文と使用例を記述してください。例えば次のようになります
+    - 使用例は網羅的に記述してください。ただしユーザーへの読みやすさ・シンプルさも忘れないでください
+
+```sh:bin/dust
+#!/bin/bash
+
+# An alternative of `rm`, but 'mv' to dustbox instead.
+#
+# ```shell-session
+# $ ls README.md  # Checking existence of readme
+# $ dust README.md
+# mv README.md /home/aiya000/.backup/dustbox/README.md_2025-02-25_13:45:37.md
+# ```
+
+# 以下、実装
+# ...
+
+# 以下、./LICENSEの内容
+# ...
+```
+
+- 「`./sources`について」セクションと「`./bin`について」を読み、ShellScriptファイルの配置を適切に行ってください
+    - また配置されるShellScriptは、それぞれのセクションのそのルールに従います
+
+- ユーザーに設定の余地をできるだけ与えてください
+    - できるだけ環境変数として設定できるようにしてください
+        - その場合`./define-options.sh`に以下のような内容を追記してください
+
+```sh:define-options.sh
+# ...
+
+[[ -z $BASH_TOYS_{変数名} ]] && export BASH_TOYS_{変数名}={デフォルト値}
+
+# ...
+```
+
+- ShellScriptを作ったあとは、テストを作成してください
+    - テストに関するルールは'Creating Test Files'セクションに続きます
+
+- 変数名を使用する場合は`${varname}`ではなく、できるだけ`$varname`を使用してください
+    - ただし、`$varname`が文字列として解釈される場合は`${varname}`を使用してください
+
+- 関数を定義する場合は必ず`function`を使用してください
+- 関数でローカル変数を意図して変数を定義する場合は、`local`を使用してください
+- 関数を定義する場合は、できるだけグローバル変数（トップレベルの`$1`など）を使わず、引数を使用してください
+- 関数のモジュール結合度を弱くしてください
+- 関数のモジュール強度を強くしてください
+
+- ヘルパー関数を定義することは構いませんが、あまり数を増やさないようにしてください
+    - つまり、不要なノイズは増やさないでください
+
+以下は不要なヘルパー関数の例です。
+
+```sh
+function has_glow () {
+  # 条件式に直接書いても、そこまで可読性は落ちない
+  command -v glow >/dev/null 2>&1
+}
+
+function is_disable_glow_opt () {
+  # 同上
+  [[ $1 == '--disable-glow' ]]
+}
+```
+
+逆に、以下は適切なヘルパー関数です。
+
+```sh
+# Show help and exit
+function show_help () {
+  cat << EOF
+bash-toys-help - Show help for bash-toys commands
+
+Usage:
+  bash-toys-help [--disable-glow] COMMAND
+  bash-toys-help --help
+
+Options:
+  --disable-glow  Do not use glow for markdown rendering
+  --help         Show this help message
+EOF
+  exit 0
+}
+```
+
+- ヘルパー関数の名前は`snake_case`で記述してください
+    - ただし後述の、`./sources`に配置される`function {機能名}`については例外です
+        - 詳しくは「`./sources`について」セクションを参照してください
+
+- `;`の前後にはスペースを入れてください
+- `[ ... ]`の代わりに`[[ ... ]]`を使用してください
+
+- `--help`が渡された場合は、ヘルプを表示するように実装してください
+    - その際に、ヘルプを表示する以外の処理は行わないようにしてください
+
+- もし`""`の代わりに`''`が使える場合は、`''`を使用してください
+- もし`''`すら必要ない場合は、積極的に省いてください
+
+- コメントを書くのは構いませんが、コードを見ればわかると感じるものは、書かないください
+    - できるだけコード自体が説明を行うようにしてください
+
+以下はコメントが不要な例です。
+`# Show help and exit`が不要です。
+
+```sh
+# Show help and exit
+function show_help () {
+  cat << EOF
+cmd - ...
+
+Usage:
+  ...
+
+Options:
+  ...
+EOF
+  exit 0
+}
+```
+
+- shellcheckによるチェックを行ってください。修正できる場合は修正してください
+
+### `./sources`について
+
+- サブプロセスとして実行できないShellScript（カレントシェルに影響を及ぼす関数）は`./source`に配置してください
+    - その際は、ファイル名は`{機能名}.sh`とし、その内部に`function {機能名} () { ... }`として関数を定義してください
+    - `{機能名}`は`kebab-case`で記述してください
+
+例えば以下のようなシェルスクリプトです。
+
+```sh:source/define-alias.sh
+#!/bin/bash
+
+# Defines alias.
+# ```shell-session
+# $ define-alias ll 'ls -l'
+# ```
+
+function define-alias () {
+  local name=$1 detail=$2
+  eval "alias $name='$detail'"
+}
+```
+
+それ以外の、サブプロセスとして実行できるShellScriptは、`./bin`に配置してください
+
+### `./bin`について
+
+- サブプロセスとして実行できるShellScriptは`./bin`に配置してください
+    - その際は、ファイル名は`{機能名}`とし、拡張子に`.sh`を付けないでください
+
+その他、「`./sources`について」セクションを参照してください。
+
+## Creating Test Files
+
+Almost all ShellScript files (executables and source files) in this project include usage instructions and an example in the following format:
+
+```sh:bin/dust
+#!/bin/bash
+
+# An alternative of `rm`, but 'mv' to dustbox instead.
+#
+# ```shell-session
+# # Simple usage
+# $ ls README.md  # Check existence of readme
+# $ dust README.md
+# mv README.md /home/aiya000/.backup/dustbox/README.md_2025-02-25_13:45:37.md
+# ```
+
+# ...
+```
+
+If such a `shell-session` block is present, convert its contents into the `.bats` format.
+Ensure that all conditions are comprehensively covered in the tests.
+
+The test output directory is `./test`, with files written in the `bats` format and using the `.bats` extension.
+
+## Git
+
+- コミットメッセージは英語で記述してください
+
+- コミットメッセージは`{動詞} ...`のように書いてください
+    - 動詞の先頭文字は大文字にしてください。例えば`Add ...`・`Fix ...`などです
+
+- `gh`コマンドが有効な場合は、コミットをする前に`$ gh issue list`でIssueリストを確認し、コミットにより解決される見込みのあるIssueがある場合は、コミットメッセージの3行目に`Closes #{Issue番号}`を追記してください
+
+## その他、全てにおいて
+
+- `$ curl {url} | sh`や`$ curl {url} | bash`をするときは、必ず先に`{url}`の内容を読み、それが実行されたときの危険性を理解してください
+    - もし危険性が存在する場合は、作業をそこで中断し、私に判断を仰いでください
+
+- OSパッケージのインストール（例えば`$ sudo apt install {packages}`・`$ brew install {packages}`）が必要な場合は、一度作業を中断し、私に判断を仰いでください