Skip to content

Latest commit

 

History

History
146 lines (102 loc) · 2.52 KB

lines-between-class-members.md

File metadata and controls

146 lines (102 loc) · 2.52 KB
规则名 规则类型 关联规则
lines-between-class-members
layout
padded-blocks
padding-line-between-statements

This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member, since that is already taken care of by padded-blocks.

规则详解

此规则的 错误 代码实例:

/* eslint lines-between-class-members: ["error", "always"]*/
class MyClass {
  x;
  foo() {
    //...
  }
  bar() {
    //...
  }
}

此规则的 正确 代码实例:

::: correct

/* eslint lines-between-class-members: ["error", "always"]*/
class MyClass {
  x;

  foo() {
    //...
  }

  bar() {
    //...
  }
}

Examples of additional correct code for this rule:

::: correct

/* eslint lines-between-class-members: ["error", "always"]*/
class MyClass {
  x = 1

  ;in = 2
}

配置项

This rule has a string option and an object option.

String option:

  • "always"(default) require an empty line after class members
  • "never" disallows an empty line after class members

Object option:

  • "exceptAfterSingleLine": false(default) do not skip checking empty lines after single-line class members
  • "exceptAfterSingleLine": true skip checking empty lines after single-line class members

Examples of incorrect code for this rule with the string option:

/* eslint lines-between-class-members: ["error", "always"]*/
class Foo{
  x;
  bar(){}
  baz(){}
}

/* eslint lines-between-class-members: ["error", "never"]*/
class Foo{
  x;

  bar(){}

  baz(){}
}

Examples of correct code for this rule with the string option:

::: correct

/* eslint lines-between-class-members: ["error", "always"]*/
class Foo{
  x;

  bar(){}

  baz(){}
}

/* eslint lines-between-class-members: ["error", "never"]*/
class Foo{
  x;
  bar(){}
  baz(){}
}

Examples of correct code for this rule with the object option:

::: correct

/* eslint lines-between-class-members: ["error", "always", { "exceptAfterSingleLine": true }]*/
class Foo{
  x; // single line class member
  bar(){} // single line class member
  baz(){
    // multi line class member
  }

  qux(){}
}

禁用建议

If you don't want to enforce empty lines between class members, you can disable this rule.

兼容