@kitql/eslint-config 0.5.7 → 0.5.8

package/eslint.config.js

@@ -9,30 +9,50 @@ import ts from 'typescript-eslint'
 
 import { findFileOrUp } from './helper/findFileOrUp.js'
 
-const rulePrettierIgnore = ({ pnpmCatalogs = true }) => {
+/**
+ * @typedef {Object} PnpmCatalogsConfig
+ * @property {boolean} [enable=true] - Whether to enable pnpm catalogs rules
+ * @property {string[]} [files] - Files to apply the rules to
+ * @property {Record<string, string>} [rules] - Rules configuration
+ */
+
+const rulePrettierIgnore = ({ pnpmCatalogsEnabled = true }) => {
 	const pathPrettierIgnore = findFileOrUp('.prettierignore', { absolute: true })
-	const rowIgnore = pathPrettierIgnore ? includeIgnoreFile(pathPrettierIgnore).ignores : []
-	const ignores = pnpmCatalogs ? rowIgnore.filter((c) => !c.includes('package.json')) : rowIgnore
+	const rowIgnore = pathPrettierIgnore ? (includeIgnoreFile(pathPrettierIgnore).ignores ?? []) : []
+	const ignores = pnpmCatalogsEnabled
+		? rowIgnore.filter((c) => !c.includes('package.json'))
+		: rowIgnore
 	return {
 		name: '@kitql:prettier:ignores',
 		ignores,
 	}
 }
 
-const rulePnpmCatalogs = () => {
+/**
+ * @param {PnpmCatalogsConfig} options
+ */
+const rulePnpmCatalogs = (options = {}) => {
+	const {
+		enable = true,
+		files = ['package.json', '**/package.json'],
+		rules = {
+			'pnpm-catalogs/enforce-catalog': 'error',
+			'pnpm-catalogs/valid-catalog': 'error',
+		},
+	} = options
+
+	if (!enable) return null
+
 	return {
 		name: 'pnpm-catalogs:package.json',
-		files: ['package.json'],
+		files,
 		languageOptions: {
 			parser: jsoncParser,
 		},
 		plugins: {
 			'pnpm-catalogs': pnpmCatalogs,
 		},
-		rules: {
-			'pnpm-catalogs/enforce-catalog': 'error',
-			'pnpm-catalogs/valid-catalog': 'error',
-		},
+		rules,
 	}
 }
 
@@ -122,7 +142,7 @@ const othersRules = () => {
 /** @type {import('eslint').Linter.Config[]} */
 const config = [
 	//
-	rulePrettierIgnore({ pnpmCatalogs: true }),
+	rulePrettierIgnore({ pnpmCatalogsEnabled: true }),
 	...othersRules(),
 	rulePnpmCatalogs(),
 ]
@@ -130,16 +150,22 @@ const config = [
 export default config
 
 /**
- * @param {Object} options
- * @param {boolean} options.pnpmCatalogs
+ * @typedef {Object} KitqlOptions
+ * @property {PnpmCatalogsConfig} [pnpmCatalogs] - Configuration object for pnpm catalogs
+ */
+
+/**
+ * @param {KitqlOptions} [options]
  * @returns {import('eslint').Linter.Config[]}
  */
-export const kitql = (options) => {
-	const pnpmCatalogs = options?.pnpmCatalogs ?? true
+export const kitql = (options = {}) => {
+	const pnpmCatalogsConfig = options?.pnpmCatalogs ?? { enable: true }
+	const pnpmCatalogsEnabled = pnpmCatalogsConfig.enable !== false
+
 	return [
 		//
-		rulePrettierIgnore({ pnpmCatalogs }),
+		rulePrettierIgnore({ pnpmCatalogsEnabled }),
 		...othersRules(),
-		...(pnpmCatalogs ? [rulePnpmCatalogs()] : []),
+		...(pnpmCatalogsEnabled ? [rulePnpmCatalogs(pnpmCatalogsConfig)] : []),
 	]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "type": "module",
   "description": "opinionated linting and formatting for projects",
   "repository": {
@@ -16,12 +16,9 @@
     "kitql-lint": "./cmd.js"
   },
   "main": "eslint.config.js",
-  "types": "eslint.config.d.ts",
   "files": [
     ".prettierrc.mjs",
     "cmd.js",
-    "cmd.sh",
-    "eslint.config.d.ts",
     "eslint.config.js",
     "helper/findFileOrUp.js"
   ],
@@ -32,12 +29,12 @@
   ],
   "dependencies": {
     "@eslint/compat": "1.2.7",
-    "@eslint/js": "9.10.0",
+    "@eslint/js": "9.22.0",
     "@theguild/prettier-config": "3.0.0",
     "@types/eslint": "9.6.1",
     "@typescript-eslint/parser": "8.26.0",
     "commander": "13.1.0",
-    "eslint": "9.10.0",
+    "eslint": "9.22.0",
     "eslint-plugin-pnpm-catalogs": "0.1.0",
     "eslint-plugin-svelte": "3.0.3",
     "eslint-plugin-unused-imports": "4.1.4",

package/eslint.config.d.ts

@@ -1,17 +0,0 @@
-import type { Linter } from 'eslint'
-
-export default config
-
-/**
- * KitQL's ESLint configuration with customizable options
- *
- * @param options - Configuration options
- * @returns ESLint configuration array
- */
-export function kitql(options?: {
-	/**
-	 * Whether to include pnpm catalogs rules
-	 * @default true
-	 */
-	pnpmCatalogs?: boolean
-}): Linter.Config[]