open-index/open-npm huggingface dataset:
npm package: @ifanrx/commitlint-config-standard-hgflow
Description: A Commitlint shared standard configuration.
Author: ifanrX Team
Latest version: 1.3.0

# 规范

遵循 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 规范

```plaintext
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>`
<footer>
```

# 说明

- feat: 新功能
- fix: 修复 bug
- chore: 杂活
- refactor: 重构或代码优化
- style: 代码格式类的修改
- build: 打包构建相关
- test: 测试相关
- revert: 回退版本
- docs: 只修改文档或注释
- perf: 性能优化
- ci: ci 配置

# 使用方法

```
pnpm install @ifanrx/commitlint-config-standard-hgflow @commitlint/cli -D
```

```js
// .commitlintrc.js
module.exports = {
  extends: ['@ifanrx/commitlint-config-standard-hgflow'],
}
```

# scope-enum

按各项目自行设定，例：

```js
module.exports = {
  rules: {
    'scope-enum': [2, 'always', ['miniapp', 'dashboard', 'faas']],
  },
}
```
npm package: @ifanrx/eslint-config-standard
Description: An ESLint shared standard configuration.
Author: ifanrX Team
Latest version: 1.3.0

# 说明

`@ifanrx/eslint-config-standard` 仅针对 JavaScript 项目。

如果是 TypeScript 项目，请使用 `@ifanrx/eslint-config-standard-ts`。

# 注意事项

`.eslintrc.js` 配置文件的 `extends` 中，`@ifanrx/standard` 总是放在最后一个。

# 使用方法

## 路径别名

路径别名依赖 `eslint-import-resolver-typescript`，已封装到 `@ifanrx/eslint-config-standard/init` 和 `@ifanrx/eslint-config-standard-ts/init` 提供的 `init()` 函数中。

使用时应先配置 `tsconfig.json` 的 `compilerOptions.paths`，然后将 `.eslintrc.js` 的配置传入 `init()` 函数中。

```json
// tsconfig.json
{
  "compilerOptions": {
    "paths": {
      "@/*": "./src/*"
    }
  }
}
```

```js
// .eslintrc.js
const {init} = require('@ifanrx/eslint-config-standard/init')

module.exports = init({
  root: true,
  extends: ['@ifanrx/standard'],
})
```

## 单独使用

```
pnpm install @ifanrx/eslint-config-standard -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard'],
}
```

## React 项目中使用

```
pnpm install @ifanrx/eslint-config-standard @ifanrx/eslint-config-standard-react -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-react', '@ifanrx/standard'],
}
```

## Vue 项目中使用

```
pnpm install @ifanrx/eslint-config-standard @ifanrx/eslint-config-standard-vue -D
```

```js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue', '@ifanrx/standard'],
}
```

## 小程序项目中使用

```
pnpm install @ifanrx/eslint-config-standard @ifanrx/eslint-config-standard-wxml -D
```

```js
module.exports = {
  extends: ['@ifanrx/standard-wxml', '@ifanrx/standard'],
}
```
npm package: @ifanrx/eslint-config-standard-jsdoc
Description: An ESLint shared standard configuration for jsdoc.
Author: ifanrX Team
Latest version: 1.3.1

# 使用方法

```
pnpm install @ifanrx/eslint-config-standard-jsdoc -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-jsdoc'],
}
```
npm package: @ifanrx/eslint-config-standard-react
Description: An ESLint shared standard configuration for React.
Author: ifanrX Team
Latest version: 1.3.0

# 说明

`@ifanrx/eslint-config-standard-react` 总是与 `@ifanrx/eslint-config-standard` 或 `@ifanrx/eslint-config-standard-ts` 搭配使用。

`.eslintrc.js` 配置文件的 `extends` 中，`@ifanrx/standard` 或 `@ifanrx/standard-ts` 总是放在最后一个。

# 使用方法

## React + JavaScript

```
pnpm install @ifanrx/eslint-config-standard-react @ifanrx/eslint-config-standard -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-react', '@ifanrx/standard'],
}
```

## React + TypeScript

```
pnpm install @ifanrx/eslint-config-standard-react @ifanrx/eslint-config-standard-ts -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-react', '@ifanrx/standard-ts'],
}
```
npm package: @ifanrx/eslint-config-standard-ts
Description: An ESLint shared standard configuration for TypeScript.
Author: ifanrX Team
Latest version: 1.3.0

# 说明

`@ifanrx/eslint-config-standard-ts` 仅针对 TypeScript 项目。

如果是 JavaScript 项目，请使用 `@ifanrx/eslint-config-standard`。

# 注意事项

`.eslintrc.js` 配置文件的 `extends` 中，`@ifanrx/standard-ts` 总是放在最后一个。

# 使用方法

## 路径别名和 `parserOptions.project` 自动配置

- `@typescript-lint/parser` 要求配置 `.eslintrc.js` 的 `parserOptions.project`
- 路径别名依赖 `eslint-import-resolver-typescript`，要求配置 `tsconfig.json` 的 `compilerOptions.paths`

两者都已封装到 `@ifanrx/eslint-config-standard-ts/init` 和 `@ifanrx/eslint-config-standard/init` 提供的 `init()` 函数中。

使用时应将 `.eslintrc.js` 的配置传入 `init()` 函数中。

```js
// .eslintrc.js
const {init} = require('@ifanrx/eslint-config-standard/init')

module.exports = init({
  root: true,
  extends: ['@ifanrx/standard'],
})
```

如果需要配置路径别名，应配置 `tsconfig.json` 的 `compilerOptions.paths`。

```json
// tsconfig.json
{
  "compilerOptions": {
    "paths": {
      "@/*": "./src/*"
    }
  }
}
```

## 单独使用

```
pnpm install @ifanrx/eslint-config-standard-ts -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-ts'],
}
```

## React 项目中使用

```
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-react -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-react', '@ifanrx/standard-ts'],
}
```

## Vue 项目中使用

```
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-vue -D
```

```js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue', '@ifanrx/standard-ts'],
}
```

## 小程序项目中使用

```
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-wxml -D
```

```js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-wxml', '@ifanrx/standard-ts'],
}
```
npm package: @ifanrx/eslint-config-standard-vue
Description: An ESLint shared standard configuration for Vue.
Author: ifanrX Team
Latest version: 1.3.0

# 说明

`@ifanrx/eslint-config-standard-vue` 总是与 `@ifanrx/eslint-config-standard` 或 `@ifanrx/eslint-config-standard-ts` 搭配使用。

`.eslintrc.js` 配置文件的 `extends` 中，`@ifanrx/standard` 或 `@ifanrx/standard-ts` 总是放在最后一个。

# 使用方法

## Vue3 + JavaScript

```
pnpm install @ifanrx/eslint-config-standard-vue @ifanrx/eslint-config-standard -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue', '@ifanrx/standard'],
}
```

## Vue3 + TypeScript

```
pnpm install @ifanrx/eslint-config-standard-vue @ifanrx/eslint-config-standard-ts -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue', '@ifanrx/standard-ts'],
}
```

## Vue2 + JavaScript

```
pnpm install @ifanrx/eslint-config-standard-vue @ifanrx/eslint-config-standard -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue/vue2', '@ifanrx/standard'],
}
```

## Vue2 + TypeScript

```
pnpm install @ifanrx/eslint-config-standard-vue @ifanrx/eslint-config-standard-ts -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-vue/vue2', '@ifanrx/standard-ts'],
}
```
npm package: @ifanrx/eslint-config-standard-wxml
Description: An ESLint shared standard configuration for WXML.
Author: ifanrX Team
Latest version: 1.3.0

# 说明

`@ifanrx/eslint-config-standard-wxml` 总是与 `@ifanrx/eslint-config-standard` 或 `@ifanrx/eslint-config-standard-ts` 搭配使用。

`.eslintrc.js` 配置文件的 `extends` 中，`@ifanrx/standard` 或 `@ifanrx/standard-ts` 总是放在最后一个。

# 使用方法

## 微信小程序 + JavaScript

```
pnpm install @ifanrx/eslint-config-standard-wxml @ifanrx/eslint-config-standard -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-wxml', '@ifanrx/standard'],
}
```

## 微信小程序 + TypeScript

```
pnpm install @ifanrx/eslint-config-standard-wxml @ifanrx/eslint-config-standard-ts -D
```

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ['@ifanrx/standard-wxml', '@ifanrx/standard-ts'],
}
```