Custom Lint Rules で独自のリントルールを作成する

Custom Lint Rulesで独自のリントルールを作成する ※このページは削除して構いません Click 浅沼もっちゃん@momomomo111

・自己紹介・Custom Lint Rulesについて・実装方法・まとめ

浅沼もっちゃん / momomomo111 株式会社AbemaTV / Android Based TVのアプリを作ってます。自己紹介

そもそもLintとは、 Androidプロジェクトのソースファイルをチェックする静的解析ツール Custom Lint Rulesについて ↑の例だと定義されているけどどこからも呼
び出されていないことについて警告 https://android.googlesource.com/platform/frameworks/support/+/HEAD/ docs/lint_guide.md#getting-started

Q. 警告が出て、なにが嬉しいのか？ A. 警告が出ないようにコーディングすることでプロジェクトの保守性を高めるため（想定外のことや推奨を開発者に知らせてくれるええやつ） Custom Lint Rulesについて

自分で、「ええやつ」作ってみたくない？

今回つくるええやつフィーチャーフラグの期限の形式が ”yyyy-mm-dd”の形式になってなかったらエラーにしたい実装方法 https://github.com/abema/ﬂagﬁt

実装方法下準備・リント用のモジュールの作成・Issue作成、IssueRegistryの実装・テストを書く・Detector()の実装

実装方法リント用のモジュールの作成プロジェクトのルートからモジュールを作成

依存関係追加 Lintモジュールの build.gradleへ追記実装方法

Issue作成警告で出したい文言やプライオリティなどを定義実装方法

IssueRegistryの実装先ほど登録したIssueを登録実装方法

IssueRegistryの実装 com.android.tools.lint.cli ent.api.IssueRegistryに IssueRegistryのフルパスを追加実装方法

IssueRegistryの実装 Lintモジュールの build.gradleへの追記も忘れずに実装方法

Q. なぜテストから書くか？ A. 正しくリントが動くかの動作の保証がシンプル・Lintのライブラリ内で完結・差分が明確で、軽量実装方法

テストを書く testモジュールを切る実装方法

テストを書く・LintDetectorTestを継承して実装・DetectorとIssueを設定実装方法

テストを書く・独自クラスもここで定義しなければならない・expectは一旦適当wipで OK 実装方法

テストを書く・量が多くなったら TestFileで他のobjectに書き出してテスト関数はシンプルにできる実装方法

Detector()の実装・ここで構文解析。一致する条件の場合にメッセージと一緒にレポート・終わったらテストを実行して調整実装方法

使用するプロジェクトのbuild.gradle ファイルから呼び出し使用方法

動作確認ちゃんと期待通りの結果が出ていることを確認使用方法

・Custom Lint Rulesを実装することで柔軟にLint を設定できる・テストから書いて土台を作る方が検証しやすい・今日話した実装内容は下記リポジトリにあります →https://github.com/abema/ﬂagﬁt まとめ

Custom Lint Rules で独自のリントルールを作成する

Custom Lint Rules で独自のリントルールを作成する

浅沼もっちゃん / Motoharu Asanuma

Other Decks in Programming

Featured

Transcript