@fabdeh/eslint-config 0.1.2 → 0.1.3

package/dist/index.cjs

@@ -2,6 +2,7 @@
 
 const tseslint = require('typescript-eslint');
 const node_fs = require('node:fs');
+const promises = require('node:fs/promises');
 const node_path = require('node:path');
 const process = require('node:process');
 const node_url = require('node:url');
@@ -168,6 +169,19 @@ async function ensurePackages(packages) {
     await import('@antfu/install-pkg').then((i) => i.installPackage(nonExistingPackages, { dev: true }));
   }
 }
+async function findNearestPackageJsonName(directoryPath = node_path.resolve()) {
+  try {
+    const packageJsonPath = node_path.join(directoryPath, "package.json");
+    const packageJsonData = JSON.parse(await promises.readFile(packageJsonPath, "utf8"));
+    return packageJsonData.name;
+  } catch {
+    const parentDir = node_path.dirname(directoryPath);
+    if (directoryPath === parentDir) {
+      throw new Error("No package.json file found.");
+    }
+    return findNearestPackageJsonName(parentDir);
+  }
+}
 
 async function angular(options = {}) {
   const angularEslint = await interopDefault(import('angular-eslint'));
@@ -672,28 +686,6 @@ async function markdown(options = {}) {
     files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
-  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: []
-      }
-    })
-  };
   const markdownPlugin = await interopDefault(import('@eslint/markdown'));
   return tseslint__default.config(
     {
@@ -711,14 +703,6 @@ async function markdown(options = {}) {
         eslintMergeProcessors.processorPassThrough
       ])
     },
-    {
-      name: "fabdeh/markdown/parser",
-      language: "markdown/gfm",
-      languageOptions: {
-        parser: parserPlain
-      },
-      files
-    },
     {
       name: "fabdeh/markdown/disables",
       languageOptions: {
@@ -936,7 +920,8 @@ const SORT_UNION_OR_INTERSECTION_GROUPS = [
   "unknown"
 ];
 
-function perfectionist() {
+async function perfectionist() {
+  const tsconfigRootDir = await findNearestPackageJsonName() === "@fabdeh/eslint-config" ? undefined : getWorkspaceRoot(process__default.cwd(), process__default.cwd());
   return tseslint__default.config({
     name: "fabdeh/perfectionist/rules",
     plugins: {
@@ -948,7 +933,7 @@ function perfectionist() {
         "error",
         {
           groups: SORT_IMPORT_GROUPS,
-          tsconfigRootDir: getWorkspaceRoot(process__default.cwd(), process__default.cwd()),
+          tsconfigRootDir,
           order: "asc",
           type: "natural",
           newlinesBetween: "never"
@@ -1409,6 +1394,7 @@ function unicorn(options = {}) {
   return tseslint__default.config({
     name: "fabdeh/unicorn/rules",
     plugins: { unicorn: unicornPlugin__default },
+    files: [GLOB_SRC],
     rules: {
       ...options.allRecommended ? unicornPlugin__default.configs["flat/recommended"].rules : {
         "unicorn/catch-error-name": "error",
@@ -1976,6 +1962,7 @@ exports.angular = angular;
 exports.comments = comments;
 exports.createConfig = createConfig;
 exports.ensurePackages = ensurePackages;
+exports.findNearestPackageJsonName = findNearestPackageJsonName;
 exports.getWorkspaceRoot = getWorkspaceRoot;
 exports.ignores = ignores;
 exports.imports = imports;

package/dist/index.d.cts

@@ -557,12 +557,13 @@ declare function ngrx(options?: NgrxOptions): Promise<ConfigArray>;
  *
  * This configuration includes rules for sorting various elements in the codebase
  * such as exports, imports, intersection types, named exports, named imports,
- * switch cases, and union types. The sorting order is set to ascending and the
+ * switch cases, and union types. The sorting order is set to "ascending" and the
  * type is natural.
  *
  * @returns The configuration array for the "perfectionist" plugin.
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function perfectionist(): ConfigArray;
+declare function perfectionist(): Promise<ConfigArray>;
 
 /**
  * Configures ESLint rules for sorting keys and array values in `package.json` files.
@@ -778,5 +779,12 @@ declare function isPackageInScope(name: string): boolean;
  * @returns A promise that resolves when the operation is complete.
  */
 declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
+/**
+ * Search for the nearest package.json file and return the `name` property value.
+ *
+ * @param directoryPath - The folder to start from (default to current working directory).
+ * @returns The name of the nearest package.json
+ */
+declare function findNearestPackageJsonName(directoryPath?: string): Promise<string>;
 
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type IsInEditorOptions, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, 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 IsInEditorOptions, 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, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };

package/dist/index.d.mts

@@ -557,12 +557,13 @@ declare function ngrx(options?: NgrxOptions): Promise<ConfigArray>;
  *
  * This configuration includes rules for sorting various elements in the codebase
  * such as exports, imports, intersection types, named exports, named imports,
- * switch cases, and union types. The sorting order is set to ascending and the
+ * switch cases, and union types. The sorting order is set to "ascending" and the
  * type is natural.
  *
  * @returns The configuration array for the "perfectionist" plugin.
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function perfectionist(): ConfigArray;
+declare function perfectionist(): Promise<ConfigArray>;
 
 /**
  * Configures ESLint rules for sorting keys and array values in `package.json` files.
@@ -778,5 +779,12 @@ declare function isPackageInScope(name: string): boolean;
  * @returns A promise that resolves when the operation is complete.
  */
 declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
+/**
+ * Search for the nearest package.json file and return the `name` property value.
+ *
+ * @param directoryPath - The folder to start from (default to current working directory).
+ * @returns The name of the nearest package.json
+ */
+declare function findNearestPackageJsonName(directoryPath?: string): Promise<string>;
 
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type IsInEditorOptions, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, 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 IsInEditorOptions, 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, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };

package/dist/index.d.ts

@@ -557,12 +557,13 @@ declare function ngrx(options?: NgrxOptions): Promise<ConfigArray>;
  *
  * This configuration includes rules for sorting various elements in the codebase
  * such as exports, imports, intersection types, named exports, named imports,
- * switch cases, and union types. The sorting order is set to ascending and the
+ * switch cases, and union types. The sorting order is set to "ascending" and the
  * type is natural.
  *
  * @returns The configuration array for the "perfectionist" plugin.
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function perfectionist(): ConfigArray;
+declare function perfectionist(): Promise<ConfigArray>;
 
 /**
  * Configures ESLint rules for sorting keys and array values in `package.json` files.
@@ -778,5 +779,12 @@ declare function isPackageInScope(name: string): boolean;
  * @returns A promise that resolves when the operation is complete.
  */
 declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
+/**
+ * Search for the nearest package.json file and return the `name` property value.
+ *
+ * @param directoryPath - The folder to start from (default to current working directory).
+ * @returns The name of the nearest package.json
+ */
+declare function findNearestPackageJsonName(directoryPath?: string): Promise<string>;
 
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type IsInEditorOptions, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, 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 IsInEditorOptions, 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, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import tseslint from 'typescript-eslint';
 import { statSync } from 'node:fs';
-import { dirname, join } from 'node:path';
+import { readFile } from 'node:fs/promises';
+import { resolve, dirname, join } from 'node:path';
 import process from 'node:process';
 import { fileURLToPath } from 'node:url';
 import { isPackageExists } from 'local-pkg';
@@ -139,6 +140,19 @@ async function ensurePackages(packages) {
     await import('@antfu/install-pkg').then((i) => i.installPackage(nonExistingPackages, { dev: true }));
   }
 }
+async function findNearestPackageJsonName(directoryPath = resolve()) {
+  try {
+    const packageJsonPath = join(directoryPath, "package.json");
+    const packageJsonData = JSON.parse(await readFile(packageJsonPath, "utf8"));
+    return packageJsonData.name;
+  } catch {
+    const parentDir = dirname(directoryPath);
+    if (directoryPath === parentDir) {
+      throw new Error("No package.json file found.");
+    }
+    return findNearestPackageJsonName(parentDir);
+  }
+}
 
 async function angular(options = {}) {
   const angularEslint = await interopDefault(import('angular-eslint'));
@@ -643,28 +657,6 @@ async function markdown(options = {}) {
     files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
-  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: []
-      }
-    })
-  };
   const markdownPlugin = await interopDefault(import('@eslint/markdown'));
   return tseslint.config(
     {
@@ -682,14 +674,6 @@ async function markdown(options = {}) {
         processorPassThrough
       ])
     },
-    {
-      name: "fabdeh/markdown/parser",
-      language: "markdown/gfm",
-      languageOptions: {
-        parser: parserPlain
-      },
-      files
-    },
     {
       name: "fabdeh/markdown/disables",
       languageOptions: {
@@ -907,7 +891,8 @@ const SORT_UNION_OR_INTERSECTION_GROUPS = [
   "unknown"
 ];
 
-function perfectionist() {
+async function perfectionist() {
+  const tsconfigRootDir = await findNearestPackageJsonName() === "@fabdeh/eslint-config" ? undefined : getWorkspaceRoot(process.cwd(), process.cwd());
   return tseslint.config({
     name: "fabdeh/perfectionist/rules",
     plugins: {
@@ -919,7 +904,7 @@ function perfectionist() {
         "error",
         {
           groups: SORT_IMPORT_GROUPS,
-          tsconfigRootDir: getWorkspaceRoot(process.cwd(), process.cwd()),
+          tsconfigRootDir,
           order: "asc",
           type: "natural",
           newlinesBetween: "never"
@@ -1380,6 +1365,7 @@ function unicorn(options = {}) {
   return tseslint.config({
     name: "fabdeh/unicorn/rules",
     plugins: { unicorn: unicornPlugin },
+    files: [GLOB_SRC],
     rules: {
       ...options.allRecommended ? unicornPlugin.configs["flat/recommended"].rules : {
         "unicorn/catch-error-name": "error",
@@ -1937,4 +1923,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, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, 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, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fabdeh/eslint-config",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "packageManager": "pnpm@10.0.0",
   "description": "My personal eslint config preset",
   "author": "Fabien Dehopré <fabien@dehopre.dev> (https://github.com/FabienDehopre)",
@@ -104,6 +104,7 @@
     "@prettier/plugin-xml": "^3.4.1",
     "@types/node": "^22.13.1",
     "bumpp": "^10.0.2",
+    "changelogithub": "^13.12.1",
     "commitizen": "^4.3.1",
     "eslint": "^9.19.0",
     "eslint-plugin-format": "^1.0.1",