feat: add @nutui/eslint-config (#2405)

Author: eiinu

.eslintignore

@@ -0,0 +1,11 @@
+{
+  "root": true,
+  "extends": ["@nutui/eslint-config"],
+  "ignorePatterns": [
+    "packages/nutui-playground/dist/**",
+    "packages/nutui-taro-demo/**/*",
+    "packages/nutui-touch-emulator/dist/**",
+    "packages/nutui-vscode-extension/dist/**",
+    "src/sites/**"
+  ]
+}

.eslintrc

@@ -11,17 +11,19 @@ config.nav.map((item) => {
     let { name, exclude, taro } = element;
     if (taro == true) {
       const filePath = path.join(`src/packages/__VUE/${name.toLowerCase()}/index.taro.vue`);
-      importStr += `import ${name} from './__VUE/${name.toLowerCase()}/index${
-        fs.existsSync(filePath) ? '.taro' : ''
-      }.vue';\n`;
+      if (name !== 'Icon') {
+        importStr += `import ${name} from './__VUE/${name.toLowerCase()}/index${
+          fs.existsSync(filePath) ? '.taro' : ''
+        }.vue';\n`;
+      }
       importScssStr += `import './__VUE/${name.toLowerCase()}/index.scss';\n`;
       if (exclude != true) {
         packages.push(name);
       }
     }
   });
 });
-let installFunction = `function install(app: any) {
+let installFunction = `function install(app: App) {
   const packages = [${packages.join(',')}];
   packages.forEach((item:any) => {
     if (item.install) {

jd/generate-nutui-taro-vue.cjs

@@ -10,7 +10,9 @@ const methods = [];
 config.nav.map((item) => {
   item.packages.forEach((element) => {
     let { name, type, exclude } = element;
-    importStr += `import ${name} from './__VUE/${name.toLowerCase()}/index.vue';\n`;
+    if (name !== 'Icon') {
+      importStr += `import ${name} from './__VUE/${name.toLowerCase()}/index.vue';\n`;
+    }
     if (type === 'methods') {
       importStr += `import { show${name} } from './__VUE/${name.toLowerCase()}/index';\n`;
       methods.push(`show${name}`);

jd/generate-nutui.cjs

@@ -56,8 +56,8 @@
     "test": "vitest",
     "test:ui": "vitest --ui --coverage",
     "test:c": "vitest --coverage",
-    "lint": "prettier --check .",
-    "lint:fix": "prettier --write .",
+    "lint": "eslint --ext .vue,.ts,.tsx,.js,.jsx src/",
+    "lint:fix": "pnpm lint --fix",
     "copydocs": "node ./jd/copymd.cjs",
     "attrs:taro": "node ./jd/createAttributes.cjs taro",
     "attrs": "node ./jd/createAttributes.cjs",
@@ -84,21 +84,15 @@
     "@napi-rs/canvas": "^0.1.39",
     "@tarojs/taro": "3.6.8",
     "@types/node": "^17.0.16",
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.60.1",
     "@vitejs/plugin-vue": "^4.2.0",
     "@vitejs/plugin-vue-jsx": "^3.0.1",
     "@vitest/coverage-v8": "^0.32.2",
     "@vitest/ui": "^0.32.2",
-    "@vue/eslint-config-prettier": "^7.1.0",
-    "@vue/eslint-config-typescript": "^11.0.3",
     "@vue/test-utils": "^2.4.0",
     "autoprefixer": "^10.3.4",
     "codesandbox": "^2.2.3",
     "eslint": "^8.44.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-vue": "^9.15.1",
-    "eslint-visitor-keys": "^3.4.1",
+    "@nutui/eslint-config": "workspace:*",
     "fs-extra": "^9.1.0",
     "highlight.js": "^11.8.0",
     "husky": "^6.0.0",
@@ -117,36 +111,16 @@
     "vue": "^3.3.4",
     "vue-tsc": "^1.8.4"
   },
-  "eslintConfig": {
-    "root": true,
-    "env": {
-      "node": true
-    },
-    "extends": [
-      "plugin:vue/vue3-essential",
-      "eslint:recommended",
-      "@vue/typescript/recommended",
-      "@vue/prettier",
-      "@vue/prettier/@typescript-eslint"
-    ],
-    "parserOptions": {
-      "ecmaVersion": 2020
-    },
-    "rules": {
-      "vue/no-unused-components": "off",
-      "no-debugger": "off"
-    }
-  },
   "engines": {
     "node": ">= 16.0.0",
     "pnpm": ">= 7.0.0"
   },
   "lint-staged": {
-    "*.md": "prettier --write",
-    "*.{ts,tsx,js,vue,scss}": "prettier --write"
+    "*.{ts,tsx,js,jsx,vue,scss,md}": "prettier --write",
+    "src/**/*.{ts,tsx,js,jsx,vue}": "eslint --fix"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/jdf2e/nutui.git"
   }
-}
+}

package.json

@@ -0,0 +1,20 @@
+# ESLint Config of NutUI Vue
+
+## Install
+
+```sh
+# pnpm
+pnpm add @nutui/eslint-config -D
+# npm
+npm i @nutui/eslint-config -D
+# yarn
+yarn add @nutui/eslint-config -D
+```
+
+## Usage
+
+```json
+{
+  "extends": "@nutui/eslint-config"
+}
+```

packages/nutui-eslint-config/README.md

@@ -0,0 +1,43 @@
+module.exports = {
+  extends: ['plugin:vue/base', 'eslint:recommended', 'plugin:vue/vue3-recommended', 'prettier'],
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  plugins: ['vue', '@typescript-eslint'],
+  env: {
+    es6: true,
+    node: true,
+    browser: true,
+    jest: true
+  },
+  globals: {
+    vi: true,
+    NodeJS: true,
+    TaroGeneral: true
+  },
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    // '@typescript-eslint/no-unused-vars': 'error',
+    // enable type: Function Object
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    'vue/no-v-html': 'off',
+    'vue/first-attribute-linebreak': 'off',
+    'vue/multi-word-component-names': 'off',
+    'vue/no-v-text-v-html-on-component': 'off',
+    // will be fixed
+    'vue/attributes-order': 'off',
+    'vue/attribute-hyphenation': 'off',
+    'vue/v-on-event-hyphenation': 'off',
+    'vue/v-slot-style': 'off',
+    'no-unused-vars': 'off',
+    'vue/valid-v-for': 'off',
+    'no-empty': 'off'
+  }
+};

packages/nutui-eslint-config/index.js

@@ -0,0 +1,38 @@
+{
+  "name": "@nutui/eslint-config",
+  "version": "0.0.1",
+  "description": "ESLint Config of NutUI Vue",
+  "keywords": [
+    "nutui",
+    "vue",
+    "eslint",
+    "jdf2e"
+  ],
+  "author": "jdf2e",
+  "license": "MIT",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jdf2e/nutui.git",
+    "directory": "packages/nutui-eslint-config"
+  },
+  "bugs": {
+    "url": "https://github.com/jdf2e/nutui/issues"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-vue": "^9.15.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.44.0"
+  },
+  "peerDependencies": {
+    "eslint": "^7.32.0 || ^8.44.0"
+  }
+}

packages/nutui-eslint-config/package.json

@@ -8,10 +8,10 @@ Touch Emulator for NutUI.
 
 ```sh
 # pnpm
-pnpm i @nutui/touch-emulator
+pnpm add @nutui/touch-emulator
 
 # npm
-npm i @nutui/touch-emulator
+npm install @nutui/touch-emulator
 
 # yarn
 yarn add @nutui/touch-emulator