eslint-plugin-intl-mobile/README.md

Intl Mobile ESLint Rules.

# eslint-plugin-intl-mobile

Intl Mobile ESLint Rules.

## 使用

首先安装 ESLint [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

### 扫描项目使用

```bash
# 安装
$ npm install eslint-plugin-intl-mobile

# 打分模式【推荐】
$ npx eslint-intl-mobile -r

# 直接运行 eslint 扫描
$ npx eslint-intl-mobile

# 指定 parser
$ npx eslint-intl-mobile -p @typescript/eslint

# 指定扫描目录
$ npx eslint-intl-mobile -d ./src/pages/

# 指定 es6 parserOptions
$ npx eslint-intl-mobile -e

# 筛选只输出 intl-mobile eslint 结果
$ npx eslint-intl-mobile -f
```

#### 如果运行异常可以尝试

```bash
$ npx eslint-intl-mobile2
```

> 区别在于 `eslint-intl-mobile` 会用自己依赖的 `eslint` 执行，`eslint-intl-mobile2` 会用项目的 `eslint` 执行

### 当做插件使用

```
$ npm install eslint-plugin-intl-mobile
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-intl-mobile` globally.

Add `plugin:intl-mobile/all` to the extends section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "extends": [
        "plugin:intl-mobile/all"
    ]
}
```

Then configure the rules you want to use under the rules section.

.eg

```js
{
  "extends": [
    "plugin:eslint-plugin-intl-mobile/all"
  ],
  "plugins": ["eslint-plugin-intl-mobile"],
  "parser": "@typescript-eslint/parser",
  "rules": {
    "intl-mobile/json-parse-try-catch": 2 // specify error type
  }
}
```

## Supported Rules

#### json-parse-try-catch

- 检测规则：`JSON.parse` 警告需要包裹 `try catch`;

#### rpc-no-number-parameter

- 检测规则：`RPC` 调用警告使用 `number` 类型参数;

#### while-warning

- 检测规则：`while` 使用警告;

#### yen-full-width-detect

- 检测规则：全角符号 `￥` 使用检测警告；

#### typeof-warning

- 检测规则：`typeof` 使用检测警告，如：`typeof a === 'object'`;

#### chain-warning

- 检测规则：链式访问变量使用检测警告，如： `a.b.c`；