formatが間違ってたので直してあげたよ！ #4270

.github/workflows/github-actions-cache-cleaner.yml

@@ -6,7 +6,7 @@ on:
       - develop
       - master
   schedule:
-    - cron: '0 21 * * *' # 06:00 JST
+    - cron: "0 21 * * *" # 06:00 JST
   workflow_dispatch:
 jobs:
   github-actions-cache-cleaner:

README.md

@@ -37,24 +37,27 @@
 
    安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
 
-    ```sh
-    git clone -b master https://github.com/dev-hato/hato-bot.git
-    cd hato-bot
-    ```
-7. `.env` ファイルを作成し  Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
+   ```sh
+   git clone -b master https://github.com/dev-hato/hato-bot.git
+   cd hato-bot
+   ```
+
+7. `.env` ファイルを作成し Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
 
    `.env.example` をコピーして使うとよいでしょう。
 
    MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
+
 8. `fly.toml` ファイルを作成します。
 
    `fly.template.toml` をコピーし、TODOコメントに従って編集すると良いでしょう。
+
 9. 次のコマンドを実行してfly.ioへのデプロイを行います。
-    ```sh
-    ./flyio_deploy.sh
-    ```
+   ```sh
+   ./flyio_deploy.sh
+   ```
 
 ### 自分のPC上で動かす
 
@@ -65,51 +68,51 @@
 
 3. このリポジトリをcloneします。
 
-    安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
+   安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
 
-    ```sh
-    git clone -b master https://github.com/dev-hato/hato-bot.git
-    cd hato-bot
-    ```
+   ```sh
+   git clone -b master https://github.com/dev-hato/hato-bot.git
+   cd hato-bot
+   ```
 
-    または [Release](https://github.com/dev-hato/hato-bot/releases/latest) から最新の安定版をダウンロードして解凍します。
+   または [Release](https://github.com/dev-hato/hato-bot/releases/latest) から最新の安定版をダウンロードして解凍します。
 
 4. 必要に応じてパッケージをインストールします。
 
-    ```sh
-    pipenv install
-    npm install
-    ```
+   ```sh
+   pipenv install
+   npm install
+   ```
 
-5. `.env` ファイルを作成し  Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
+5. `.env` ファイルを作成し Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
 
-    `.env.example` をコピーして使うとよいでしょう
+   `.env.example` をコピーして使うとよいでしょう
 
-    MODEに `discord` を指定すると、DiscordのBotとして動作します。
+   MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
-    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
+   MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
 
 6. docker composeで鳩botとPostgreSQLを起動します。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose up -d --wait
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose up -d --wait
+   ```
 
-    開発時は代わりに次のコマンドを実行します。
+   開発時は代わりに次のコマンドを実行します。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml build
-    docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml watch
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml build
+   docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml watch
+   ```
 
 7. コードの変更はdocker composeの再起動で適用できます。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose restart
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose restart
+   ```
 
    開発時は自動的にDockerイメージの再ビルドが行われ反映されます。
 
@@ -123,17 +126,17 @@ npm run lint
 
 - 鳩botに対しコマンドを実行したいときは `post_command.py` を使うと便利です。
 
-    ```sh
-    pipenv run python post_command.py --channel {投稿先のチャンネルのchannel id} \
-                                      --user {自分のuser_id} \
-                                      "{hato-botのコマンド}"
-    ```
+  ```sh
+  pipenv run python post_command.py --channel {投稿先のチャンネルのchannel id} \
+                                    --user {自分のuser_id} \
+                                    "{hato-botのコマンド}"
+  ```
 
 - または[ngrok](https://ngrok.com/)を使うこともできます。
 
-    ```sh
-    ./ngrok http 3000
-    ```
+  ```sh
+  ./ngrok http 3000
+  ```
 
 #### コミットする前に行うこと
 
@@ -152,8 +155,8 @@ pipenv run pre-commit install
 
 - 鳩botで使用可能なコマンドは次の通りです。
 
-    ```text
-    amesh ... 東京のamesh(雨雲情報)を表示する。
+  ```text
+  amesh ... 東京のamesh(雨雲情報)を表示する。
     amesh [text] ... 指定した地名・住所・郵便番号[text]のamesh(雨雲情報)を表示する。
     amesh [緯度 (float)] [経度 (float)] ... 指定した座標([緯度 (float)], [経度 (float)])のamesh(雨雲情報)を表示する。
     amedas ... 東京のamedas(気象情報)を表示する。
@@ -177,7 +180,7 @@ pipenv run pre-commit install
     chat [text] ... ChatGPTで文章生成する。
     画像生成 [text] ... openAIのImage generationで画像生成する。[text]は英語での入力推奨。
     ping ... 「ping」したら「PONG」と返す。
-    ```
+  ```
 
 ## バージョンアップによる変更点
 
@@ -186,7 +189,7 @@ pipenv run pre-commit install
 ## バグ報告や機能の要望について
 
 - バグ報告や機能追加の要望がある場合は [Issues](https://github.com/dev-hato/hato-bot/issues) の
-     `New Issue` から報告をお願いします。
+  `New Issue` から報告をお願いします。
 
 - プルリクエストも大歓迎です。
 

README.template.md

@@ -37,24 +37,27 @@
 
    安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
 
-    ```sh
-    git clone -b master https://github.com/dev-hato/hato-bot.git
-    cd hato-bot
-    ```
-7. `.env` ファイルを作成し  Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
+   ```sh
+   git clone -b master https://github.com/dev-hato/hato-bot.git
+   cd hato-bot
+   ```
+
+7. `.env` ファイルを作成し Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
 
    `.env.example` をコピーして使うとよいでしょう。
 
    MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
+
 8. `fly.toml` ファイルを作成します。
 
    `fly.template.toml` をコピーし、TODOコメントに従って編集すると良いでしょう。
+
 9. 次のコマンドを実行してfly.ioへのデプロイを行います。
-    ```sh
-    ./flyio_deploy.sh
-    ```
+   ```sh
+   ./flyio_deploy.sh
+   ```
 
 ### 自分のPC上で動かす
 
@@ -65,51 +68,51 @@
 
 3. このリポジトリをcloneします。
 
-    安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
+   安定版を使う場合は `-b master` を指定します。最新の開発版を使う場合は指定不要です。
 
-    ```sh
-    git clone -b master https://github.com/dev-hato/hato-bot.git
-    cd hato-bot
-    ```
+   ```sh
+   git clone -b master https://github.com/dev-hato/hato-bot.git
+   cd hato-bot
+   ```
 
-    または [Release](https://github.com/dev-hato/hato-bot/releases/latest) から最新の安定版をダウンロードして解凍します。
+   または [Release](https://github.com/dev-hato/hato-bot/releases/latest) から最新の安定版をダウンロードして解凍します。
 
 4. 必要に応じてパッケージをインストールします。
 
-    ```sh
-    pipenv install
-    npm install
-    ```
+   ```sh
+   pipenv install
+   npm install
+   ```
 
-5. `.env` ファイルを作成し  Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
+5. `.env` ファイルを作成し Slack API Token、PostgreSQLの認証情報、Yahoo API Tokenなどを記述します。
 
-    `.env.example` をコピーして使うとよいでしょう
+   `.env.example` をコピーして使うとよいでしょう
 
-    MODEに `discord` を指定すると、DiscordのBotとして動作します。
+   MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
-    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
+   MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
 
 6. docker composeで鳩botとPostgreSQLを起動します。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose up -d --wait
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose up -d --wait
+   ```
 
-    開発時は代わりに次のコマンドを実行します。
+   開発時は代わりに次のコマンドを実行します。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml build
-    docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml watch
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml build
+   docker compose -f docker-compose.yml -f dev.base.docker-compose.yml -f dev.docker-compose.yml watch
+   ```
 
 7. コードの変更はdocker composeの再起動で適用できます。
 
-    ```sh
-    export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
-    docker compose restart
-    ```
+   ```sh
+   export TAG_NAME=$(git symbolic-ref --short HEAD | sed -e "s:/:-:g")
+   docker compose restart
+   ```
 
    開発時は自動的にDockerイメージの再ビルドが行われ反映されます。
 
@@ -123,17 +126,17 @@ npm run lint
 
 - 鳩botに対しコマンドを実行したいときは `post_command.py` を使うと便利です。
 
-    ```sh
-    pipenv run python post_command.py --channel {投稿先のチャンネルのchannel id} \
-                                      --user {自分のuser_id} \
-                                      "{hato-botのコマンド}"
-    ```
+  ```sh
+  pipenv run python post_command.py --channel {投稿先のチャンネルのchannel id} \
+                                    --user {自分のuser_id} \
+                                    "{hato-botのコマンド}"
+  ```
 
 - または[ngrok](https://ngrok.com/)を使うこともできます。
 
-    ```sh
-    ./ngrok http 3000
-    ```
+  ```sh
+  ./ngrok http 3000
+  ```
 
 #### コミットする前に行うこと
 
@@ -152,9 +155,9 @@ pipenv run pre-commit install
 
 - 鳩botで使用可能なコマンドは次の通りです。
 
-    ```text
-    {commands}
-    ```
+  ```text
+  {commands}
+  ```
 
 ## バージョンアップによる変更点
 
@@ -163,7 +166,7 @@ pipenv run pre-commit install
 ## バグ報告や機能の要望について
 
 - バグ報告や機能追加の要望がある場合は [Issues](https://github.com/dev-hato/hato-bot/issues) の
-     `New Issue` から報告をお願いします。
+  `New Issue` から報告をお願いします。
 
 - プルリクエストも大歓迎です。
 

doc/01_Get_Slack_API_Token.md

@@ -6,22 +6,24 @@
 
 1. `App Name` に `hato` と入力し、 `Development Slack Workspace` にBotを動かすSlack Workspaceを選択します。
 
-    その後 `Create App` をクリックします。
+   その後 `Create App` をクリックします。
 
 1. 左側にある `OAuth & Permissions` をクリックします。
 
 1. `Bot Token Scopes` で次の権限を付与します。
-    * app_mentions:read
-    * chat:write
-    * files:write
-    * users:read
+
+   - app_mentions:read
+   - chat:write
+   - files:write
+   - users:read
 
 1. `User Token Scopes` で次の権限を付与します。
-    * chat:write
+
+   - chat:write
 
 1. ページ上部にある `Install App to Workspace` をクリックします。
 
 1. `Bot User OAuth Access Token` の値をメモします。
 
 1. 左側にある `Basic Information` をクリックし、遷移後のページにある `Signing Secret` の値をメモします。
-    (マスクされているので `show` を押して生の値を確認します)
+   (マスクされているので `show` を押して生の値を確認します)

doc/02_Setting_to_Event_URL.md

@@ -8,9 +8,9 @@
 
 1. `Request URL` にURLを入力します。この時、次の様にURL末尾に `slack/events` を追加します。
 
-    ```text
-    https://example.com/slack/events
-    ```
+   ```text
+   https://example.com/slack/events
+   ```
 
 1. `Verified` が表示されたら下にある `Subscribe to bot events` をクリックし `app_mention` を追加します。