您的位置:

Eslint规则详解

一、命名规范

1、文件名必须全部小写,单词之间使用短横线连接,不得使用下划线或驼峰式命名。

2、变量名必须以字母开头,不得以数字或下划线开头,且不能使用JavaScript保留字。

3、常量名必须全部使用大写字母,单词之间使用下划线连接。

//示例:
import myModule from './my-module'; //文件名使用短横线连接
let myVar = 'some value'; //变量名以字母开头,不使用下划线
const MY_CONSTANT = 42; //常量名全部使用大写字母,单词使用下划线连接

二、代码风格

1、缩进必须使用2个空格,不得使用制表符。

2、代码块必须使用花括号,即使只有一行代码。

3、行末不得含有空格。

//示例:
if (true) {
  console.log('Hello world!');
}

三、注释规范

1、单行注释必须在被注释代码的上方,与代码间使用一个空格隔开。

2、多行注释分为两种,一种是块级注释,位于代码块顶部的注释;另一种是行内注释,注释在代码后面,与代码间使用一个空格隔开。

3、注释必须使用英文,避免使用中文。

//示例:
// 这是一个单行注释
function myFunc() {
  // 这是一个行内注释
  // 这是一个多行注释
  // 内部使用字母或数字列表
}

四、变量声明和赋值

1、变量必须使用const或let来声明,不得使用var。

2、变量声明必须放在作用域顶部。

3、连续的变量声明要每个变量声明一次,不能用逗号一起声明。

4、对象属性键名必须使用引号包裹起来,而且属性和值之间必须有一个空格隔开。

//示例:
const myVar1 = 1;
let myVar2 = 2;

const obj = {
  'key1': 'value1',
  'key2': 'value2'
};

五、函数规范

1、函数的参数应该尽可能少。

2、函数中不应该有副作用,即能给定相同的参数,永远返回相同的结果。

3、函数必须有返回值,除非函数返回undefined。

//示例:
function add(a, b) {
  return a + b;
}

const myFunc = () => {
  // do something
  return 'result';
};

六、其他规范

1、字符串必须使用单引号。

2、不得使用with语句。

3、不得使用eval函数。

//示例:
const str = 'Hello world';
const obj = {
  prop1: 'value1'
};

console.log(str);

以上是Eslint规则的一些详细解释,希望对你有所帮助。