sindresorhus/eslint-plugin-unicorn

Rule proposal: consistent class member order

Open

#1,110 创建于 2021年2月18日

在 GitHub 查看
 (5 评论) (2 反应) (0 负责人)JavaScript (5,022 star) (468 fork)user submission
help wantednew rule

描述

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
   }
}

贡献者指南

技术栈
javascripttypescript
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
ESLint rule developmentAST manipulationJavaScript class syntax
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
Study existing rules in eslint plugin unicorn for structure and testing patterns. Reference the TypeScript ESLint rule at https://github.com/typescript eslint/typescript eslint/blob/master/packages/eslint plugin/docs/rules/member ordering.md for inspiration. Examine AST of class bodies using tools like AST Explorer. Implement the rule with tests for pass/fail cases as described.