@zjutjh/eslint-config 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,11 +1,17 @@
 import { Linter } from 'eslint';
 
-type Options = {
+type OverridesConfigs = {
+    vue?: Linter.RulesRecord;
+    ts?: Linter.RulesRecord;
+    stylistic?: Linter.RulesRecord;
+};
+type OptionsConfig = {
     vue?: boolean;
     ts?: boolean;
     taro?: boolean;
+    overrides?: OverridesConfigs;
 };
 
-declare function zjutjh(options?: Options): Promise<Linter.Config<Linter.RulesRecord>[]>;
+declare function zjutjh(options?: OptionsConfig): Promise<Linter.Config<Linter.RulesRecord>[]>;
 
 export { zjutjh as default };

package/dist/index.js

@@ -36,7 +36,6 @@ function javascript() {
         "no-warning-comments": "warn",
         "no-console": ["warn", { allow: ["warn", "error"] }],
         "no-var": "error",
-        // TODO:
         "no-undef": "off",
         "prefer-const": "warn"
       }
@@ -46,7 +45,7 @@ function javascript() {
 
 // src/configs/stylistic.ts
 import pluginStylistic from "@stylistic/eslint-plugin";
-function stylistic() {
+function stylistic(options) {
   return [
     {
       name: "zjutjh/stylistic/rules",
@@ -80,7 +79,8 @@ function stylistic() {
         }],
         "@stylistic/space-in-parens": "error",
         "@stylistic/space-infix-ops": "error",
-        "@stylistic/spaced-comment": "error"
+        "@stylistic/spaced-comment": "error",
+        ...options.overrides
       }
     }
   ];
@@ -95,9 +95,25 @@ async function interopDefault(m) {
   const resolved = await m;
   return resolved.default || resolved;
 }
+async function ensurePackages(packages) {
+  const nonExistingPackages = packages.filter((i) => i && !isPackageExists(i));
+  if (nonExistingPackages.length !== 0) {
+    const message = `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}.`;
+    throw new Error(message);
+  }
+}
+function getOverrides(options, key) {
+  return {
+    ...options.overrides?.[key]
+  };
+}
 
 // src/configs/vue.ts
 async function vue(options) {
+  await ensurePackages([
+    "eslint-plugin-vue",
+    "vue-eslint-parser"
+  ]);
   const [
     pluginVue,
     parserVue
@@ -134,14 +150,15 @@ async function vue(options) {
         "vue/multi-word-component-names": "warn",
         "vue/component-name-in-template-casing": ["error", "kebab-case", { "registeredComponentsOnly": true }],
         "vue/max-attributes-per-line": ["error", { "singleline": { "max": 3 } }],
-        "vue/prefer-true-attribute-shorthand": ["warn", options?.taro ? "never" : "always"]
+        "vue/prefer-true-attribute-shorthand": ["warn", options?.taro ? "never" : "always"],
+        ...options?.overrides
       }
     }
   ];
 }
 
 // src/configs/typescript.ts
-async function typescript() {
+async function typescript(options) {
   const [
     pluginTs,
     parserTs
@@ -183,28 +200,37 @@ async function typescript() {
           allowShortCircuit: true,
           allowTaggedTemplates: true,
           allowTernary: true
-        }]
+        }],
+        ...options.overrides
       }
     }
   ];
 }
 
 // src/factory.ts
-async function zjutjh(options) {
+async function zjutjh(options = {}) {
   const {
     vue: enableVue = isPackageExists2("vue"),
     ts: enableTs = isPackageExists2("typescript"),
-    taro: isTaroProj = isPackageExists2("@tarojs/taro")
-  } = options ?? {};
+    taro: enableTaro = isPackageExists2("@tarojs/taro")
+  } = options;
   const configs = [];
   configs.push(javascript());
-  configs.push(stylistic());
+  configs.push(
+    stylistic({ overrides: getOverrides(options, "stylistic") })
+  );
+  if (enableTs) configs.push(
+    await typescript({ overrides: getOverrides(options, "ts") })
+  );
   if (enableVue) {
     configs.push(
-      await vue({ ts: enableTs, taro: isTaroProj })
+      await vue({
+        ts: enableTs,
+        taro: enableTaro,
+        overrides: getOverrides(options, "vue")
+      })
     );
   }
-  if (enableTs) configs.push(await typescript());
   return configs.flat(1);
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zjutjh/eslint-config",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "ISC",
   "author": "zjutjh",
   "description": "Eslint config used by zjutjh",