@softide/eslint-config v1.0.3

📦 @softide/eslint-config

这是一个可共享的 eslint 配置包，提供了一套标准的 JavaScript/TypeScript 代码规范，支持 Vue2/Vue3、TypeScript、uni-app 等项目。

⚠ 暂不支持 eslint >= 9.0.0，推荐安装 eslint@8.57.1

📥 安装

这个配置包依赖于 eslint 和相关插件。因此你需要确保这些包也被安装。

你可以使用 npm、yarn 或 pnpm 等包管理器安装：

• npm

npm install -D @softide/eslint-config eslint@8.57.1 @stylistic/eslint-plugin@3.1.0

• yarn

yarn add -D @softide/eslint-config eslint@8.57.1 @stylistic/eslint-plugin@3.1.0

• pnpm

pnpm add -D @softide/eslint-config eslint@8.57.1 @stylistic/eslint-plugin@3.1.0

📖 使用方法

在你的项目根目录下创建 .eslintrc.cjs 文件，并根据你的项目类型选择相应的配置：

基础配置

module.exports = {
  extends: [
      "@softide/eslint-config/base"
  ]
};

typescript

• 需要额外安装：

pnpm add -D @typescript-eslint/eslint-plugin@^5.58.0

• 配置方式:

module.exports = {
  extends: [
    "@softide/eslint-config/base",
    "@softide/eslint-config/typescript"
  ]
};

vue3

• 需要额外安装：

pnpm add -D eslint-plugin-vue@^9.19.2

• 配置方式:

module.exports = {
  extends: [
    "@softide/eslint-config/base",
    "@softide/eslint-config/vue3"
  ]
};

vue2

• 需要额外安装：

pnpm add -D eslint-plugin-vue@^9.19.2

• 配置方式:

module.exports = {
  extends: [
    "@softide/eslint-config/base",
    "@softide/eslint-config/vue2"
  ]
};

uni-app

• 配置方式:

module.exports = {
  extends: [
    "@softide/eslint-config/base",
    "@softide/eslint-config/uni-app",
    "@softide/eslint-config/typescript", // 如果项目使用 typescript
    "@softide/eslint-config/vue3", // 如果项目使用 vue3
    "@softide/eslint-config/vue2", // 如果项目使用 vue2
  ]
};

vue + prettier

• 需要额外安装：

pnpm add -D eslint-plugin-prettier-vue@^4.2.0

• 配置方式:

module.exports = {
  extends: [
    // ...其他配置
    "@softide/eslint-config/prettier-vue"
  ]
};

更多相关信息请阅读 Eslint 配置 和 Eslint 共享配置