Skip to content

Static analysis configuration静的解析の設定

Static analysis performed by the fmt command is (by default) backed entirely by Ruff.静的解析はfmtコマンドによって実行され、(デフォルトで)完全にRuffに基づいています。

Hatch provides default settings that user configuration can extend.Hatchは、ユーザー設定が拡張できるデフォルト設定を提供します。

Extending config設定の拡張

When defining your configuration, be sure to use options that are prefixed by extend- such as extend-select, for example:設定を定義する際は、extend-で始まるオプションを使用することを確認してください。例えば、extend-selectなどです。

[tool.ruff.format]
preview = true
quote-style = "single"

[tool.ruff.lint]
preview = true
extend-select = ["C901"]

[tool.ruff.lint.extend-per-file-ignores]
"docs/.hooks/*" = ["INP001", "T201"]

[tool.ruff.lint.isort]
known-first-party = ["foo", "bar"]

[format]
preview = true
quote-style = "single"

[lint]
preview = true
extend-select = ["C901"]

[lint.extend-per-file-ignores]
"docs/.hooks/*" = ["INP001", "T201"]

[lint.isort]
known-first-party = ["foo", "bar"]

Note注意

When not persisting config, there is no need to explicitly extend the defaults as Hatch automatically handles that.設定を永続化しない場合、Hatchが自動的に処理するため、デフォルトを明示的に拡張する必要はありません。

Persistent config永続的な設定

If you want to store the default configuration in the project, set an explicit path like so:プロジェクトにデフォルト設定を保存したい場合は、次のように明示的なパスを設定します：

[tool.hatch.envs.hatch-static-analysis]
config-path = "ruff_defaults.toml"

[envs.hatch-static-analysis]
config-path = "ruff_defaults.toml"

Then instruct Ruff to consider your configuration as an extension of the default file:次に、Ruffにデフォルトファイルの拡張としてあなたの設定を考慮するよう指示します：

[tool.ruff]
extend = "ruff_defaults.toml"

extend = "ruff_defaults.toml"

Anytime you wish to update the defaults (such as when upgrading Hatch), you must run the fmt command once with the --sync flag e.g.:デフォルトを更新したい場合（Hatchをアップグレードする際など）、fmtコマンドを一度--syncフラグ付きで実行する必要があります。例：

hatch fmt --check --sync

Tipヒント

This is the recommended approach since it allows other tools like IDEs to use the default configuration.これは、IDEなどの他のツールがデフォルト設定を使用できるようにするため、推奨されるアプローチです。

No config設定なし

If you don't want Hatch to use any of its default configuration and rely entirely on yours, set the path to anything and then simply don't extend in your Ruff config:Hatchがデフォルトの設定を使用せず、完全にあなたの設定に依存させたい場合は、パスを任意のものに設定し、Ruffの設定で単にextendを使用しないでください。

[tool.hatch.envs.hatch-static-analysis]
config-path = "none"

[envs.hatch-static-analysis]
config-path = "none"

Customize behavior動作をカスタマイズする

You can fully alter the behavior of the environment used by the fmt command. See the how-to for a detailed example.fmtコマンドで使用される環境の動作を完全に変更できます。詳細な例についてはhow-toを参照してください。

Dependencies依存関係

Pin the particular version of Ruff by explicitly defining the environment dependencies:特定のRuffのバージョンを明示的に環境dependenciesを定義することで固定します。

[tool.hatch.envs.hatch-static-analysis]
dependencies = ["ruff==X.Y.Z"]

[envs.hatch-static-analysis]
dependencies = ["ruff==X.Y.Z"]

Scriptsスクリプト

If you want to change the default commands that are executed, you can override the scripts. The following four scripts must be defined:実行されるデフォルトのコマンドを変更したい場合は、scriptsをオーバーライドできます。以下の4つのスクリプトを定義する必要があります。

[tool.hatch.envs.hatch-static-analysis.scripts]
format-check = "..."
format-fix = "..."
lint-check = "..."
lint-fix = "..."

[envs.hatch-static-analysis.scripts]
format-check = "..."
format-fix = "..."
lint-check = "..."
lint-fix = "..."

The format-* scripts correspond to the --formatter/-f flag while the lint-* scripts correspond to the --linter/-l flag. The *-fix scripts run by default while the *-check scripts correspond to the --check flag.format-*スクリプトは--formatter/-fフラグに対応し、lint-*スクリプトは--linter/-lフラグに対応します。*-fixスクリプトはデフォルトで実行され、*-checkスクリプトは--checkフラグに対応します。

Reminderリマインダー

If you choose to use different tools for static analysis, be sure to update the required dependencies.静的解析のために異なるツールを使用することを選択した場合は、必要なdependenciesを必ず更新してください。

Installerインストーラー

By default, UV is enabled. You may disable that behavior as follows:デフォルトでは、UVが有効です。この動作を無効にするには、次のようにします:

[tool.hatch.envs.hatch-static-analysis]
installer = "pip"

[envs.hatch-static-analysis]
installer = "pip"

Default settingsデフォルト設定

Non-rule settings非ルール設定

Per-file ignored rulesファイルごとの無視されたルール

Selected rules選択されたルール

The following rules are based on version 0.13.2 of Ruff. Rules with a P are only selected when preview mode is enabled.以下のルールはRuffのバージョン0.13.2に基づいています。Pが付いているルールは、プレビューモードが有効な場合のみ選択されます。

There are 631 selected stable rules and 112 selected preview rules.選択された安定したルールは631件、選択されたプレビューのルールは112件です。

Selected rules

Unselected未選択

There are 189 unselected rules.未選択のルールは189件あります。

Unselected rules