🎃
flutterのanalysis_options.yamlの色々
このページではFlutterのプロジェクトを立ち上げた際のanalysis_options.yamlのいろいろについて学習内容を記事とする
analysis_options.yamlとは何か
analysis_options.yamlこれは簡単にいうと
プログラムが実行されることなくソースコードを分析するファイル
できること
- ルールの設定
- ルールの無効化
- カスタムルールの追加
- 拡張パッケージの設定
ルールを設け、静的解析を行うことで以下の効用が得られる
- コードの品質向上
- バグの発見
- コードのスタイルや慣用句、潜在的な問題などを自動的に検出する
チームで開発をする際には自分だけではなく、他の人にも理解できるようなコーディングをする必要があるため、コーディング規約を設ける必要があり、analysis_options.yamlは非常に重要な役割を果たす。
flutter_options.yamlの実装手順
- pedantic_monoパッケージのインストール
$ flutter pub add pedantic_mono - analysis_options.yamlに配置する
https://github.com/mono0926/pedantic_mono/blob/main/example/analysis_options.yaml
analysis_options.yaml
# https://pub.dev/packages/pedantic_mono
include: package:pedantic_mono/analysis_options.yaml
静的解析
静的解析のルールを定めると以下の状態に寄せることができる
- 事前の型チェックが厳密になる
- 統一的なコーディングスタイルが強制される
- ベターな振る舞いとなるようなコードに誘導される
Flutterで新規プロジェクトを作成したらまず **analysis_options.yamlを配置して静的解析を厳しくするべき。
Discussion