@kitql/eslint-config 0.5.7 → 0.6.0-next.0

package/eslint.config.js

@@ -1,39 +1,83 @@
 import { includeIgnoreFile } from '@eslint/compat'
 import js from '@eslint/js'
-import pnpmCatalogs from 'eslint-plugin-pnpm-catalogs'
+import pluginPnpm from 'eslint-plugin-pnpm'
 import svelte from 'eslint-plugin-svelte'
 import unusedImports from 'eslint-plugin-unused-imports'
 import globals from 'globals'
 import * as jsoncParser from 'jsonc-eslint-parser'
 import ts from 'typescript-eslint'
+import * as yamlParser from 'yaml-eslint-parser'
 
 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[]} [json_files] - Files to apply the rules to
+ * @property {Record<string, any>} [json_rules] - Rules configuration
+ * @property {string[]} [yaml_files] - Files to apply the rules to
+ * @property {Record<string, any>} [yaml_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 = () => {
-	return {
-		name: 'pnpm-catalogs:package.json',
-		files: ['package.json'],
-		languageOptions: {
-			parser: jsoncParser,
+/**
+ * @param {PnpmCatalogsConfig} options
+ */
+const rulePnpmCatalogs = (options = {}) => {
+	const {
+		enable = true,
+		json_files = ['package.json', '**/package.json'],
+		json_rules = {
+			'pnpm/json-enforce-catalog': 'error',
+			'pnpm/json-valid-catalog': 'error',
+			'pnpm/json-prefer-workspace-settings': 'error',
+			...options.json_rules,
+		},
+		yaml_files = ['pnpm-workspace.yaml'],
+		yaml_rules = {
+			'pnpm/yaml-no-unused-catalog-item': 'error',
+			'pnpm/yaml-no-duplicate-catalog-item': 'off',
+			...options.yaml_rules,
 		},
-		plugins: {
-			'pnpm-catalogs': pnpmCatalogs,
+	} = options
+
+	if (!enable) return []
+
+	return [
+		{
+			name: 'pnpm/package.json',
+			files: json_files,
+			languageOptions: {
+				parser: jsoncParser,
+			},
+			plugins: {
+				pnpm: pluginPnpm,
+			},
+			rules: json_rules,
 		},
-		rules: {
-			'pnpm-catalogs/enforce-catalog': 'error',
-			'pnpm-catalogs/valid-catalog': 'error',
+		{
+			name: 'pnpm/pnpm-workspace-yaml',
+			files: yaml_files,
+			languageOptions: {
+				parser: yamlParser,
+			},
+			plugins: {
+				pnpm: pluginPnpm,
+			},
+			rules: yaml_rules,
 		},
-	}
+	]
 }
 
 const othersRules = () => {
@@ -122,24 +166,30 @@ const othersRules = () => {
 /** @type {import('eslint').Linter.Config[]} */
 const config = [
 	//
-	rulePrettierIgnore({ pnpmCatalogs: true }),
+	rulePrettierIgnore({ pnpmCatalogsEnabled: true }),
 	...othersRules(),
-	rulePnpmCatalogs(),
+	...rulePnpmCatalogs(),
 ]
 
 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.6.0-next.0",
   "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"
   ],
@@ -30,24 +27,28 @@
     "eslint",
     "eslint-config"
   ],
+  "peerDependencies": {
+    "prettier": "^3.5.3"
+  },
   "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-plugin-pnpm-catalogs": "0.1.0",
-    "eslint-plugin-svelte": "3.0.3",
+    "eslint": "9.22.0",
+    "eslint-plugin-pnpm": "0.3.1",
+    "eslint-plugin-svelte": "3.1.0",
     "eslint-plugin-unused-imports": "4.1.4",
     "globals": "16.0.0",
     "jsonc-eslint-parser": "2.4.0",
     "ora": "8.2.0",
-    "prettier": "3.5.3",
+    "prettier": "^3.5.3",
     "prettier-plugin-svelte": "3.3.2",
     "prettier-plugin-tailwindcss": "0.6.6",
     "typescript-eslint": "8.26.0",
+    "yaml-eslint-parser": "1.3.0",
     "@kitql/helpers": "0.8.12"
   },
   "publishConfig": {

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[]