Dart コードの分析と修正

目次

• 分析設定
• 診断の抑制
• ワークフロー：静的分析の実行
• ワークフロー：自動修正の適用
• 例

分析設定

パッケージルートにある analysis_options.yaml ファイルを使用して Dart アナライザーを設定します。

• ベース設定： include: ディレクティブを使用して、標準ルールセット（例：package:lints/recommended.yaml または package:flutter_lints/flutter.yaml）を常に含めてください。
• 厳密型チェック： analyzer: language: ノード下で厳密型チェックを有効にして、暗黙的なダウンキャストと動的推論を防止します。strict-casts: true、strict-inference: true、および strict-raw-types: true を設定してください。
• リンタールール： linter: rules: ノード下で特定のルールを明示的に有効化または無効化します。含まれるルールをオーバーライドする場合はキー値マップ（rule_name: true/false）を使用し、新規セットを定義する場合はリスト（- rule_name）を使用してください。同じ rules ブロック内でリストとマップの構文を混在させないでください。
• フォーマッター設定： formatter: ノード下で dart format の動作を設定します。page_width（デフォルト 80）および trailing_commas（automate または preserve）を設定してください。
• アナライザープラグイン： analyzer: plugins: ノード下にプラグインを追加してカスタム診断を有効化します。プラグインパッケージが pubspec.yaml に dev_dependency として追加されていることを確認してください。

診断の抑制

診断（リントまたは警告）が偽陽性を生じる場合、または生成されたコードに適用される場合は、明示的に抑制します。

• ファイルレベルの除外： analysis_options.yaml の analyzer: exclude: ノードを使用して、ファイル全体またはディレクトリ全体（例：**/*.g.dart）をグロブパターンで除外します。
• ファイルレベルの抑制： Dart ファイルの先頭に // ignore_for_file: <diagnostic_code> を追加して、ファイル全体の特定の診断を抑制します。すべてのリンタールールを抑制するには // ignore_for_file: type=lint を使用してください。
• 行レベルの抑制： 問題のあるコードのすぐ上の行に // ignore: <diagnostic_code> を追加するか、問題のあるコード行の末尾に追加します。
• Pubspec の抑制： pubspec.yaml ファイル内の問題のある行の上に # ignore: <diagnostic_code> を追加します（例：# ignore: sort_pub_dependencies）。
• プラグイン診断： プラグイン固有の問題を抑制するときは、診断コードの前にプラグイン名を付けてください（例：// ignore: some_plugin/some_code）。

ワークフロー：静的分析の実行

このワークフローを使用して、型関連のバグ、スタイル違反、および潜在的なランタイムエラーを特定します。

タスク進捗：

• 1. プロジェクトルートに analysis_options.yaml が存在することを確認します。
• 2. analyze_files MCP ツール（利用可能な場合）または CLI コマンド dart analyze <target_directory> を使用してアナライザーを実行します。
• 3. 診断出力を確認します。
• 4. 情報レベルの問題を失敗として扱う必要がある場合は、--fatal-infos フラグを追加してください。
• 5. 報告されたエラーを手動で解決するか、自動修正ワークフローに進みます。

ワークフロー：自動修正の適用

このワークフローを使用して、廃止予定の API 使用法を解決し、クイックフィックスを適用し、コードを移行します（例：Dart 3 マイグレーション）。

タスク進捗：

• 1. dart_fix MCP ツールまたは CLI コマンド dart fix --dry-run を使用してドライラン実行し、提案された変更をプレビューします。
• 2. 提案された修正を確認して、意図されたアーキテクチャと一致していることを確認します。
• 3. 追加の修正が必要な場合は、対応するリンタールールが analysis_options.yaml で有効になっていることを確認してください。
• 4. dart_fix MCP ツールまたは CLI コマンド dart fix --apply を使用して修正を適用します。
• 5. dart_format MCP ツールまたは CLI コマンド dart format . を使用して、変更されたコードをフォーマットします。
• 6. 静的分析ワークフローを実行して、すべての診断が解決されたことを確認します。

例

包括的な analysis_options.yaml

include: package:flutter_lints/recommended.yaml

analyzer:
  exclude:
    - "**/*.g.dart"
    - "lib/generated/**"
  language:
    strict-casts: true
    strict-inference: true
    strict-raw-types: true
  errors:
    todo: ignore
    invalid_assignment: warning
    missing_return: error

linter:
  rules:
    avoid_shadowing_type_parameters: false
    await_only_futures: true
    use_super_parameters: true

formatter:
  page_width: 100
  trailing_commas: preserve

インライン診断の抑制

// ファイル全体に対する抑制
// ignore_for_file: unused_local_variable, dead_code

void processData() {
  // 特定行に対する抑制
  // ignore: invalid_assignment
  int x = '';
  
  const y = 10; // ignore: constant_identifier_names
}