From a7d8c50d4d7cff889f831931e5bea63c8f8eb8c4 Mon Sep 17 00:00:00 2001 From: tarepan Date: Wed, 5 Jun 2024 21:50:07 +0900 Subject: [PATCH] =?UTF-8?q?=E6=95=B4=E7=90=86:=20typos=20=E8=A8=AD?= =?UTF-8?q?=E5=AE=9A=E3=82=92=20`pyproject.toml`=20=E3=81=B8=E7=A7=BB?= =?UTF-8?q?=E6=A4=8D=20(#1367)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * refactor: typos 設定を移植 * fix: codec * fix: typos の設定手法に関するドキュメントを更新 --- CONTRIBUTING.md | 2 +- README.md | 2 +- _typos.toml | 5 ----- pyproject.toml | 3 +++ 4 files changed, 5 insertions(+), 7 deletions(-) delete mode 100644 _typos.toml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09ffb1e92..38aab6594 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -255,7 +255,7 @@ poetry export --without-hashes --with license -o requirements-license.txt ### タイポ検査 タイポ検査を採用しています。 -目的は可読性の向上であり、チェッカーには [`typos`](https://github.com/crate-ci/typos) を採用しています。誤判定やチェックから除外すべきファイルがあれば[設定ファイルの説明](https://github.com/crate-ci/typos#false-positives)に従って `_typos.toml` を編集してください。 +目的は可読性の向上であり、チェッカーには [`typos`](https://github.com/crate-ci/typos) を採用しています。誤判定やチェックから除外すべきファイルがあれば[設定ファイルの説明](https://github.com/crate-ci/typos#false-positives)に従って `pyproject.toml` を編集してください。 ローカルへの `typos` 導入は各自の環境に合わせて公式ドキュメントを参照してください。ローカルへの導入が難しい場合、プルリクエスト時に GitHub Actions で自動実行される `typos` の結果を参照してください。 #### タイポを検査する diff --git a/README.md b/README.md index a0a96c6d5..20e6b533b 100644 --- a/README.md +++ b/README.md @@ -630,7 +630,7 @@ typos でタイポチェックを行えます。 もし誤判定やチェックから除外すべきファイルがあれば -[設定ファイルの説明](https://github.com/crate-ci/typos#false-positives) に従って`_typos.toml`を編集してください。 +[設定ファイルの説明](https://github.com/crate-ci/typos#false-positives) に従って`pyproject.toml`を編集してください。 ### 依存関係 diff --git a/_typos.toml b/_typos.toml deleted file mode 100644 index 45d94f1f2..000000000 --- a/_typos.toml +++ /dev/null @@ -1,5 +0,0 @@ -# typos の設定ファイル -# 書式は以下の公式ドキュメントを参照: https://github.com/crate-ci/typos#false-positives - -[default.extend-words] -datas="datas" # PyInstallerの引数 diff --git a/pyproject.toml b/pyproject.toml index 167042483..e872edad4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,9 @@ line_length = 88 multi_line_output = 3 use_parentheses = true +[tool.typos.default.extend-words] +datas = "datas" # PyInstaller's argument + [tool.poetry] package-mode = false