📌

改行をしない民を撲滅するためのeslint rule

2023/02/05に公開

皆さんはコーディングする際に改行をしていますか?

改行は僕にとって句読点と同じ役割をしていると思っています。
句読点が全くない文章というのは読みづらいですよね?

コードも一緒で、(個人的に)改行がないコードはとても読みづらいし、読むのが苦痛でしょうがないです。

句読点の打ち方というリンクを見つけたので共有しておきます。

https://liginc.co.jp/285073

意味の切れ目に打つ
誤読されそうなところに打つ
間 をとりたいところに打つ

大事。

しかし、仕事をしていると改行をろくにしない人も中にはいるかもしれません。

そんな人いるわけない?自分は実際に見たことがあります。
改行がないのが嫌すぎたので、今回記事を書くきっかけになりました。

この記事でeslintのルールが一つ追加されるきっかけになったら、とても嬉しいです。

padding-line-between-statements

そのルールが padding-line-between-statementsです。
これはprev patternと next patternによって、改行をするか改行をさせないようにするかを強制することができます。

https://eslint.org/docs/latest/rules/padding-line-between-statements

'padding-line-between-statements': [
      'error',
      {
        'blankLine': 'always',
        'prev': '*',
        'next': 'return'
      },
      {
        'blankLine': 'always',
        'prev': '*',
        'next': 'function'
      },
      {
        'blankLine': 'always',
        'prev': '*',
        'next': 'if'
      },
      {
        'blankLine': 'always',
        'prev': '*',
        'next': 'block'
      },
    ],

自分の場合は、ブロックごとに改行をして欲しいため上記のようにしました。
iffunctionreturnの前には、改行を強制しています。

constごとにも改行ルールを追加しようとも考えましたがやめました。
やり過ぎ感があるかなと思いました。

ぜひプロジェクトの治安維持のために、ルールの追加を検討してみてください。

GitHubで編集を提案

Discussion