@zayne-labs/eslint-config 0.11.7 → 0.11.8

package/dist/utils.d.ts

@@ -0,0 +1,139 @@
+import { D as TypedFlatConfigItem, t as Awaitable } from "./index-B9wn5XKH.js";
+import { ESLint } from "eslint";
+
+//#region src/utils.d.ts
+declare const isObject: <TObject extends object>(value: unknown) => value is TObject;
+/**
+ * @description - Combine array and non-array configs into a single array.
+ */
+declare const combine: (...configs: Array<Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>>) => Promise<TypedFlatConfigItem[]>;
+declare const interopDefault: <TModule>(module: Awaitable<TModule>) => Promise<TModule extends {
+  default: infer TDefaultExport;
+} ? TDefaultExport : TModule>;
+/**
+ * @description - Rename plugin prefixes in a rule object.
+ * Accepts a map of prefixes to rename.
+ *
+ * @example
+ * ```ts
+ * import { renameRules } from '@zayne-labs/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+declare const renameRules: (rules: Record<string, unknown> | undefined, renameMap: Record<string, string>) => TypedFlatConfigItem["rules"] | undefined;
+declare const renamePlugins: (plugins: Record<string, unknown> | undefined, renameMap: Record<string, string>) => Record<string, ESLint.Plugin> | undefined;
+type OverrideConfigsOptions = {
+  configArray: TypedFlatConfigItem[];
+  overrides: TypedFlatConfigItem | ((config: TypedFlatConfigItem) => TypedFlatConfigItem);
+};
+/**
+ * @description - Override configurations in a flat configs array with either a static config object or a function that returns a config object
+ * @param options - Configuration options
+ * @param options.configs - Array of flat config items to override
+ * @param options.overrides - Either a config object to merge or a function that takes a config and returns overrides
+ * @returns Array of merged config items with overrides applied
+ *
+ * @example
+ * ```ts
+ * import { overrideConfigs } from '@zayne-labs/eslint-config'
+ *
+ * // Override with static config
+ * overrideConfigs({
+ *   configArray: existingConfigs,
+ *   overrides: {
+ *     rules: {
+ *       'no-console': 'error'
+ *     }
+ *   }
+ * })
+ *
+ * // Override with function
+ * overrideConfigs({
+ *   configArray: existingConfigs,
+ *   overrides: (config) => ({
+ *     ...config,
+ *     rules: {
+ *       ...config.rules,
+ *       'no-console': 'error'
+ *     }
+ *   })
+ * })
+ * ```
+ */
+declare const overrideConfigs: (options: OverrideConfigsOptions) => TypedFlatConfigItem[];
+type RenamePluginInConfigsOptions = {
+  configArray: OverrideConfigsOptions["configArray"];
+  overrides?: OverrideConfigsOptions["overrides"];
+  renameMap: Record<string, string>;
+};
+/**
+ * @description - Rename plugin names and rules in a flat configs array
+ *
+ * @param options - Configuration options
+ * @param options.configArray - Array of flat config items to process
+ * @param options.overrides - Optional config overrides to apply
+ * @param options.renameMap - Map of old plugin names to new names
+ *
+ * @example
+ * ```ts
+ * import { renamePluginInConfigs } from '@zayne-labs/eslint-config'
+ * import someConfigs from './some-configs'
+ *
+ * renamePluginInConfigs({
+ *   configArray: someConfigs,
+ *   renameMap: {
+ *     '@typescript-eslint': 'ts',
+ *     'import-x': 'import',
+ *   }
+ * })
+ * ```
+ */
+declare const renamePluginInConfigs: (options: RenamePluginInConfigsOptions) => TypedFlatConfigItem[];
+declare const isPackageInScope: (name: string) => boolean;
+/**
+ * @description
+ * - Ensures that packages are installed in the current scope.
+ * - If they are not installed, and the user is in a TTY, and the user is not in a CI environment,
+ * and the user is in the same scope as this package, then prompt the user to
+ * install the packages.
+ *
+ * @param packages - The packages to ensure are installed.
+ */
+declare const ensurePackages: (packages: Array<string | undefined>) => Promise<void>;
+declare const resolveOptions: <TObject>(option: boolean | TObject | undefined) => TObject;
+declare const parserPlain: {
+  meta: {
+    name: string;
+  };
+  parseForESLint: (code: string) => {
+    ast: {
+      body: never[];
+      comments: never[];
+      loc: {
+        end: number;
+        start: number;
+      };
+      range: number[];
+      tokens: never[];
+      type: string;
+    };
+    scopeManager: null;
+    services: {
+      isPlain: boolean;
+    };
+    visitorKeys: {
+      Program: never[];
+    };
+  };
+};
+//#endregion
+export { combine, ensurePackages, interopDefault, isObject, isPackageInScope, overrideConfigs, parserPlain, renamePluginInConfigs, renamePlugins, renameRules, resolveOptions };
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,3 @@
+import { a as isPackageInScope, c as renamePluginInConfigs, d as resolveOptions, i as isObject, l as renamePlugins, n as ensurePackages, o as overrideConfigs, r as interopDefault, s as parserPlain, t as combine, u as renameRules } from "./utils-DPFNmhr6.js";
+
+export { combine, ensurePackages, interopDefault, isObject, isPackageInScope, overrideConfigs, parserPlain, renamePluginInConfigs, renamePlugins, renameRules, resolveOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zayne-labs/eslint-config",
   "type": "module",
-  "version": "0.11.7",
+  "version": "0.11.8",
   "description": "Zayne Labs' ESLint config preset",
   "author": "Ryan Zayne",
   "license": "MIT",
@@ -17,7 +17,8 @@
   "sideEffects": false,
   "exports": {
     ".": "./dist/index.js",
-    "./constants/*": "./dist/constants/*.js"
+    "./constants/*": "./dist/constants/*.js",
+    "./utils": "./dist/utils.js"
   },
   "bin": "./bin/index.js",
   "files": [
@@ -180,7 +181,7 @@
     "tsx": "4.21.0",
     "typescript": "5.9.3",
     "vue-eslint-parser": "10.2.0",
-    "@zayne-labs/tsconfig": "0.11.7"
+    "@zayne-labs/tsconfig": "0.11.8"
   },
   "publishConfig": {
     "access": "public",