@fenge/eslint-config 0.4.0 → 0.5.0

package/src/config/packagejson.ts

@@ -15,6 +15,7 @@ export function packagejson() {
         "pkg-json/bottom-default": "error",
         "pkg-json/exact-dependency-version": "error",
         "pkg-json/no-conflict-types": "error",
+        "pkg-json/no-dependencies-in-workspace-root": "error",
         "pkg-json/no-lifecycle-script": "error",
         "pkg-json/no-nonstandard-property": "error",
         "pkg-json/no-types-dependency-in-workspace-root": "error",
@@ -24,7 +25,6 @@ export function packagejson() {
         "pkg-json/required-hashbang": "error",
         "pkg-json/required-repository": "error",
         "pkg-json/type-module": "error",
-        "pkg-json/no-dependencies-in-workspace-root": "error",
         // "publint/suggestion": "error",
         "publint/warning": "error",
         "publint/error": "error",

package/src/config/ts/base.ts

@@ -81,9 +81,8 @@ export function getTsBase() {
       parserOptions: {
         ...jsBase.languageOptions.parserOptions,
         // Setting `projectService: true` or `project: true` is pretty slow when lint a monorepo with many tsconfig.json files in each sub-app.
-        // For a better performance, we are recommended using one tsconfig.json file in a project.
-        // Waiting for typescript-eslint to officially provide a better way to use `projectService`.
-        project: "tsconfig.json",
+        // But setting `project: "tsconfig.json"` will cause parser error when the project root tsconfig.json is `{ extends: "fenge/tsconfig" }`
+        projectService: true,
       },
     },
     plugins: {

package/src/config/ts/declaration.ts

@@ -3,6 +3,10 @@ export function getTsDeclaration() {
     name: "fenge/typescript/declaration",
     files: ["**/*.d.{ts,cts,mts,tsx}"],
     rules: {
+      "esm/no-empty-exports": "off",
+      "esm/no-side-effect-imports": "off",
+      "esm/no-ts-file-imports": "off",
+      "esm/required-exports": "off",
       "import/no-default-export": "off",
     },
   } as const;

package/src/eslint.config.ts

@@ -15,20 +15,18 @@ type JsRuleKey = keyof ReturnType<typeof javascript>[0]["rules"];
 type TsRuleKey = keyof ReturnType<typeof typescript>[0]["rules"];
 type PkgRuleKey = keyof ReturnType<typeof packagejson>[0]["rules"];
 
+type RuleValue = "error" | "warn" | "off" | ["error" | "warn", ...unknown[]];
 interface Options<T extends string[]> {
   pick?: NoDuplicate<T>;
   omit?: NoDuplicate<T>;
-  append?:
-    | Partial<
-        Record<
-          T[number],
-          "error" | "warn" | "off" | ["error" | "warn", ...unknown[]]
-        >
-      >
-    | Record<
-        string,
-        "error" | "warn" | "off" | ["error" | "warn", ...unknown[]]
-      >;
+}
+interface ConfigItem {
+  name: string;
+  files: string[];
+  plugins?: Record<string, object>;
+  rules:
+    | Partial<Record<PkgRuleKey | JsRuleKey | TsRuleKey, RuleValue>>
+    | Record<string, RuleValue>;
 }
 
 export type BuilderOptions = LinterOptions;
@@ -44,11 +42,8 @@ export class Builder {
   }
 
   private setup(
-    [mainConfig, ...otherConfigs]: readonly [
-      { plugins: object; rules: object },
-      ...object[],
-    ],
-    { pick, omit, append = {} }: Options<string[]>,
+    configItems: readonly { rules: object }[],
+    { pick, omit }: Options<string[]>,
   ) {
     const select = (ruleKey: string) => {
       if (!pick && !omit) {
@@ -61,31 +56,37 @@ export class Builder {
         throw new Error("You cannot specify both pick and omit");
       }
     };
-    const rules = Object.fromEntries(
-      Object.entries(mainConfig.rules).filter(([ruleKey]) => select(ruleKey)),
-    );
-    this.configs.push(
-      { ...mainConfig, rules: { ...rules, ...append } },
-      ...otherConfigs,
-    );
+    const result = configItems.map((configItem) => ({
+      ...configItem,
+      rules: Object.fromEntries(
+        Object.entries(configItem.rules).filter(([ruleKey]) => select(ruleKey)),
+      ),
+    }));
+    this.configs.push(...result);
+
     return this;
   }
 
-  enableTypescript<T extends TsRuleKey[]>(options: Options<T> = {}) {
+  enableTypeScript<T extends TsRuleKey[]>(options: Options<T> = {}) {
     return this.setup(typescript(), options);
   }
 
-  enableJavascript<T extends JsRuleKey[]>(options: Options<T> = {}) {
+  enableJavaScript<T extends JsRuleKey[]>(options: Options<T> = {}) {
     return this.setup(javascript(), options);
   }
 
-  enablePackagejson<T extends PkgRuleKey[]>(options: Options<T> = {}) {
+  enablePackageJson<T extends PkgRuleKey[]>(options: Options<T> = {}) {
     return this.setup(packagejson(), options);
   }
+
+  append(config: ConfigItem) {
+    this.configs.push(config);
+    return this;
+  }
 }
 
 export default new Builder()
-  .enablePackagejson()
-  .enableJavascript()
-  .enableTypescript()
+  .enablePackageJson()
+  .enableJavaScript()
+  .enableTypeScript()
   .toConfig();