自動で //nolint を挿入する取り組み / Gopher's Gathering

https://connpass.com/event/329963/

Transcript

1. 自動で //nolint を 挿入する取り組み id:utgwkk / @utgwkk (うたがわきき) 2025/1/18 Gopher's Gathering 1
2. 自己紹介 (1) • うたがわきき (@utgwkk) ◦ 京都在住 ◦ 実は福岡出身 • 株式会社はてな ◦ Webアプリケーションエンジニア 2
3. 自己紹介 (2) • 好きなパッケージ ◦ reflect ◦ go/ast 3
4. 推しグルメ (1) 元祖 長浜屋 4
5. 推しグルメ (1) 元祖 長浜屋 5
6. 推しグルメ (2) ビアキチ 6
7. アジェンダ • golangci-lintの //nolint directiveを自動で 挿入するCLIツール autonolint を作った - 私 が歌川です • https://github.com/utgwkk/autonolint 7
8. golangci-lintについて • https://golangci-lint.run/ • Goのlinterをまとめて実行するrunner • アンケート: golangci-lintを使っている？ 8
9. あらすじ • ゆるやかにgolangci-lintのルールを強くする / Kyoto.go #56 9
10. 立ち位置 10 enable-allして disableする disable-allして enableする
11. 立ち位置 11 enable-allして disableする disable-allして enableする ゆるやかに enableする
12. モチベーション • golangci-lintで有効にするlinterをあとから 増やしたい • 既存のコードが警告されまくる！！！ • たすけて〜〜 12
13. //nolint:xxx • 指定した行 (ブロック) でだけlinterの警告を 抑制するためのコメント (directive) • これを自動で入れていけば勝てる 13
14. Q. exclude-rulesじゃダメなの • 同じファイル内でも新しく書くコードでは linterを有効にしたい • あとから直すきっかけを作りやすくする ◦ コメントがoutdatedなら解決できるはず ◦ コロケーション的な思想 14
15. DEMO VSCode開いてください 15
16. 実装 (1) • golangci-lintの実行結果をパース ◦ 実はJSON形式で出力できる ▪ --out-format=json ◦ 入力を加工する機能を丸投げ 16
17. 実装 (2) • //nolint を挿入すべき行を特定 • 行ごとに書き出しつつ //nolint を挿入 ◦ bufio.NewScanner 便利 17
18. 実装 (3) • テストではgolangci-lintを実際に走らせる • autonolintを適用した後のコードで警告が出 ないことを確かめる • E2Eテストみたいな感じですね 18
19. 今後の課題 • うまく動かないパターンもあるかも ◦ 既に別の //nolint が書いてある行とか ◦ 気づいたときに直します 19
20. 関連研究 • https://github.com/mizdra/eslint-intera ctive ◦ eslint-disable-next-lineするかどうかなどを インタラクティブに指定できる ◦ 丁寧 20
21. まとめ • golangci-lintの //nolint directiveを自動で 挿入するCLIツール autonolint を作った - 私 が歌川です • https://github.com/utgwkk/autonolint 21