@fabdeh/eslint-config 0.2.0 → 0.2.1

package/dist/index.d.mts

@@ -187,7 +187,7 @@ interface StylisticOptions {
  */
 interface TypeScriptParserOptions {
     /**
-     * Optional parser options to be used by the TypeScript parser.
+     * Additional parser options for TypeScript.
      */
     parserOptions?: TSESLint.FlatConfig.ParserOptions;
 }
@@ -307,7 +307,7 @@ interface CreateConfigOptions {
      *
      * @default auto-detected
      */
-    typescript?: OverridesOptions & TypeScriptParserOptions;
+    typescript?: boolean | (OverridesOptions & TypeScriptParserOptions);
     /**
      * Enable stylistic rules.
      *
@@ -729,5 +729,14 @@ declare function ensurePackages(packages: (string | undefined)[]): Promise<void>
  * @returns The name of the nearest package.json
  */
 declare function findNearestPackageJsonName(directoryPath?: string): Promise<string>;
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+/**
+ * Returns the object representation of the configuration or an empty object if it is a boolean.
+ *
+ * @param options - The {@link CreateConfigOptions} object to extract the sub-options from.
+ * @param key - The property name.
+ * @returns An object representing the required options.
+ */
+declare function resolveSubOptions<K extends keyof CreateConfigOptions>(options: CreateConfigOptions, key: K): ResolvedOptions<CreateConfigOptions[K]>;
 
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };
+export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type NgrxOperators, type NgrxOptions, type OverridesOptions, type ResolvedOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, resolveSubOptions, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };

package/dist/index.mjs

@@ -10,8 +10,8 @@ import preferArrowFunctions from 'eslint-plugin-prefer-arrow-functions';
 import unusedImports from 'eslint-plugin-unused-imports';
 import globals from 'globals';
 import eslintComments from '@eslint-community/eslint-plugin-eslint-comments';
-import * as importX from 'eslint-plugin-import-x';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
+import * as importX from 'eslint-plugin-import-x';
 import perfectionistPlugin from 'eslint-plugin-perfectionist';
 import unicornPlugin from 'eslint-plugin-unicorn';
 import { mergeProcessors, processorPassThrough } from 'eslint-merge-processors';
@@ -135,6 +135,12 @@ async function findNearestPackageJsonName(directoryPath = resolve()) {
     return findNearestPackageJsonName(parentDir);
   }
 }
+function resolveSubOptions(options, key) {
+  if (typeof options[key] === "boolean") {
+    return {};
+  }
+  return options[key] ?? {};
+}
 
 async function angular(options = {}) {
   const angularEslint = await interopDefault(import('angular-eslint'));
@@ -246,7 +252,6 @@ async function angular(options = {}) {
 function comments() {
   return tseslint.config({
     name: "fabdeh/comments/rules",
-    files: [GLOB_SRC],
     plugins: {
       "@eslint-community/eslint-comments": eslintComments
     },
@@ -272,8 +277,7 @@ function imports(options = {}) {
   const { stylistic = true } = options;
   return tseslint.config(
     {
-      name: "fabdeh/imports/common/rules",
-      files: [GLOB_SRC],
+      name: "fabdeh/imports/rules",
       plugins: {
         "import-x": importX
       },
@@ -282,7 +286,9 @@ function imports(options = {}) {
         "import-x/default": "error",
         "import-x/export": "error",
         "import-x/first": "error",
+        "import-x/named": "error",
         "import-x/no-absolute-path": "error",
+        "import-x/no-deprecated": "error",
         "import-x/no-duplicates": "error",
         "import-x/no-empty-named-blocks": "error",
         "import-x/no-extraneous-dependencies": "error",
@@ -299,15 +305,7 @@ function imports(options = {}) {
       }
     },
     {
-      name: "fabdeh/imports/js-only/rules",
-      files: [GLOB_JS],
-      rules: {
-        "import-x/named": "error",
-        "import-x/no-deprecated": "error"
-      }
-    },
-    {
-      name: "fabdeh/imports/ts-only/rules",
+      name: "fabdeh/imports/ts-disables",
       files: [GLOB_TS],
       rules: {
         "import-x/named": "off",
@@ -332,7 +330,6 @@ function javascript(options = {}) {
           navigator: "readonly",
           window: "readonly"
         },
-        parser: tseslint.parser,
         parserOptions: {
           ecmaFeatures: {
             jsx: true
@@ -348,7 +345,6 @@ function javascript(options = {}) {
     },
     {
       name: "fabdeh/javascript/rules",
-      files: [GLOB_SRC],
       plugins: {
         "@typescript-eslint": tseslint.plugin,
         "prefer-arrow-functions": preferArrowFunctions,
@@ -475,7 +471,6 @@ function jsdoc(options = {}) {
   return tseslint.config(
     {
       name: "fabdeh/jsdoc/rules",
-      files: [GLOB_SRC],
       plugins: { jsdoc: jsdocPlugin },
       rules: {
         "jsdoc/check-access": "warn",
@@ -602,6 +597,28 @@ async function markdown(options = {}) {
     overrides = {}
   } = options;
   const markdownPlugin = await interopDefault(import('@eslint/markdown'));
+  const parserPlain = {
+    meta: {
+      name: "parser-plain"
+    },
+    parseForESLint: (code) => ({
+      ast: {
+        body: [],
+        comments: [],
+        loc: { end: code.length, start: 0 },
+        range: [0, code.length],
+        tokens: [],
+        type: "Program"
+      },
+      // eslint-disable-next-line unicorn/no-null
+      scopeManager: null,
+      services: { isPlain: true },
+      visitorKeys: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        Program: []
+      }
+    })
+  };
   return tseslint.config(
     {
       name: "fabdeh/markdown/setup",
@@ -616,16 +633,18 @@ async function markdown(options = {}) {
       processor: mergeProcessors([
         markdownPlugin.processors.markdown,
         processorPassThrough
-      ]),
-      rules: {
-        ...markdownPlugin.configs.recommended.at(0)?.rules,
-        "markdown/no-duplicate-headings": "error"
+      ])
+    },
+    {
+      name: "fabdeh/markdown/parser",
+      files,
+      languageOptions: {
+        parser: parserPlain
       }
     },
     {
       name: "fabdeh/markdown/disables",
       languageOptions: {
-        parser: tseslint.parser,
         parserOptions: {
           ecmaFeatures: {
             impliedStrict: true
@@ -659,9 +678,16 @@ async function markdown(options = {}) {
         "unicode-bom": "off",
         "unused-imports/no-unused-imports": "off",
         "unused-imports/no-unused-vars": "off",
-        "unicorn/filename-case": "off",
         ...overrides
       }
+    },
+    {
+      name: "fabdeh/markdown/rules",
+      files,
+      rules: {
+        ...markdownPlugin.configs.recommended.at(0)?.rules,
+        "markdown/no-duplicate-headings": "error"
+      }
     }
   );
 }
@@ -865,7 +891,6 @@ async function perfectionist() {
   const tsconfigRootDir = await findNearestPackageJsonName() === "@fabdeh/eslint-config" ? void 0 : getWorkspaceRoot(process.cwd(), process.cwd());
   return tseslint.config({
     name: "fabdeh/perfectionist/rules",
-    files: [GLOB_SRC],
     plugins: {
       perfectionist: perfectionistPlugin
     },
@@ -1143,7 +1168,6 @@ async function stylistic(options = {}) {
   const config = stylisticPlugin.configs.customize({ ...stylisticOptions, flat: true });
   return tseslint.config({
     name: "fabdeh/stylistic/rules",
-    files: [GLOB_SRC],
     plugins: {
       "@stylistic": stylisticPlugin
     },
@@ -1249,27 +1273,36 @@ const memberOrdering = {
 };
 
 function typescript(options = {}) {
-  const { stylistic = true, parserOptions, overrides } = options;
+  const { stylistic = true, parserOptions = {}, overrides = {} } = options;
   return tseslint.config(
     {
       name: "fabdeh/typescript/setup",
+      files: [GLOB_TS],
+      ignores: [`${GLOB_MARKDOWN}/**`],
       languageOptions: {
-        parserOptions: parserOptions ?? {
-          projectService: true,
-          tsconfigRootDir: getWorkspaceRoot(process.cwd(), process.cwd())
+        parser: tseslint.parser,
+        parserOptions: {
+          sourceType: "module",
+          projectService: {
+            allowDefaultProject: ["*.js"],
+            defaultProject: "tsconfig.json"
+          },
+          tsconfigRootDir: getWorkspaceRoot(process.cwd(), process.cwd()),
+          ...parserOptions
         }
       }
     },
     {
       name: "fabdeh/typescript/rules",
       files: [GLOB_TS],
+      ignores: [`${GLOB_MARKDOWN}/**`],
       plugins: {
         "@typescript-eslint": tseslint.plugin,
         "unused-imports": unusedImports
       },
       rules: {
-        ...tseslint.configs.stylisticTypeChecked.find((c) => c.name === "typescript-eslint/eslint-recommended")?.rules,
-        ...tseslint.configs.stylisticTypeChecked.find((c) => c.name === "typescript-eslint/strict-type-checked")?.rules,
+        ...tseslint.configs.strictTypeChecked.find((c) => c.name === "typescript-eslint/eslint-recommended")?.rules,
+        ...tseslint.configs.strictTypeChecked.find((c) => c.name === "typescript-eslint/strict-type-checked")?.rules,
         ...stylistic ? tseslint.configs.stylisticTypeChecked.find((c) => c.name === "typescript-eslint/stylistic-type-checked")?.rules : {},
         "@typescript-eslint/array-type": ["error", { default: "array" }],
         "@typescript-eslint/consistent-indexed-object-style": "error",
@@ -1342,7 +1375,6 @@ function unicorn(options = {}) {
   return tseslint.config({
     name: "fabdeh/unicorn/rules",
     plugins: { unicorn: unicornPlugin },
-    files: [GLOB_SRC],
     rules: {
       ...options.allRecommended ? unicornPlugin.configs.recommended.rules : {
         "unicorn/catch-error-name": "error",
@@ -1354,7 +1386,7 @@ function unicorn(options = {}) {
         "unicorn/error-message": "error",
         "unicorn/escape-case": "error",
         "unicorn/explicit-length-check": "error",
-        "unicorn/filename-case": ["error", { case: "kebabCase" }],
+        "unicorn/filename-case": ["error", { case: "kebabCase", ignore: [/^[A-Z0-9_-]+\.md$/] }],
         "unicorn/new-for-builtins": "error",
         "unicorn/no-abusive-eslint-disable": "error",
         "unicorn/no-anonymous-default-export": "error",
@@ -1563,10 +1595,12 @@ function mergePrettierOptions(options, overrides = {}) {
   return {
     ...options,
     ...overrides,
+    /* eslint-disable @typescript-eslint/no-unsafe-assignment */
     plugins: [
       ...overrides.plugins ?? [],
       ...options.plugins ?? []
     ]
+    /* eslint-enable @typescript-eslint/no-unsafe-assignment */
   };
 }
 async function formatters(options = {}, stylistic = {}) {
@@ -1788,6 +1822,7 @@ async function createConfig(options = {}, ...userConfigs) {
     gitignore: enableGitignore = true,
     ngrx: enableNgrx = NGRX_PACKAGES.some((p) => isPackageExists(p)),
     tailwindcss: enableTailwind = isPackageExists("tailwindcss"),
+    typescript: enableTypescript = isPackageExists("typescript"),
     unicorn: enableUnicorn = true,
     vitest: enableVitest = isPackageExists("vitest")
   } = options;
@@ -1811,38 +1846,47 @@ async function createConfig(options = {}, ...userConfigs) {
   configs.push(
     ignores(options.ignores),
     javascript({ overrides: options.javascript?.overrides }),
-    typescript({
-      stylistic: stylisticOptions,
-      parserOptions: options.typescript?.parserOptions,
-      overrides: options.typescript?.overrides
-    }),
     comments(),
-    imports({ stylistic: stylisticOptions }),
+    // TODO: add node rules ???
     jsdoc({ stylistic: stylisticOptions }),
+    imports({ stylistic: stylisticOptions }),
     perfectionist()
   );
   if (enableUnicorn) {
-    configs.push(unicorn(typeof enableUnicorn === "object" ? enableUnicorn : {}));
+    const unicornOptions = resolveSubOptions(options, "unicorn");
+    configs.push(unicorn(unicornOptions));
+  }
+  if (enableTypescript) {
+    const typescriptOptions = resolveSubOptions(options, "typescript");
+    configs.push(typescript({
+      ...typescriptOptions,
+      stylistic: stylisticOptions
+    }));
   }
   if (stylisticOptions) {
     configs.push(stylistic({ stylistic: stylisticOptions }));
   }
   if (enableAngular) {
-    configs.push(angular(typeof enableAngular === "object" ? enableAngular : {}));
+    const angularOptions = resolveSubOptions(options, "angular");
+    configs.push(angular(angularOptions));
   }
   if (enableNgrx) {
-    configs.push(ngrx(typeof enableNgrx === "object" ? enableNgrx : {}));
+    const ngrxOptions = resolveSubOptions(options, "ngrx");
+    configs.push(ngrx(ngrxOptions));
   }
   if (enableVitest) {
-    configs.push(vitest(typeof enableVitest === "object" ? enableVitest : {}));
+    const vitestOptions = resolveSubOptions(options, "vitest");
+    configs.push(vitest(vitestOptions));
   }
   if (enableTailwind) {
-    configs.push(tailwindcss(typeof enableTailwind === "object" ? enableTailwind : {}));
+    const tailwindcssOptions = resolveSubOptions(options, "tailwindcss");
+    configs.push(tailwindcss(tailwindcssOptions));
   }
   if (options.jsonc ?? true) {
+    const jsoncOptions = resolveSubOptions(options, "jsonc");
     configs.push(
       jsonc({
-        overrides: typeof options.jsonc === "object" ? options.jsonc.overrides : {},
+        ...jsoncOptions,
         stylistic: stylisticOptions
       }),
       sortPackageJson(),
@@ -1850,21 +1894,22 @@ async function createConfig(options = {}, ...userConfigs) {
     );
   }
   if (options.yaml ?? true) {
+    const yamlOptions = resolveSubOptions(options, "yaml");
     configs.push(yaml({
-      overrides: typeof options.yaml === "object" ? options.yaml.overrides : {},
+      ...yamlOptions,
       stylistic: stylisticOptions
     }));
   }
   if (options.toml ?? true) {
+    const tomlOptions = resolveSubOptions(options, "toml");
     configs.push(toml({
-      overrides: typeof options.toml === "object" ? options.toml.overrides : {},
+      ...tomlOptions,
       stylistic: stylisticOptions
     }));
   }
   if (options.markdown ?? true) {
-    configs.push(markdown({
-      overrides: typeof options.markdown === "object" ? options.markdown.overrides : {}
-    }));
+    const markdownOptions = resolveSubOptions(options, "markdown");
+    configs.push(markdown(markdownOptions));
   }
   if (options.formatters) {
     configs.push(formatters(options.formatters, typeof stylisticOptions === "boolean" ? {} : stylisticOptions));
@@ -1881,4 +1926,4 @@ async function createConfig(options = {}, ...userConfigs) {
   return tseslint.config(...await Promise.all(configs), ...await Promise.all(userConfigs));
 }
 
-export { GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, STYLISTIC_CONFIG_DEFAULT, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };
+export { GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, STYLISTIC_CONFIG_DEFAULT, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, resolveSubOptions, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fabdeh/eslint-config",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "packageManager": "pnpm@10.4.1",
   "description": "My personal eslint config preset",
   "author": {