# eslint-config-dqy

> ### 一、变量

Latest version **1.0.4** (published 2019-08-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-config-dqy
pnpm add eslint-config-dqy
yarn add eslint-config-dqy
bun add eslint-config-dqy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2019-08-25 |
| First published | 2019-08-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Unpacked size | 14.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | descire |
| Maintainers | daiqingyun |

## Links

- npm: https://www.npmjs.com/package/eslint-config-dqy
- npm.io page: https://npm.io/package/eslint-config-dqy

## Recent versions

- 1.0.4 (latest) — 2019-08-25
- 1.0.3 — 2019-08-18
- 1.0.2 — 2019-08-18
- 1.0.1 — 2019-08-18
- 1.0.0 — 2019-08-18

## README

# 前端代码规范

### 一、变量

### 1、no-var

    const 和 let 不存在声明提升的问题，并且支持块级作用域：

  **错误代码示例：**

```JavaScript
  var a = 1;
  alert(a);
```

  **正确代码示例：**

```JavaScript
  const a = 1;
  alert(a);
```

### 2、no-unused-vars

    已经声明的变量或者常量没有在代码中使用，这样会增加代码量，混淆读者。

  **错误代码示例：**

```JavaScript
  const foo = '123';
```

  **正确代码示例：**

```JavaScript
  const foo = '123';
  alert(foo);
```

### 3、prefer-const

    一个变量不会被重新赋值，最好使用 const 赋值，减少认知负荷，提高可维护性。

  **错误代码示例：**

```JavaScript
  let foo = 1;
  console.log(foo);
```

  **正确代码示例：**

```JavaScript
  const foo = 1;
  console.log(foo);
```


### 二、可能出现的低级错误

### 1、for-direction

    避免一个 for 循环的停止条件永远无法到达：

  **错误代码示例：**

```JavaScript
for (var i = 0; i < 10; i--) {
}
```

  **正确代码示例：**

```JavaScript
for (var i = 0; i < 10; i++) {
}
```

### 2、no-dupe-args

  &emsp;&emsp;禁止在函数定义或者表达式中出现多个同名的参数：

  **错误代码示例：**

```JavaScript
function foo(a, b, a) {
  console.log('value of the second a:', a);
}
```

  **正确代码示例：**

```JavaScript
function foo(a, b, c) {
  console.log(a, b, c);
}
```

### 3、no-dupe-keys

  &emsp;&emsp;避免对象中出现多个相同的键：

  **错误代码示例：**

```JavaScript
const foo = {
  bar: 'baz',
  bar: 'qux'
};

```

  **正确代码示例：**

```JavaScript
const foo = {
  bar: 'bar',
}
```

### 4、no-duplicate-case

  &emsp;&emsp;避免在 switch 语句中出现重复的 case 语句：

  **错误代码示例：**

```JavaScript
const sex = 1;
switch(sex) {
  case 1:
    break;
  case 0:
    break;
  case 1:
    break;
}
```

  **正确代码示例：**

```JavaScript
const sex = 1;
switch(sex) {
  case 1:
    break;
  case 0:
    break;
}
```

### 5、constructor-super

  &emsp;&emsp;避免无效或者确实 super 方法的调用：

  **错误代码示例：**

```JavaScript
class A {
  constructor() {
    super(); 
  }
}
class A extends B {
  constructor() { }
}
```

  **正确代码示例：**

```JavaScript
class A {
  constructor() { }
}

class A extends B {
  constructor() {
    super();
  }
}
```

### 6、no-const-assign

  &emsp;&emsp;避免出现修改 const 变量的错误：

  **错误代码示例：**

```JavaScript
const a = 0;
a = 1;
console.log(a);
```

  **正确代码示例：**

```JavaScript
const a = 0;
console.log(a);
```

### 7、no-dupe-class-members

  &emsp;&emsp;避免 class 中出现同名的声明：

  **错误代码示例：**

```JavaScript
class Foo {
  bar() { console.log("hello"); }
  bar() { console.log("goodbye"); }
}
```

  **成功代码示例：**

```JavaScript
class Foo {
  bar() { console.log("hello"); }
}
```

### 8、no-this-before-super

  &emsp;&emsp;避免在 super 方法之前调用 this：

  **错误代码示例：**

```JavaScript
class A extends B {
  constructor() {
    this.a = 0;
    super();
  }
}
```

  **正确代码示例：**

```JavaScript
class A extends B {
  constructor() {
    super();
    this.a = 0;
  }
}
```

### 9、array-callback-return

  &emsp;&emsp;避免使用数组方法时，忘记 return 结果：

  **错误代码示例：**

```JavaScript
const nums = [1, 2, 3];
const doubleNums = nums.map(item => {
  // 一顿操作之后，忘记 return
})
```

  **正确代码示例：**

```JavaScript
const nums = [1, 2, 3];
const doubleNums = nums.map(item => item * 2);
```

### 三、最佳实践

### 1、dot-notation

  &emsp;&emsp;使用点号访问属性，更加易读、简洁、同时也约束了命名的规范性，并且更适用于 JavaScript 压缩：

  **错误代码示例：**

```JavaScript
  const a = foo['bar-some'];
  const b = foo['bar'];
```

  **正确代码示例：**

```JavaScript
  const a = foo.bar;
```

### 2、eqeqeq

  &emsp;&emsp;避免采用 == 降低程序的可读性：

  **错误代码示例：**

```JavaScript
  function unDef(obj) {
    if (obj == null) {
      return true;
    }
    return false;
  }
```

  **正确代码示例：**

```JavaScript
  function unDef(obj) {
    if (obj === undefined || obj === null) {
      return true;
    }
    return false;
  }
```

### 3、default-case

  &emsp;&emsp;采用 switch 语句时，需要设置 default 语句：

  **错误代码示例：**

```JavaScript
  const sex = 0
  swicth(sex) {
    case 0:
      return '男';
    case 1:
      return '女';
  }
```

  **正确代码示例：**

```JavaScript
  const sex = 0
  swicth(sex) {
    case 0:
      return '男';
    case 1:
      return '女';
    default:
      return '未知性别';
  }
```

### 4、no-magic-numbers

  &emsp;&emsp;将具体的数字或者字符串声明为意义明确的常量，从而使代码更加可读并且容易重构：

  **错误代码示例：**

```JavaScript
  const price = totalPrice * 0.25;
```

  **错误代码示例：**

```JavaScript
  const DISCOUNT = 0.25;
  const price = totalPrice * DISCOUNT;
```

### 5、radix

  &emsp;&emsp; 默认情况下，parseInt()会通过检测前缀，来设置基数，为了避免意想不到的结果，建议在 parseInt() 中始终使用基数来消除意想不到的后果。

  **错误代码示例：**

```JavaScript
  const num = parseInt('071'); // 57 处理为8进制
```

  **正确代码示例：**

```JavaScript
  const num = parseInt('071', 10); // 71
```

### 6、semi

  &emsp;&emsp;行尾使用分号，避免压缩代码时出现意外情况：

  **错误代码示例：**

```JavaScript
  const a = '123'
  console.log(a)
```

  **正确代码示例：**

```JavaScript
  const a = '123';
  console.log(a);
```

### 7、no-extra-semi

  &emsp;&emsp;检测不必要的分号：

  **错误的代码示例：**

```JavaScript
  const a = 1;;
```

  **正确的代码示例：**

```JavaScript

  const a = 1;
```

### 8、max-depth

  &emsp;&emsp;避免过多的嵌套（最大4层），降低代码的可读性：

  **错误代码示例：**

```JavaScript
function foo() {
  for (;;) { // Nested 1 deep
    let val = () => (param) => { // Nested 2 deep
      if (true) { // Nested 3 deep
        if (true) { // Nested 4 deep
          if (true) { // Nested 5 deep
          }
        }
      }
    };
  }
}
```

  **正确代码示例：**

```JavaScript
function foo() {
  for (;;) { // Nested 1 deep
    let val = () => (param) => { // Nested 2 deep
      if (true) { // Nested 3 deep
        if (true) { // Nested 4 deep
        }
      }
    };
  }
}
```

### 9、max-params

  &emsp;&emsp;规定函数的参数不超过5个，更多的参数应该采用对象的方式：

  **错误代码示例：**

```JavaScript
function foo (bar, baz, qux, qxx, some, ok) {
  doSomething();
}
```

  **正确代码示例：**

```JavaScript
function foo ({bar, baz, qux, qxx, some, ok}) {
  doSomething();
}
```

### 10、comma-dangle

  &emsp;&emsp;对象的拖尾逗号：

  **错误代码示例：**

```JavaScript
const foo = {
  age: 20,
  sex: 0
}
```

  **正确代码示例：**

```JavaScript
const foo = {
  age: 20,
  sex: 0,
}
```

### 11、func-names

  &emsp;&emsp;避免使用匿名函数，命名函数更易于调试：

  **错误代码示例：**

```JavaScript
const foo = function () {};
```

  **正确代码示例：**

```JavaScript
const foo = function _foo() {};
```

### 12、indent

  &emsp;&emsp;风格统一的缩进，两个空格：

  **错误代码示例：**

```JavaScript
  if (a === 1) {
      console.log(a);
  }
```

  **正确代码示例：**

```JavaScript
  if (a) {
    console.log(a);
  }
```

---
_Source: https://npm.io/package/eslint-config-dqy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._