Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
linter for your team rule
Search
mizkei
November 09, 2018
Programming
3
2.3k
linter for your team rule
mizkei
November 09, 2018
Tweet
Share
More Decks by mizkei
See All by mizkei
About: Go Module Proxy: Life of a query
mizkei
0
180
Goでゲームサーバーを実装して考えたこと / game server in go
mizkei
1
6.8k
Other Decks in Programming
See All in Programming
3 Effective Rules for Using Signals in Angular
manfredsteyer
PRO
1
100
Compose 1.7のTextFieldはPOBox Plusで日本語変換できない
tomoya0x00
0
190
EventSourcingの理想と現実
wenas
6
2.3k
みんなでプロポーザルを書いてみた
yuriko1211
0
260
Click-free releases & the making of a CLI app
oheyadam
2
110
CSC509 Lecture 11
javiergs
PRO
0
180
Kaigi on Rails 2024 〜運営の裏側〜
krpk1900
1
190
OSSで起業してもうすぐ10年 / Open Source Conference 2024 Shimane
furukawayasuto
0
100
PHP でアセンブリ言語のように書く技術
memory1994
PRO
1
170
Better Code Design in PHP
afilina
PRO
0
120
役立つログに取り組もう
irof
28
9.6k
A Journey of Contribution and Collaboration in Open Source
ivargrimstad
0
870
Featured
See All Featured
Intergalactic Javascript Robots from Outer Space
tanoku
269
27k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
126
18k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.1k
How To Stay Up To Date on Web Technology
chriscoyier
788
250k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
169
50k
[RailsConf 2023] Rails as a piece of cake
palkan
52
4.9k
Become a Pro
speakerdeck
PRO
25
5k
Optimising Largest Contentful Paint
csswizardry
33
2.9k
GraphQLとの向き合い方2022年版
quramy
43
13k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
364
24k
Into the Great Unknown - MozCon
thekraken
32
1.5k
Designing on Purpose - Digital PM Summit 2013
jponch
115
7k
Transcript
プロジェクトのルールを チェックするためのlint mercari.go#4
目次 • 自己紹介 • golint • チームで取り入れたいルール • テストのために取り入れたいルール •
パッケージの役割を分けるために取り入れたいルール • ルールをチームで共有する方法 • ルール表現のために作成したツール「self-lint」 • まとめ
自己紹介 • 名前 ◦ 水野 敬太 • github ◦ mizkei
• twitter ◦ @mizkei11 • 仕事 ◦ Backend/マイクロサービス開発
golint
golintによるコーディングスタイルの指摘 • Effective Go や Go Code Review Comments に基づいた指摘
◦ 不要なelse ◦ コメントのフォーマット ◦ context.WithValueのkeyの型 ◦ 変数・パッケージ名 ◦ import Dot ◦ main以外でのblank import ◦ ...
golintによるコーディングスタイルの指摘 • プロジェクトにおけるコードの書き方がある程度統一される • エディタの設定をすれば、編集しながら確認可能 • reviewdog にログを食べてもらえば、github上でも指摘される 綺麗なGoのコードを書くためのルールとしては非常に有用だが、 チームのローカルルールが欲しい場合もある
チームで取り入れたいルール
特定パッケージのimport制限 • Assertなどを提供する外部パッケージ ◦ Why does Go not have assertions?
• プロジェクトにおけるテスト用パッケージ ◦ e.g. githoge.com/project/root/test ◦ テスト用のデータを用意するための便利メソッド群 ▪ 複数パッケージのテストで参照されるために一つのパッケージとして作成
プロジェクトにおけるテスト用パッケージ • テスト用のmock ◦ テストではないパッケージに含めたくない ▪ package modelをimportしてしまえば誰でも使えてしまうため • テストデータ作成便利メソッド
◦ *intなどを各パッケージのテストで書いていると手間がかかる
プロジェクトにおけるテスト用パッケージ
テストのために取り入れたいルール
特定メソッド・変数への参照制限 • テストのための時間停止用メソッドなど ◦ メソッドとして用意しない方法もあるが、テストが一手間増える ◦ 手間をかけないために楽をしたときにできてしまう副産物を テスト以外では利用できないようにしたい
テスト用に時間を停止するメソッド • 現在時刻による動作の差異がある場合をテストする時の方法 ◦ Now() time.Timeを実装したインターフェースを渡せるようにする ▪ テスト用に各種パッケージにインターフェースを渡すのが手間 ◦ グローバルにtime.Nowへの参照を持ったパッケージを作成して、
現在時刻取得はそのメソッドから行い、テスト時に差し替える ▪ テスト時に差し替える用のメソッドは `*_test.go` から参照できる必要があるため Publicなメソッドにしなければならない
現在時刻を差し替える(interface版) • interfaceを渡すべき構造体が複数ある場合など、テストでの管理が面倒
現在時刻を差し替える(global書き換え版) • build tagsを記述したファイルのみにメソッドを定義した場合、 エディタのlint設定も変更しなければならない • タグがなければ、差し替えるメソッドは機能しないが、差し替えるメソッドを TestGoFiles, XTestGofiles以外で参照することすらあってほしくはない
パッケージの役割を分けるために取 り入れたいルール
特定builtin機能の制限 • panic書く機会はほぼないため禁止してしまいたい ◦ web application書いているときなど • データの構造についてのみ記述するためのパッケージで条件分岐など不要 ◦ e.g.
githoge.com/project/root/data ◦ 構造体の定義だけ記述されていたり、 値を詰め込むだけのメソッドしか存在してほしくない
ルールの共有方法
チームでのルールの共有方法 • Wikiにまとめる ◦ 更新され続ける保証はない ◦ 読まないで書いてくる人いるかも ◦ レビューで指摘するとして、チームに入ってからの歴が浅いと 見逃してしまう可能性がある
人がチェックすると見逃す可能性を排除することはできないので、 チームルールを自動的にチェックするためのツールが欲しい
「self-lint」
self-lint • https://github.com/mizkei/self-lint • チームでの禁止事項(ローカルルール)をチェックするためのツール ◦ 特定importのチェック ◦ 特定packageのメソッドや変数への参照 ◦
panicなどのbuiltin functionの使用 • CIを利用した自動チェック ◦ golintと同じ出力形式であるため、reviewdogが食べてくれる
self-lintの設定 • target ◦ 対象のパッケージ ▪ globalは全てのパッケージ • import ◦
禁止したいパッケージを書く • ref ◦ 禁止したいパッケージの値を書く • write ◦ 禁止したいbuiltin functionを書く ▪ panic, if, switch, or for
特定importのチェック • テストファイル以外でtestパッケージはimportしてはいけない
特定パッケージの値への参照 • テスト用に作成されたメソッドを テストファイル以外で参照してほしくない
特定のbuiltinやstatementsの利用 • データを定義しているだけのパッケージでpanicしてほしくない
まとめ • lintに加えて、チームでの開発において、更に制限が欲しくなる場合に ついて述べた • チームとして設定した制限を自動チェックするために self-lintというツールを作成した