@kitql/eslint-config 0.5.5 → 0.5.7

package/.prettierrc.mjs

@@ -1,6 +1,6 @@
 import prettierConfig from '@theguild/prettier-config'
 
-export default {
+const config = {
 	...prettierConfig,
 	tabWidth: 1,
 	useTabs: true,
@@ -39,3 +39,8 @@ export default {
 		},
 	],
 }
+export default config
+
+export const kitql = () => {
+	return config
+}

package/cmd.js

@@ -312,6 +312,7 @@ const took = []
 const display = (text, time) => {
 	return `${gray(text)} ${green((time / 1000).toFixed(3))}${gray('s')}`
 }
+const displayTook = () => `${gray('(')}${took.join(gray(', '))}${gray(')')}`
 
 // If changed-only flag is set, get the list of changed files
 if (diffOnly) {
@@ -335,7 +336,7 @@ if (!prettierOnly && glob) {
 	took.push(display('eslint', esLintTook))
 	if (eslintCode.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
-		spinner.fail(red(`eslint failed, check logs above.`))
+		spinner.fail(red(`eslint failed, check logs above. ${displayTook()}`))
 		process.exit(eslintCode.status)
 	}
 }
@@ -347,14 +348,22 @@ if (!eslintOnly && glob) {
 	took.push(display('prettier', prettierTook))
 	if (prettierCode.status) {
 		spinner.prefixText = bgRedBright(` kitql-lint `)
-		spinner.fail(red(`prettier failed, check logs above.`))
+		spinner.fail(red(`prettier failed, check logs above. ${displayTook()}`))
 		process.exit(prettierCode.status)
 	}
 }
 
 spinner.prefixText = bgGreen(` kitql-lint `)
 spinner.succeed(
-	`All good, ${glob === '' ? 'nothing to do!' : filesLength !== -1 ? `your ${filesLength} files looks great!` : 'your files looks great!'} ${gray('(')}${took.join(gray(', '))}${gray(')')}`,
+	`All good, ` +
+		`${
+			glob === ''
+				? 'nothing to do!'
+				: filesLength !== -1
+					? `your ${filesLength === 1 ? 'single file' : `${filesLength} files`} looks great!`
+					: 'your files looks great!'
+		} ` +
+		displayTook(),
 )
 spinner.stop()
 process.exit(0)

package/eslint.config.d.ts

@@ -0,0 +1,17 @@
+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[]

package/eslint.config.js

@@ -9,68 +9,18 @@ import ts from 'typescript-eslint'
 
 import { findFileOrUp } from './helper/findFileOrUp.js'
 
-const pathPrettierIgnore = findFileOrUp('.prettierignore', { absolute: true })
-
-/** @type {import('eslint').Linter.Config[]} */
-export const config = [
-	{
+const rulePrettierIgnore = ({ pnpmCatalogs = true }) => {
+	const pathPrettierIgnore = findFileOrUp('.prettierignore', { absolute: true })
+	const rowIgnore = pathPrettierIgnore ? includeIgnoreFile(pathPrettierIgnore).ignores : []
+	const ignores = pnpmCatalogs ? rowIgnore.filter((c) => !c.includes('package.json')) : rowIgnore
+	return {
 		name: '@kitql:prettier:ignores',
-		ignores: pathPrettierIgnore
-			? includeIgnoreFile(pathPrettierIgnore).ignores.filter((c) => !c.includes('package.json'))
-			: [],
-	},
-	{
-		name: 'eslint/defaults/recommended',
-		...js.configs.recommended, // TODO, would be nice to have a name by default?
-	},
-	...ts.configs.recommended,
-	...svelte.configs['flat/recommended'],
-	{
-		name: '@kitql:languages',
-		languageOptions: {
-			globals: {
-				...globals.browser,
-				...globals.node,
-			},
-		},
-	},
-	{
-		name: '@kitql:svelte:languages',
-		files: ['**/*.svelte'],
-		languageOptions: {
-			parserOptions: {
-				parser: ts.parser,
-			},
-		},
-	},
-	{
-		name: '@kitql:ignores',
-		ignores: ['build/', '.svelte-kit/', 'dist/', '**/build/', '**/.svelte-kit/', '**/dist/'],
-	},
-	{
-		name: '@kitql:unused-imports',
-		plugins: {
-			'unused-imports': unusedImports,
-		},
-		rules: {
-			'no-unused-vars': 'off',
-			'@typescript-eslint/no-unused-vars': 'off',
+		ignores,
+	}
+}
 
-			'unused-imports/no-unused-imports': 'error',
-			'unused-imports/no-unused-vars': 'off',
-			// 'unused-imports/no-unused-vars': [
-			//   'warn',
-			//   {
-			//     vars: 'all',
-			//     varsIgnorePattern: '^_',
-			//     args: 'after-used',
-			//     argsIgnorePattern: '^_',
-			//   },
-			// ],
-			'no-empty': ['error', { allowEmptyCatch: true }],
-		},
-	},
-	{
+const rulePnpmCatalogs = () => {
+	return {
 		name: 'pnpm-catalogs:package.json',
 		files: ['package.json'],
 		languageOptions: {
@@ -83,34 +33,113 @@ export const config = [
 			'pnpm-catalogs/enforce-catalog': 'error',
 			'pnpm-catalogs/valid-catalog': 'error',
 		},
-	},
-	{
-		name: '@kitql:rules',
-		rules: {
-			'no-console': [
-				'error',
-				{
-					allow: ['info', 'warn', 'error', 'time', 'timeEnd', 'dir'],
+	}
+}
+
+const othersRules = () => {
+	return [
+		{
+			name: 'eslint/defaults/recommended',
+			...js.configs.recommended, // TODO, would be nice to have a name by default?
+		},
+		...ts.configs.recommended,
+		...svelte.configs['flat/recommended'],
+		{
+			name: '@kitql:languages',
+			languageOptions: {
+				globals: {
+					...globals.browser,
+					...globals.node,
 				},
-			],
+			},
+		},
+		{
+			name: '@kitql:svelte:languages',
+			files: ['**/*.svelte'],
+			languageOptions: {
+				parserOptions: {
+					parser: ts.parser,
+				},
+			},
+		},
+		{
+			name: '@kitql:ignores',
+			ignores: ['build/', '.svelte-kit/', 'dist/', '**/build/', '**/.svelte-kit/', '**/dist/'],
+		},
+		{
+			name: '@kitql:unused-imports',
+			plugins: {
+				'unused-imports': unusedImports,
+			},
+			rules: {
+				'no-unused-vars': 'off',
+				'@typescript-eslint/no-unused-vars': 'off',
 
-			'@typescript-eslint/no-require-imports': 'off',
-			'@typescript-eslint/ban-ts-ignore': 'off',
-			'@typescript-eslint/ban-ts-comment': 'off',
-			'@typescript-eslint/no-explicit-any': 'off',
-			'@typescript-eslint/no-non-null-assertion': 'off',
-			'@typescript-eslint/no-unused-expressions': 'off',
-			'@typescript-eslint/no-empty-object-type': 'off',
+				'unused-imports/no-unused-imports': 'error',
+				'unused-imports/no-unused-vars': 'off',
+				// 'unused-imports/no-unused-vars': [
+				//   'warn',
+				//   {
+				//     vars: 'all',
+				//     varsIgnorePattern: '^_',
+				//     args: 'after-used',
+				//     argsIgnorePattern: '^_',
+				//   },
+				// ],
+				'no-empty': ['error', { allowEmptyCatch: true }],
+			},
+		},
+		{
+			name: '@kitql:rules',
+			rules: {
+				'no-console': [
+					'error',
+					{
+						allow: ['info', 'warn', 'error', 'time', 'timeEnd', 'dir'],
+					},
+				],
 
-			'no-undef': 'off',
-			'no-inner-declarations': 'off',
+				'@typescript-eslint/no-require-imports': 'off',
+				'@typescript-eslint/ban-ts-ignore': 'off',
+				'@typescript-eslint/ban-ts-comment': 'off',
+				'@typescript-eslint/no-explicit-any': 'off',
+				'@typescript-eslint/no-non-null-assertion': 'off',
+				'@typescript-eslint/no-unused-expressions': 'off',
+				'@typescript-eslint/no-empty-object-type': 'off',
 
-			'svelte/no-at-html-tags': 'off',
-			'svelte/no-inner-declarations': 'off',
+				'no-undef': 'off',
+				'no-inner-declarations': 'off',
 
-			'svelte/require-each-key': 'warn',
+				'svelte/no-at-html-tags': 'off',
+				'svelte/no-inner-declarations': 'off',
+
+				'svelte/require-each-key': 'warn',
+			},
 		},
-	},
+	]
+}
+
+/** @type {import('eslint').Linter.Config[]} */
+const config = [
+	//
+	rulePrettierIgnore({ pnpmCatalogs: true }),
+	...othersRules(),
+	rulePnpmCatalogs(),
 ]
 
 export default config
+
+/**
+ * @param {Object} options
+ * @param {boolean} options.pnpmCatalogs
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const kitql = (options) => {
+	const pnpmCatalogs = options?.pnpmCatalogs ?? true
+	return [
+		//
+		rulePrettierIgnore({ pnpmCatalogs }),
+		...othersRules(),
+		...(pnpmCatalogs ? [rulePnpmCatalogs()] : []),
+	]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitql/eslint-config",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "type": "module",
   "description": "opinionated linting and formatting for projects",
   "repository": {
@@ -16,6 +16,7 @@
     "kitql-lint": "./cmd.js"
   },
   "main": "eslint.config.js",
+  "types": "eslint.config.d.ts",
   "files": [
     ".prettierrc.mjs",
     "cmd.js",