@tommy-mitchell/eslint-config-xo 0.7.0 → 1.0.0-0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tommy-mitchell/eslint-config-xo",
-	"version": "0.7.0",
+	"version": "1.0.0-0",
 	"description": "Personal config for XO.",
 	"keywords": [
 		"nodejs",
@@ -14,40 +14,41 @@
 		"url": "https://tommymitchell.io"
 	},
 	"sideEffects": false,
+	"type": "module",
 	"files": [
-		"dprint.js",
-		"index.js",
-		"react.js",
-		"tailwind.js"
+		"src"
 	],
+	"exports": {
+		"types": "./src/index.d.ts",
+		"default": "./src/index.js"
+	},
 	"scripts": {
 		"format": "dprint fmt && xo --fix",
 		"lint": "xo",
 		"test": "ava"
 	},
 	"dependencies": {
-		"eslint-config-xo-react": "^0.27.0",
-		"eslint-plugin-dprint-integration": "^0.3.0",
-		"eslint-plugin-jsx-a11y": "^6.9.0",
-		"eslint-plugin-perfectionist": "^3.2.0",
-		"eslint-plugin-react": "^7.35.0",
-		"eslint-plugin-react-hooks": "^4.6.2",
-		"eslint-plugin-react-refresh": "^0.4.9",
-		"eslint-plugin-readable-tailwind": "^1.7.0",
+		"eslint-plugin-jsx-a11y": "^6.10.2",
+		"eslint-plugin-perfectionist": "^4.7.0",
+		"eslint-plugin-react-refresh": "^0.4.18",
+		"eslint-plugin-readable-tailwind": "^1.9.0",
 		"eslint-plugin-simple-import-sort": "^12.1.1",
 		"eslint-plugin-sort-react-dependency-arrays": "^1.0.0",
-		"eslint-plugin-tailwindcss": "^3.17.4"
+		"eslint-plugin-tailwindcss": "^3.18.0"
 	},
 	"devDependencies": {
-		"@tommy-mitchell/dprint-config": "^0.2.0",
-		"ava": "^6.1.3",
+		"@stylistic/eslint-plugin": "^3.0.1",
+		"@tommy-mitchell/dprint-config": "^0.4.0",
+		"ava": "^6.2.0",
 		"dprint": "0.x",
-		"execa": "^9.3.0",
-		"xo": "0.x"
+		"eslint-plugin-react": "^7.37.4",
+		"execa": "^9.5.2",
+		"tempy": "^3.1.0",
+		"xo": "npm:@spence-s/flat-xo@latest"
 	},
 	"peerDependencies": {
 		"dprint": "0.x",
-		"react": "18.x",
+		"react": "19.x",
 		"tailwindcss": "3.x",
 		"xo": "0.x"
 	},
@@ -63,6 +64,9 @@
 		}
 	},
 	"engines": {
-		"node": "^18.18 || ^20.8 || >=21"
+		"node": "^18.20 || ^20.10 || >=21"
+	},
+	"ava": {
+		"timeout": "30s"
 	}
 }

package/readme.md

@@ -5,7 +5,7 @@ Personal config for [`XO`](https://github.com/xojs/xo). Recommended to be used w
 ## Install
 
 ```sh
-npm install --save-dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
+npm install --save-dev @tommy-mitchell/eslint-config-xo xo
 ```
 
 <details>
@@ -13,49 +13,47 @@ npm install --save-dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprin
 <p>
 
 ```sh
-yarn add --dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
+yarn add --dev @tommy-mitchell/eslint-config-xo xo
 ```
 
 </p>
 </details>
 
-### Peer Dependencies
-
-- [xo](https://github.com/xojs/xo) - JavaScript/TypeScript linter (ESLint wrapper) with great defaults.
-- [dprint](https://github.com/dprint/dprint) (*Optional*) - Pluggable and configurable code formatting platform written in Rust.
-- [react](https://react.dev) (*Optional*) - The library for web and native user interfaces.
-- [tailwindcss](https://tailwindcss.com) (*Optional*) - A utility-first CSS framework for rapid UI development.
-
-## Usage
-
-Add to the `extends` section of your `XO` config:
+<details>
+<summary>With dprint</summary>
+<p>
 
-```jsonc
-"extends": ["@tommy-mitchell/xo"],
+```sh
+npm install --save-dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
 ```
 
-### dprint
-
-```jsonc
-"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/dprint"],
+```sh
+yarn add --dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
 ```
 
-### React
+</p>
+</details>
 
-```jsonc
-"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react"],
-```
+### Peer Dependencies
 
-#### React + dprint
+- [xo](https://github.com/xojs/xo) - JavaScript/TypeScript linter (ESLint wrapper) with great defaults.
+- [dprint](https://github.com/dprint/dprint) (*Optional*) - Pluggable and configurable code formatting platform written in Rust.
+- [react](https://react.dev) (*Optional*) - The library for web and native user interfaces.
+- [tailwindcss](https://tailwindcss.com) (*Optional*) - A utility-first CSS framework for rapid UI development.
 
-```jsonc
-"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react", "@tommy-mitchell/xo/dprint"],
-```
+## Usage (Flat Config)
 
-### Tailwind CSS
+```js
+// xo.config.js
+import * as configs from "@tommy-mitchell/eslint-config-xo";
 
-```jsonc
-"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/tailwind"],
+export default [
+	...configs.xo,
+	...configs.react, // If using React
+	...configs.tailwind, // If using Tailwind CSS
+	...configs.dprint, // If using dprint (must be last to override stylistic rules)
+	// Plus any overrides
+]
 ```
 
 ### VS Code
@@ -66,6 +64,19 @@ Add the following to your `settings.json`:
 "xo.enable": true,
 "xo.format.enable": true,
 "xo.overrideSeverity": "warn",
+"xo.debounce": 100,
+```
+
+If formatting with `dprint`:
+
+```jsonc
+"[javascript][javascriptreact][typescript][typescriptreact]": {
+	"editor.formatOnSave": true,
+	"editor.defaultFormatter": "dprint.dprint",
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "explicit", // Will run lint autofixes
+	},
+},
 ```
 
 ## Related

package/src/dprint.js

@@ -0,0 +1,22 @@
+import stylistic from "@stylistic/eslint-plugin";
+
+// TODO: eslint unicorn rule proposal
+const allowedRules = new Set(["padding-line-between-statements"]);
+const disabledRules = Object.fromEntries(
+	Object.keys(stylistic.rules)
+		.filter(rule => !allowedRules.has(rule))
+		.map(rule => [`@stylistic/${rule}`, "off"]),
+);
+
+export default [
+	{
+		rules: {
+			"arrow-body-style": "off",
+			"curly": "off",
+			"no-arrow-condition": "off",
+			"no-comma-dangle": "off",
+		},
+	},
+	stylistic.configs["disable-legacy"],
+	{ rules: disabledRules },
+];

package/src/index.d.ts

@@ -0,0 +1,6 @@
+import type { FlatXoConfig } from "xo";
+
+export declare const dprint: FlatXoConfig;
+export declare const react: FlatXoConfig;
+export declare const tailwind: FlatXoConfig;
+export declare const xo: FlatXoConfig;

package/src/index.js

@@ -0,0 +1,4 @@
+export { default as dprint } from "./dprint.js";
+export { default as react } from "./react.js";
+export { default as tailwind } from "./tailwind.js";
+export { default as xo } from "./xo.js";

package/src/react.js

@@ -0,0 +1,52 @@
+import jsxA11y from "eslint-plugin-jsx-a11y";
+import react from "eslint-plugin-react";
+import reactRefresh from "eslint-plugin-react-refresh";
+import sortReactDependencyArrays from "eslint-plugin-sort-react-dependency-arrays";
+
+const configs = [
+	react.configs.flat["jsx-runtime"],
+	jsxA11y.flatConfigs.recommended,
+];
+
+export default [...configs, {
+	plugins: {
+		"react-refresh": reactRefresh,
+		"sort-react-dependency-arrays": sortReactDependencyArrays,
+	},
+	rules: {
+		"react-refresh/only-export-components": ["warn", { allowConstantExport: true }],
+		"react/no-array-index-key": "warn",
+		"simple-import-sort/imports": ["error", {
+			groups: [[
+				String.raw`^\u0000`,
+				"^node:",
+				"^react",
+				"^react-dom",
+				String.raw`^@?\w`,
+				"^",
+				String.raw`^\.`,
+				String.raw`^.+\.s?css$`,
+			]],
+		}],
+		"sort-react-dependency-arrays/sort": "error",
+		"unicorn/filename-case": ["error", {
+			cases: {
+				camelCase: true,
+				kebabCase: true,
+				pascalCase: true,
+			},
+		}],
+	},
+}, {
+	files: "**/*.{ts,cts,mts,tsx}",
+	rules: {
+		"perfectionist/sort-interfaces": ["error", {
+			customGroups: { callback: "on*" },
+			groups: ["unknown", "callback"],
+		}],
+		"perfectionist/sort-object-types": ["error", {
+			customGroups: { callback: "on*" },
+			groups: ["unknown", "callback"],
+		}],
+	},
+}];

package/{tailwind.js → src/tailwind.js}

@@ -1,11 +1,12 @@
-"use strict";
+import eslintPluginReadableTailwind from "eslint-plugin-readable-tailwind";
+import tailwind from "eslint-plugin-tailwindcss";
 
-module.exports = {
-	extends: ["plugin:tailwindcss/recommended"],
-	plugins: ["readable-tailwind"],
+export default [...tailwind.configs["flat/recommended"], {
+	plugins: {
+		"readable-tailwind": eslintPluginReadableTailwind,
+	},
 	rules: {
 		"readable-tailwind/multiline": ["warn", {
-			group: "newLine",
 			indent: "tab",
 			preferSingleLine: true,
 			printWidth: 120,
@@ -18,4 +19,4 @@ module.exports = {
 			callees: ["classnames", "clsx", "ctl", "cva", "tv", "tva", "tw", "twMerge", "cn", "cnx"],
 		}],
 	},
-};
+}];

package/src/xo.js

@@ -0,0 +1,71 @@
+import perfectionist from "eslint-plugin-perfectionist";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+
+export default [{
+	plugins: {
+		perfectionist,
+		"simple-import-sort": simpleImportSort,
+	},
+	rules: {
+		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L304
+		"capitalized-comments": "off",
+		"import-x/extensions": "off",
+		"import-x/order": "off",
+		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L186
+		"no-warning-comments": ["warn", { decoration: ["/", "*"] }],
+		"object-shorthand": "off",
+		"perfectionist/sort-array-includes": "error",
+		"perfectionist/sort-maps": "error",
+		// maybe: perfectionist/sort-modules
+		"perfectionist/sort-objects": "error",
+		"perfectionist/sort-sets": "error",
+		// TODO: doesn't play nice with unicorn/switch-case-braces: https://github.com/azat-io/eslint-plugin-perfectionist/issues/54#issuecomment-2268283085
+		"perfectionist/sort-switch-case": "error",
+		"simple-import-sort/exports": "error",
+		"simple-import-sort/imports": ["error", {
+			groups: [[String.raw`^\u0000`, "^node:", String.raw`^@?\w`, "^", String.raw`^\.`]],
+		}],
+		"unicorn/prefer-regexp-test": "off",
+		"unicorn/prevent-abbreviations": "off",
+	},
+	settings: {
+		perfectionist: {
+			partitionByComment: "(group) *",
+			type: "natural",
+		},
+	},
+}, {
+	files: "**/*.{ts,cts,mts,tsx}",
+	rules: {
+		// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L384
+		"@typescript-eslint/no-confusing-void-expression": ["error", { ignoreArrowShorthand: true }],
+		// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L707
+		"@typescript-eslint/prefer-regexp-exec": "off",
+		"perfectionist/sort-enums": ["error", { forceNumericSort: true }],
+		"perfectionist/sort-heritage-clauses": "error",
+		"perfectionist/sort-interfaces": "error",
+		"perfectionist/sort-intersection-types": "error",
+		"perfectionist/sort-object-types": "error",
+		"perfectionist/sort-union-types": ["error", { groups: ["unknown", "keyword", "nullish"] }],
+	},
+	settings: {
+		n: { typescriptExtensionMap: [[".ts", ".ts"], [".tsx", ".tsx"]] },
+	},
+}, {
+	files: "test/**/*.*",
+	rules: {
+		"simple-import-sort/imports": ["error", {
+			groups: [[String.raw`^\u0000`, "^node:", "^ava", String.raw`^@?\w`, "^", String.raw`^\.`]],
+		}],
+	},
+}, {
+	files: [
+		"**/xo.config.js",
+		"**/xo.config.ts",
+		"**/eslint.config.js",
+		"**/eslint.config.ts",
+	],
+	rules: {
+		"import-x/no-anonymous-default-export": "off",
+	},
+}];

package/dprint.js

@@ -1,12 +0,0 @@
-"use strict";
-
-module.exports = {
-	extends: ["plugin:dprint-integration/disable-conflict"],
-	overrides: [{
-		files: "**/*.{ts,cts,mts,tsx}",
-		rules: {
-			"@typescript-eslint/object-curly-spacing": "off",
-			"@typescript-eslint/space-infix-ops": "off",
-		},
-	}],
-};

package/index.js

@@ -1,55 +0,0 @@
-"use strict";
-
-module.exports = {
-	plugins: ["perfectionist", "simple-import-sort"],
-	settings: {
-		perfectionist: {
-			partitionByComment: "(group) *",
-			type: "natural",
-		},
-	},
-	rules: {
-		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L304
-		"capitalized-comments": "off",
-		"import/extensions": "off",
-		"import/order": "off",
-		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L186
-		"no-warning-comments": ["warn", { decoration: ["/", "*"] }],
-		"object-shorthand": "off",
-		"perfectionist/sort-array-includes": "error",
-		"perfectionist/sort-maps": "error",
-		"perfectionist/sort-objects": "error",
-		// TODO: doesn't play nice with unicorn/switch-case-braces: https://github.com/azat-io/eslint-plugin-perfectionist/issues/54#issuecomment-2268283085
-		"perfectionist/sort-switch-case": "error",
-		"simple-import-sort/exports": "error",
-		"simple-import-sort/imports": ["error", {
-			groups: [["^\\u0000", "^node:", "^@?\\w", "^", "^\\."]],
-		}],
-		"unicorn/prefer-regexp-test": "off",
-		"unicorn/prevent-abbreviations": "off",
-	},
-	overrides: [{
-		files: "**/*.{ts,cts,mts,tsx}",
-		settings: {
-			n: { typescriptExtensionMap: [[".ts", ".ts"], [".tsx", ".tsx"]] },
-		},
-		rules: {
-			// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L384
-			"@typescript-eslint/no-confusing-void-expression": ["error", { ignoreArrowShorthand: true }],
-			// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L707
-			"@typescript-eslint/prefer-regexp-exec": "off",
-			"perfectionist/sort-enums": ["error", { forceNumericSort: true }],
-			"perfectionist/sort-interfaces": "error",
-			"perfectionist/sort-intersection-types": "error",
-			"perfectionist/sort-object-types": "error",
-			"perfectionist/sort-union-types": ["error", { groups: ["unknown", "keyword", "nullish"] }],
-		},
-	}, {
-		files: "test/**/*.*",
-		rules: {
-			"simple-import-sort/imports": ["error", {
-				groups: [["^\\u0000", "^node:", "^ava", "^@?\\w", "^", "^\\."]],
-			}],
-		},
-	}],
-};

package/react.js

@@ -1,43 +0,0 @@
-"use strict";
-
-module.exports = {
-	extends: [
-		"xo-react",
-		"plugin:react/jsx-runtime",
-		"plugin:jsx-a11y/recommended",
-	],
-	plugins: ["react-refresh", "sort-react-dependency-arrays"],
-	rules: {
-		"react/no-array-index-key": "warn",
-		"react-refresh/only-export-components": ["warn", { allowConstantExport: true }],
-		"simple-import-sort/imports": ["error", {
-			groups: [["^\\u0000", "^node:", "^react", "^react-dom", "^@?\\w", "^", "^\\.", "^.+\\.s?css$"]],
-		}],
-		"sort-react-dependency-arrays/sort": "error",
-		"unicorn/filename-case": ["error", {
-			cases: {
-				camelCase: true,
-				kebabCase: true,
-				pascalCase: true,
-			},
-		}],
-	},
-	overrides: [{
-		files: ["src/constants/**/*.{ts,cts,mts,tsx}", "**/constants.{ts,cts,mts,tsx}"],
-		rules: {
-			"@typescript-eslint/naming-convention": "off",
-		},
-	}, {
-		files: "**/*.{ts,cts,mts,tsx}",
-		rules: {
-			"perfectionist/sort-interfaces": ["error", {
-				customGroups: { callback: "on*" },
-				groups: ["unknown", "callback"],
-			}],
-			"perfectionist/sort-object-types": ["error", {
-				customGroups: { callback: "on*" },
-				groups: ["unknown", "callback"],
-			}],
-		},
-	}],
-};