@favorodera/eslint-config 0.0.9 → 0.0.11

package/README.md

@@ -4,7 +4,7 @@
   <p>
     <a href="https://github.com/favorodera/eslint-config/blob/main/LICENSE"><img src="https://img.shields.io/github/license/favorodera/eslint-config.svg?style=plastic&label=License&color=blue" alt="License"></a>
     <a href="https://github.com/favorodera/eslint-config/stargazers"><img src="https://img.shields.io/github/stars/favorodera/eslint-config.svg?style=plastic&label=Stars&color=blue" alt="GitHub Stars"></a>
-    <a href="https://www.npmjs.com/package/@favorodera/eslint-config"><img src="https://img.shields.io/npm/v/@favorodera/eslint-config.svg?style=plastic&label=Version&color=blue" alt="NPM Version"></a>
+    <a href="https://npmx.dev/package/@favorodera/eslint-config"><img src="https://img.shields.io/npm/v/@favorodera/eslint-config.svg?style=plastic&label=Version&color=blue" alt="NPM Version"></a>
   </p>
 </div>
 
@@ -87,7 +87,7 @@ import { factory } from '@favorodera/eslint-config'
 
 export default factory({
   // All configs are true by default!
-  
+
   // Example: Customize specific rulesets
   stylistic: {
     settings: {

package/dist/index.d.mts

@@ -18125,7 +18125,7 @@ type Yoda = [] | [("always" | "never")] | [("always" | "never"), {
   exceptRange?: boolean;
   onlyEquality?: boolean;
 }]; // Names of all the configs
-type ConfigNames = 'favorodera/ignores' | 'favorodera/imports/setup' | 'favorodera/imports/rules' | 'favorodera/javascript/setup' | 'favorodera/javascript/rules' | 'favorodera/jsdoc/setup' | 'favorodera/jsdoc/rules' | 'favorodera/jsonc/setup' | 'favorodera/jsonc/rules' | 'favorodera/jsonc/sort/package-json' | 'favorodera/jsonc/sort/tsconfig-json' | 'favorodera/markdown/setup' | 'favorodera/markdown/rules' | 'favorodera/markdown/code-in-md/disables' | 'favorodera/node/setup' | 'favorodera/node/rules' | 'favorodera/perfectionist/setup' | 'favorodera/perfectionist/rules' | 'favorodera/pnpm/setup' | 'favorodera/pnpm/package-json' | 'favorodera/pnpm/pnpm-workspace-yaml' | 'favorodera/stylistic/setup' | 'favorodera/stylistic/rules' | 'favorodera/tailwind/setup' | 'favorodera/tailwind/rules' | 'favorodera/test/setup' | 'favorodera/test/rules' | 'favorodera/test/disables' | 'favorodera/typescript/setup' | 'favorodera/typescript/rules' | 'favorodera/unicorn/setup' | 'favorodera/unicorn/rules' | 'favorodera/vue/setup' | 'favorodera/vue/rules' | 'favorodera/yaml/setup' | 'favorodera/yaml/rules' | 'favorodera/yaml/sort/pnpm-workspace-yaml';
+type ConfigNames = 'favorodera/ignores' | 'favorodera/imports/setup' | 'favorodera/imports/rules' | 'favorodera/javascript/setup' | 'favorodera/javascript/rules' | 'favorodera/jsdoc/setup' | 'favorodera/jsdoc/rules' | 'favorodera/jsonc/setup' | 'favorodera/jsonc/rules' | 'favorodera/jsonc/sort/package-json' | 'favorodera/jsonc/sort/tsconfig-json' | 'favorodera/jsonc/disables' | 'favorodera/markdown/setup' | 'favorodera/markdown/rules' | 'favorodera/markdown/code-in-md/disables' | 'favorodera/node/setup' | 'favorodera/node/rules' | 'favorodera/node/disables' | 'favorodera/perfectionist/setup' | 'favorodera/perfectionist/rules' | 'favorodera/pnpm/setup' | 'favorodera/pnpm/package-json' | 'favorodera/pnpm/pnpm-workspace-yaml' | 'favorodera/stylistic/setup' | 'favorodera/stylistic/rules' | 'favorodera/tailwind/setup' | 'favorodera/tailwind/rules' | 'favorodera/test/setup' | 'favorodera/test/rules' | 'favorodera/test/disables' | 'favorodera/typescript/setup' | 'favorodera/typescript/rules' | 'favorodera/unicorn/setup' | 'favorodera/unicorn/rules' | 'favorodera/vue/setup' | 'favorodera/vue/rules' | 'favorodera/yaml/setup' | 'favorodera/yaml/rules' | 'favorodera/yaml/sort/pnpm-workspace-yaml';
 //#endregion
 //#region src/types/utils.d.ts
 /** ESLint rules configuration with type-safe autocompletion */
@@ -18196,7 +18196,80 @@ type NodeConfigOptions = SharedOptions;
 //#endregion
 //#region src/configs/perfectionist.d.ts
 /** Options for configuring Perfectionist linting rules. */
-type PerfectionistConfigOptions = SharedOptions;
+type PerfectionistConfigOptions = SharedOptions & {
+  /**
+   * Global settings for the Perfectionist plugin, applied to all rules
+   * unless overridden by rule-specific options.
+   * @see https://perfectionist.dev/guide/getting-started#settings
+   * @see https://perfectionist.dev/configs/recommended-custom
+   */
+  settings?: {
+    /**
+     * The type of sorting algorithm.
+     * @default 'natural'
+     */
+    type?: 'alphabetical' | 'custom' | 'line-length' | 'natural';
+    /**
+     * The order of sorting.
+     * @default 'asc'
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * The fallback sorting type and order used when two elements are equal
+     * under the primary comparison.
+     */
+    fallbackSort?: {
+      order?: 'asc' | 'desc';
+      type: 'alphabetical' | 'custom' | 'line-length' | 'natural';
+    };
+    /**
+     * Custom alphabet string for the `'custom'` sort type.
+     * Defines the exact character order to use.
+     */
+    alphabet?: string;
+    /**
+     * Ignore case when sorting.
+     * @default true
+     */
+    ignoreCase?: boolean;
+    /**
+     * Control whether special characters should be kept, trimmed or removed
+     * before sorting.
+     * @default 'keep'
+     */
+    specialCharacters?: 'keep' | 'remove' | 'trim';
+    /**
+     * Locale(s) used for locale-aware string comparison.
+     * A BCP 47 language tag or an array of such tags.
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#locales
+     * @default 'en-US'
+     */
+    locales?: Array<string> | string;
+    /**
+     * Partition sorted elements by comments.
+     * Can be `true`, `false`, a regexp pattern string, or an array of patterns.
+     * @default true
+     */
+    partitionByComment?: Array<string> | boolean | string;
+    /**
+     * Partition sorted elements by newlines.
+     * @default true
+     */
+    partitionByNewLine?: boolean;
+    /**
+     * Specifies how to handle newlines between groups.
+     * `'ignore'` preserves existing newlines; a number enforces that many blank lines.
+     * @default 'ignore'
+     */
+    newlinesBetween?: 'ignore' | number;
+    /**
+     * Specifies how to handle newlines between elements of each group.
+     * `'ignore'` preserves existing newlines; a number enforces that many blank lines.
+     * @default 'ignore'
+     */
+    newlinesInside?: 'ignore' | 'newlinesBetween' | number;
+  };
+};
 //#endregion
 //#region src/configs/stylistic.d.ts
 /** Options for configuring Stylistic formatting rules. */
@@ -18210,6 +18283,7 @@ type TailwindConfigOptions = SharedOptions & {
   /**
    * Custom settings for the `eslint-plugin-better-tailwindcss` plugin.
    * Configure project paths, detection features, and rule specifics.
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md
    */
   settings?: {
     /**

package/dist/index.mjs

@@ -462,7 +462,9 @@ async function jsonc(options) {
 			language: "jsonc/x",
 			name: "favorodera/jsonc/rules",
 			rules: {
+				"jsonc/array-bracket-newline": "error",
 				"jsonc/array-bracket-spacing": ["error", "never"],
+				"jsonc/array-element-newline": "error",
 				"jsonc/comma-dangle": ["error", "never"],
 				"jsonc/comma-style": ["error", "last"],
 				"jsonc/indent": ["error", 2],
@@ -478,6 +480,7 @@ async function jsonc(options) {
 				"jsonc/no-floating-decimal": "error",
 				"jsonc/no-hexadecimal-numeric-literals": "error",
 				"jsonc/no-infinity": "error",
+				"jsonc/no-irregular-whitespace": "error",
 				"jsonc/no-multi-str": "error",
 				"jsonc/no-nan": "error",
 				"jsonc/no-number-props": "error",
@@ -498,7 +501,7 @@ async function jsonc(options) {
 					multiline: true
 				}],
 				"jsonc/object-curly-spacing": ["error", "always"],
-				"jsonc/object-property-newline": ["error", { allowAllPropertiesOnSameLine: true }],
+				"jsonc/object-property-newline": ["error", { allowAllPropertiesOnSameLine: false }],
 				"jsonc/quote-props": "error",
 				"jsonc/quotes": "error",
 				"jsonc/space-unary-ops": "error",
@@ -723,6 +726,12 @@ async function jsonc(options) {
 					pathPattern: "^compilerOptions$"
 				}
 			] }
+		},
+		{
+			files: resolved.files,
+			language: "jsonc/x",
+			name: "favorodera/jsonc/disables",
+			rules: { "no-irregular-whitespace": "off" }
 		}
 	];
 }
@@ -809,36 +818,68 @@ const nodeDefaults = { files: [
 async function node(options) {
 	const resolved = defu(options, nodeDefaults);
 	const nodePlugin = await importModule(import("eslint-plugin-n"));
-	const baseRules = nodePlugin.configs?.["flat/recommended"]?.rules || {};
-	return [{
-		name: "favorodera/node/setup",
-		plugins: { node: nodePlugin }
-	}, {
-		files: resolved.files,
-		name: "favorodera/node/rules",
-		rules: {
-			...renamePluginsInRules(baseRules, { n: "node" }),
-			"node/handle-callback-err": ["error", "^(err|error)$"],
-			"node/no-deprecated-api": "error",
-			"node/no-exports-assign": "error",
-			"node/no-missing-import": "off",
-			"node/no-new-require": "error",
-			"node/no-path-concat": "error",
-			"node/no-unpublished-import": "off",
-			"node/prefer-global/buffer": ["error", "never"],
-			"node/prefer-global/process": ["error", "never"],
-			"node/process-exit-as-throw": "error",
-			...resolved.overrides
+	const baseRules = nodePlugin.configs?.["flat/recommended-module"]?.rules || {};
+	return [
+		{
+			name: "favorodera/node/setup",
+			plugins: { node: nodePlugin }
+		},
+		{
+			files: resolved.files,
+			name: "favorodera/node/rules",
+			rules: {
+				...renamePluginsInRules(baseRules, { n: "node" }),
+				"node/callback-return": "error",
+				"node/handle-callback-err": ["error", "^(err|error)$"],
+				"node/no-callback-literal": "error",
+				"node/no-new-require": "error",
+				"node/no-path-concat": "error",
+				"node/no-unpublished-import": "error",
+				"node/prefer-global/buffer": "error",
+				"node/prefer-global/console": "error",
+				"node/prefer-global/crypto": "error",
+				"node/prefer-global/process": "error",
+				"node/prefer-global/text-decoder": "error",
+				"node/prefer-global/text-encoder": "error",
+				"node/prefer-global/timers": "error",
+				"node/prefer-global/url": "error",
+				"node/prefer-global/url-search-params": "error",
+				"node/prefer-node-protocol": "error",
+				"node/prefer-promises/dns": "error",
+				"node/prefer-promises/fs": "error",
+				...resolved.overrides
+			}
+		},
+		{
+			files: [tsGlob, vueGlob],
+			name: "favorodera/node/disables",
+			rules: {
+				"node/no-missing-import": "off",
+				"node/no-missing-require": "off"
+			}
 		}
-	}];
+	];
 }
 //#endregion
 //#region src/configs/perfectionist.ts
-const perfectionistDefaults = { files: [
-	jsGlob,
-	tsGlob,
-	vueGlob
-] };
+const perfectionistDefaults = {
+	files: [
+		jsGlob,
+		tsGlob,
+		vueGlob
+	],
+	settings: {
+		ignoreCase: true,
+		locales: "en-US",
+		newlinesBetween: "ignore",
+		newlinesInside: "ignore",
+		order: "asc",
+		partitionByComment: true,
+		partitionByNewLine: true,
+		specialCharacters: "keep",
+		type: "natural"
+	}
+};
 /**
 * Constructs the flat config items for Perfectionist linting, providing rules
 * to naturally sort objects, imports, classes, and other elements in your code.
@@ -848,53 +889,17 @@ const perfectionistDefaults = { files: [
 async function perfectionist(options) {
 	const resolved = defu(options, perfectionistDefaults);
 	const perfectionistPlugin = await importModule(import("eslint-plugin-perfectionist"));
-	const baseRules = perfectionistPlugin.configs["recommended-natural"]?.rules || {};
+	const safeType = resolved.settings?.type ?? "natural";
+	const baseRules = perfectionistPlugin.configs[`recommended-${safeType}`]?.rules || {};
 	return [{
 		name: "favorodera/perfectionist/setup",
-		plugins: { perfectionist: perfectionistPlugin }
+		plugins: { perfectionist: perfectionistPlugin },
+		settings: { perfectionist: resolved.settings }
 	}, {
 		files: resolved.files,
 		name: "favorodera/perfectionist/rules",
 		rules: {
 			...baseRules,
-			"perfectionist/sort-exports": ["error", {
-				order: "asc",
-				type: "natural"
-			}],
-			"perfectionist/sort-imports": ["error", {
-				groups: [
-					"type-import",
-					[
-						"type-parent",
-						"type-sibling",
-						"type-index",
-						"type-internal"
-					],
-					"value-builtin",
-					"value-external",
-					"value-internal",
-					[
-						"value-parent",
-						"value-sibling",
-						"value-index"
-					],
-					"side-effect",
-					"ts-equals-import",
-					"unknown"
-				],
-				newlinesBetween: "ignore",
-				newlinesInside: "ignore",
-				order: "asc",
-				type: "natural"
-			}],
-			"perfectionist/sort-named-exports": ["error", {
-				order: "asc",
-				type: "natural"
-			}],
-			"perfectionist/sort-named-imports": ["error", {
-				order: "asc",
-				type: "natural"
-			}],
 			...resolved.overrides
 		}
 	}];
@@ -919,6 +924,12 @@ async function pnpm() {
 			rules: {
 				"pnpm/json-enforce-catalog": ["error", {
 					autofix: true,
+					fields: [
+						"dependencies",
+						"devDependencies",
+						"optionalDependencies",
+						"peerDependencies"
+					],
 					ignores: ["@types/vscode"]
 				}],
 				"pnpm/json-prefer-workspace-settings": ["error", { autofix: true }],
@@ -935,7 +946,8 @@ async function pnpm() {
 					trustPolicy: "no-downgrade"
 				} }],
 				"pnpm/yaml-no-duplicate-catalog-item": ["error", { checkDuplicates: "exact-version" }],
-				"pnpm/yaml-no-unused-catalog-item": "error"
+				"pnpm/yaml-no-unused-catalog-item": "error",
+				"pnpm/yaml-valid-packages": "error"
 			}
 		}
 	];
@@ -949,6 +961,7 @@ const stylisticDefaults = {
 		vueGlob
 	],
 	settings: {
+		braceStyle: "1tbs",
 		experimental: false,
 		indent: 2,
 		jsx: false,
@@ -977,27 +990,24 @@ async function stylistic(options) {
 		name: "favorodera/stylistic/rules",
 		rules: {
 			...baseRules,
-			"style/brace-style": "off",
-			"style/generator-star-spacing": ["error", {
-				after: true,
-				before: false
-			}],
-			"style/no-multiple-empty-lines": ["error", {
-				max: 2,
-				maxBOF: 0,
-				maxEOF: 2
-			}],
-			"style/no-trailing-spaces": ["error", { skipBlankLines: true }],
-			"style/padded-blocks": "off",
-			"style/quotes": [
-				"error",
-				"single",
-				{ avoidEscape: true }
-			],
-			"style/yield-star-spacing": ["error", {
-				after: true,
-				before: false
-			}],
+			"style/array-bracket-newline": "error",
+			"style/array-element-newline": "error",
+			"style/curly-newline": ["error", "always"],
+			"style/function-call-argument-newline": ["error", "consistent"],
+			"style/function-call-spacing": "error",
+			"style/function-paren-newline": "error",
+			"style/implicit-arrow-linebreak": "error",
+			"style/line-comment-position": "error",
+			"style/linebreak-style": "error",
+			"style/multiline-comment-style": ["error", "separate-lines"],
+			"style/newline-per-chained-call": "error",
+			"style/no-confusing-arrow": "error",
+			"style/no-extra-semi": "error",
+			"style/nonblock-statement-body-position": "error",
+			"style/object-curly-newline": "error",
+			"style/semi-style": "error",
+			"style/switch-colon-spacing": "error",
+			"style/wrap-regex": "error",
 			...resolved.overrides
 		}
 	}];
@@ -1041,11 +1051,11 @@ async function tailwind(options) {
 				unknownClassOrder: "asc",
 				unknownClassPosition: "start"
 			}],
-			"tailwind/enforce-consistent-important-position": "off",
 			"tailwind/enforce-consistent-line-wrapping": ["error", { group: "emptyLine" }],
-			"tailwind/enforce-consistent-variable-syntax": "off",
 			"tailwind/enforce-consistent-variant-order": "error",
 			"tailwind/enforce-logical-properties": "error",
+			"tailwind/enforce-consistent-important-position": "off",
+			"tailwind/enforce-consistent-variable-syntax": "off",
 			"tailwind/enforce-shorthand-classes": "off",
 			...resolved.overrides
 		}
@@ -1133,10 +1143,7 @@ async function test(options) {
 		{
 			files: resolved.files,
 			name: "favorodera/test/disables",
-			rules: {
-				"no-unused-expressions": "off",
-				"node/prefer-global/process": "off"
-			}
+			rules: { "no-unused-expressions": "off" }
 		}
 	];
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@favorodera/eslint-config",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "private": false,
   "description": "Opinionated, type-safe flat ESLint configuration factory for Vue, TypeScript, Tailwind, and more.",
   "author": "Favour Emeka <favorodera@gmail.com>",