# eslint-config-magic

**Repository Path**: sync-github/eslint-config-magic

## Basic Information

- **Project Name**: eslint-config-magic
- **Description**: 统一的 ESLint 配置规范
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://github.com/ineo6/eslint-config-magic
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-11-09
- **Last Updated**: 2021-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Magic ESLint 规则

统一 ESLint 配置规范。

## 使用方法

### 标准规则

```shell
npm install eslint babel-eslint eslint-config-magic --save-dev
```

在你的项目根目录下创建 `.eslintrc.js`，并将以下内容复制到文件中：

```js
module.exports = {
    extends: [
        'magic',
    ],
    globals: {
        // 这里填入你的项目需要的全局变量
        // 这里值为 false 表示这个全局变量不允许被重新赋值，比如：
        //
        // jQuery: false,
        // $: false
    },
    rules: {
        // 这里填入你的项目需要的个性化配置:
    }
};
```

### React

```shell
npm install eslint babel-eslint eslint-plugin-react eslint-config-magic --save-dev
```

在你的项目根目录下创建 `.eslintrc.js`，并将以下内容复制到文件中：

```js
module.exports = {
    extends: [
        'magic',
        'magic/react',
    ],
    rules: {
        // 这里填入你的项目需要的个性化配置:
    }
};
```

### Vue

```shell
npm install eslint babel-eslint vue-eslint-parser eslint-plugin-vue eslint-config-magic --save-dev
```


在你的项目根目录下创建 `.eslintrc.js`，并将以下内容复制到文件中：

```js
module.exports = {
    extends: [
        'magic',
        'magic/vue',
    ],
    rules: {
        // 这里填入你的项目需要的个性化配置:
    }
};
```


### TypeScript

```shell
npm install eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-config-magic --save-dev
```

在你的项目根目录下创建 `.eslintrc.js`，并将以下内容复制到文件中：

```js
module.exports = {
    extends: [
        'magic',
        'magic/typescript',
    ],
    rules: {
        // 这里填入你的项目需要的个性化配置：
    }
};
```