sindresorhus/eslint-plugin-unicorn

Rule proposal: consistent class member order

クローズ

#1,110 opened on 2021/02/18

GitHub で見るコントリビューターガイド
 (5 件のコメント) (2 件のリアクション) (0 人の担当者)JavaScript (468 件のフォーク)user submission
help wantednew rule

Repository metrics

Stars
 (5,022 個のスター)
PR merge metrics
 (平均マージ 1d 16h) (30d で 399 merged PRs)

説明

Enforce statements in this order

Originally posted by @fisker in https://github.com/sindresorhus/eslint-plugin-unicorn/issues/990#issuecomment-753474656

Can you open a separate issue for the class member order rule idea? Similar rule for TS: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-ordering.md

Originally posted by @sindresorhus in https://github.com/sindresorhus/eslint-plugin-unicorn/issues/990#issuecomment-755267134

Rule name class-body-order is the original idea, I'm open to better suggestions.

Fail

Cases not in order as example in Pass.

Pass

class Unicorn {
   #privateField = 1;

   publicField= 1;

   static staticField = 1;

   constructor() {}

   #privateMethod() {}

   publicMethod() {}

   static staticMethod() {}

   static {
     // static block
   }
}

コントリビューターガイド

調査方針
eslint plugin unicorn の既存ルールの構造とテストパターンを研究します。インスピレーションを得るために、TypeScript ESLint ルール https://github.com/typescript eslint/typescript eslint/blob/master/packages/eslint plugin/docs/rules/member ordering.md を参照してください。AST Explorer などのツールを使用してクラス本体の AST を調べます。説明に従ってルールを実装し、パス/失敗ケースのテストを作成します。
技術スタック
javascripttypescript
領域
toolingdeveloper experience
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
ESLint rule developmentAST manipulationJavaScript class syntax
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50