简介
eslint-plugin-sort-class-members 是一个 ESLint 插件，它可以帮助开发者规范类的成员的排列顺序。这个插件可以检测出代码中类成员的排列顺序不符合预定义规则的情况，并给出相应的提示和建议。
本文将详细介绍如何使用 eslint-plugin-sort-class-members，以及如何配置规则以满足项目需求。
安装
在使用 eslint-plugin-sort-class-members 前，需要先安装 ESLint。如果你已经安装了 ESLint，则可以直接使用以下命令安装 eslint-plugin-sort-class-members：
npm install --save-dev eslint-plugin-sort-class-members
配置
在项目的 .eslintrc 文件中添加如下配置：
-- -------------------- ---- -------
-
---------- -----------------------
-------- -
---------------------------------------- -
--------
-
-------- -
----------------------
-------------------
---------------
-----------------------------------
--------------
------------
-------------------
---------------
------------
------------
--------------------
--------------------------------------
--
-------------------------- -------------
------------------------ -----
---------------------- ----
-
-
-
-上述配置定义了类成员的排列顺序，并规定了一些可选的设置项：
order：定义了类成员的排列顺序。这个数组中的每一项可以是字符串或者正则表达式。其中，字符串代表类成员的名字，正则表达式代表对应的成员名的模式。accessorPairPositioning: 定义了 getter 和 setter 函数的排列位置。可选值有"getThenSet"（默认值）和"setThenGet"。stopAfterFirstProblem: 定义了是否在检测到第一个不符合规范的类成员时停止检查。可选值为 true 和 false， 默认为 false。ignoreStaticMembers: 定义了是否忽略静态类成员的检测。可选值为 true 和 false，默认为 false。
使用
在完成配置后，就可以使用 eslint-plugin-sort-class-members 来检测代码中的类成员排序是否符合规范。例如，下面的代码片段就包含了一个不符合规范的类：
-- -------------------- ---- ------- ----- ------- - ------ - - -- - - -- ------------- -- --- -- ------ --- -- --- --- -- --- -------- -- -
如果在运行 ESLint 后，会得到以下提示信息：
4:3 error Class members should be sorted alphabetically or by visibility/accessibility, then by type, and finally by instance/class membership. The list may be divided into sections by comments sort-class-members/sort-class-members 1:1 error Static properties should be placed before instance properties sort-class-members/sort-class-members 4:3 error Static methods should be placed before instance methods sort-class-members/sort-class-members 8:3 error Expected 'constructor' to come before instance methods sort-class-members/sort-class-members 11:3 error Getter 'y' should be placed before setter 'z' sort-class-members/sort-class-members ✖ 5 problems (5 errors, 0 warnings)
这些提示信息会告诉你，代码中存在四个错误。具体地，它们是：
Static properties should be placed before instance propertiesStatic methods should be placed before instance methodsExpected 'constructor' to come before instance methodsGetter 'y' should be placed before setter 'z'
这就说明，代码中的静态属性和方法没有放在实例属性
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46337