Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

glang linter 検討まとめ #31

Merged
merged 3 commits into from
Feb 5, 2024
Merged

glang linter 検討まとめ #31

merged 3 commits into from
Feb 5, 2024

Conversation

naotama2002
Copy link
Owner

No description provided.


## チームにとって良い golangci-lint 設定とは?

「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、と チーム用の golangci.yml 設定は作ってみた。
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-spacing/ja-no-space-between-full-width> reported by reviewdog 🐶
原則として、全角文字どうしの間にスペースを入れません。 (ja-spacing/ja-no-space-between-full-width)


「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、と チーム用の golangci.yml 設定は作ってみた。

:::details 設定ファイルを作るために書いたメモ
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)


## チームにとって良い golangci-lint 設定とは?

「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、と チーム用の golangci.yml 設定は作ってみた。
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[textlint-fix] reported by reviewdog 🐶

Suggested change
「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、と チーム用の golangci.yml 設定は作ってみた。
「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、とチーム用の golangci.yml 設定は作ってみた。

@naotama2002 naotama2002 force-pushed the consider-golang-linter branch from 12c11f5 to e8b2ad7 Compare February 3, 2024 14:52

[golangci-ling: Linters](https://golangci-lint.run/usage/linters/) を 1 つ 1 つ理解して試して取捨選択していくのは厳しいため、「Go を採用していて、かつチームで利用している OSS のリポジトリを見ながら良い感じの linter を選択できないか」という方法で検討しました。

主観で決めたリスト
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)


各 OSS/チーム(会社)内のリポジトリ内でも設定が違うものもありますが、アクティブなリポジトリから 1 つ選出しています。

確認したリポジトリ
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)

max-same-issues: 0
```

チーム用の golangci.yml 作った上で、チームの Go リポジトリで golangci-lint を動かしてみたが「ほとんど何も検出されない」となりました。この結果を見て
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)

## golangci-lint をやめた理由
- いろいろなプロジェクトを見てみたが `これが良さそう` という設定を導き出せなかった
- たぶん各チームで `linter に求めるものが違う` ため当たり前なんだと思う
- 取捨選択することを諦め `enable-all: true` して全ての linter を有効にすることも可能だが、モブプログラミングで開発するチームには `過剰` になりそう
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-redundant-expression> reported by reviewdog 🐶
【dict1】 "することも可能だ"は冗長な表現です。"することも"を省き簡潔な表現にすると文章が明瞭になります。
解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict1 (ja-technical-writing/ja-no-redundant-expression)

@naotama2002 naotama2002 force-pushed the consider-golang-linter branch 2 times, most recently from 12c11f5 to 5e1e089 Compare February 5, 2024 01:00
@naotama2002 naotama2002 force-pushed the consider-golang-linter branch from c9e6cf6 to 9d32119 Compare February 5, 2024 02:28
@naotama2002 naotama2002 merged commit 8d577fe into main Feb 5, 2024
2 checks passed
@naotama2002 naotama2002 deleted the consider-golang-linter branch February 5, 2024 02:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant