@tommy-mitchell/eslint-config-xo 0.3.1 → 0.4.0

package/dprint.js

@@ -0,0 +1,12 @@
+"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,44 +1,33 @@
 "use strict";
-const { importOrder, preventAbbreviations } = require("./helpers.js");
 
 module.exports = {
-	extends: ["plugin:@phaphoso/dprint/disable-conflict-rules"],
+	plugins: ["simple-import-sort"],
 	rules: {
-		"object-shorthand": "off",
-		"unicorn/prefer-regexp-test": "off",
+		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L304
+		"capitalized-comments": "off",
 		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L186
 		"no-warning-comments": ["warn", { decoration: ["/", "*"] }],
-		// https://github.com/xojs/eslint-config-xo/blob/v0.44.0/index.js#L304
-		"capitalized-comments": ["error", "always", {
-			ignorePattern: "dprint-ignore|pragma|ignore|prettier-ignore|webpack\\w+:|c8|type-coverage:",
-			ignoreInlineComments: true,
-			ignoreConsecutiveComments: true,
+		"object-shorthand": "off",
+		"import/extensions": "off",
+		"import/order": "off",
+		// "n/file-extension-in-import": ["error", "always"],
+		"simple-import-sort/imports": ["error", {
+			groups: [["^\\u0000", "^node:", "^react", "^react-dom", "^@?\\w", "^", "^\\."]],
 		}],
-		"import/order": ["error", importOrder],
-		"unicorn/prevent-abbreviations": [
-			"error",
-			preventAbbreviations({
-				pkg: false,
-				args: false,
-				req: false,
-				res: false,
-				prop: false,
-				props: false,
-				ref: false,
-			}),
-		],
+		"simple-import-sort/exports": "error",
+		"unicorn/prefer-regexp-test": "off",
+		"unicorn/prevent-abbreviations": "off",
 	},
 	overrides: [{
 		files: "**/*.{ts,cts,mts,tsx}",
+		settings: {
+			n: { typescriptExtensionMap: [[".ts", ".ts"]] },
+		},
 		rules: {
-			"@typescript-eslint/object-curly-spacing": "off",
 			// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L384
 			"@typescript-eslint/no-confusing-void-expression": ["error", { ignoreArrowShorthand: true }],
-			"n/file-extension-in-import": ["error", "always", { ".ts": "always", ".tsx": "always" }],
 			// https://github.com/xojs/eslint-config-xo-typescript/blob/v2.0.0/index.js#L707
 			"@typescript-eslint/prefer-regexp-exec": "off",
-			// Conflicts with dprint
-			"@typescript-eslint/space-infix-ops": "off",
 		},
 	}],
 };

package/package.json

@@ -1,31 +1,47 @@
 {
 	"name": "@tommy-mitchell/eslint-config-xo",
-	"version": "0.3.1",
+	"version": "0.4.0",
 	"description": "Personal config for XO.",
 	"keywords": [
 		"nodejs",
 		"config",
 		"xo"
 	],
-	"license": "MIT",
 	"repository": "tommy-mitchell/eslint-config-xo",
+	"license": "MIT",
 	"author": {
 		"name": "Tommy Mitchell",
 		"url": "https://tommymitchell.io"
 	},
 	"sideEffects": false,
 	"files": [
+		"dprint.js",
 		"index.js",
 		"react.js",
-		"tailwind.js",
-		"helpers.js"
+		"tailwind.js"
 	],
-	"engines": {
-		"node": ">=18"
-	},
 	"scripts": {
+		"format": "dprint fmt && xo --fix",
 		"lint": "xo",
-		"format": "dprint fmt && xo --fix"
+		"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-react": "^7.35.0",
+		"eslint-plugin-react-hooks": "^4.6.2",
+		"eslint-plugin-react-refresh": "^0.4.9",
+		"eslint-plugin-readable-tailwind": "^1.5.3",
+		"eslint-plugin-simple-import-sort": "^12.1.1",
+		"eslint-plugin-tailwindcss": "^3.17.4"
+	},
+	"devDependencies": {
+		"@tommy-mitchell/dprint-config": "^0.2.0",
+		"ava": "^6.1.3",
+		"dprint": "0.x",
+		"execa": "^9.3.0",
+		"xo": "0.x"
 	},
 	"peerDependencies": {
 		"dprint": "0.x",
@@ -44,17 +60,7 @@
 			"optional": true
 		}
 	},
-	"dependencies": {
-		"@phaphoso/eslint-plugin-dprint": "^0.5.2",
-		"eslint-config-xo-react": "^0.27.0",
-		"eslint-plugin-jsx-a11y": "^6.8.0",
-		"eslint-plugin-react": "^7.33.2",
-		"eslint-plugin-react-hooks": "^4.6.0",
-		"eslint-plugin-tailwindcss": "^3.14.3"
-	},
-	"devDependencies": {
-		"@tommy-mitchell/dprint-config": "^0.1.1",
-		"dprint": "0.x",
-		"xo": "0.x"
+	"engines": {
+		"node": "^18.18 || ^20.8 || >=21"
 	}
 }

package/react.js

@@ -1,13 +1,17 @@
 "use strict";
-const { importOrder } = require("./helpers.js");
 
 module.exports = {
 	extends: [
 		"xo-react",
+		"plugin:react/jsx-runtime",
 		"plugin:jsx-a11y/recommended",
 	],
+	plugins: ["react-refresh"],
 	rules: {
 		"react/no-array-index-key": "warn",
+		"react-refresh/only-export-components": ["warn", {
+			allowConstantExport: true,
+		}],
 		"unicorn/filename-case": ["error", {
 			cases: {
 				camelCase: true,
@@ -15,16 +19,9 @@ module.exports = {
 				pascalCase: true,
 			},
 		}],
-		"import/order": ["error", {
-			...importOrder,
-			pathGroups: [{
-				pattern: "@{assets|constants|components|content|providers|helpers|hooks|utils}/**",
-				group: "internal",
-			}],
-		}],
 	},
 	overrides: [{
-		files: "src/constants/**/*.{ts,cts,mts,tsx}",
+		files: ["src/constants/**/*.{ts,cts,mts,tsx}", "**/constants.{ts,cts,mts,tsx}"],
 		rules: {
 			"@typescript-eslint/naming-convention": "off",
 		},

package/readme.md

@@ -10,19 +10,21 @@ npm install --save-dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprin
 
 <details>
 <summary>Other Package Managers</summary>
-
-<br />
+<p>
 
 ```sh
 yarn add --dev @tommy-mitchell/eslint-config-xo xo @tommy-mitchell/dprint-config dprint
 ```
 
+</p>
 </details>
 
 ### Peer Dependencies
 
 - [xo](https://github.com/xojs/xo) - JavaScript/TypeScript linter (ESLint wrapper) with great defaults.
-- [dprint](https://github.com/dprint/dprint) - Pluggable and configurable code formatting platform written in Rust.
+- [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
 
@@ -32,12 +34,24 @@ Add to the `extends` section of your `XO` config:
 "extends": ["@tommy-mitchell/xo"],
 ```
 
+### dprint
+
+```jsonc
+"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/dprint"],
+```
+
 ### React
 
 ```jsonc
 "extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react"],
 ```
 
+#### React + dprint
+
+```jsonc
+"extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/react", "@tommy-mitchell/xo/dprint"],
+```
+
 ### Tailwind CSS
 
 ```jsonc

package/tailwind.js

@@ -2,9 +2,18 @@
 
 module.exports = {
 	extends: ["plugin:tailwindcss/recommended"],
+	plugins: ["readable-tailwind"],
 	rules: {
+		"readable-tailwind/multiline": ["warn", {
+			group: "newLine",
+			indent: "tab",
+			printWidth: 120,
+		}],
+		"readable-tailwind/no-unnecessary-whitespace": "warn",
+		"readable-tailwind/sort-classes": "warn",
+		"tailwindcss/classnames-order": "off",
 		"tailwindcss/no-custom-classname": ["warn", {
-			callees: ["classnames", "clsx", "ctl", "cva", "tv", "cn", "cnx"],
+			callees: ["classnames", "clsx", "ctl", "cva", "tv", "tva", "tw", "twMerge", "cn", "cnx"],
 		}],
 	},
 };

package/helpers.js

@@ -1,118 +0,0 @@
-"use strict";
-
-exports.importOrder = {
-	"groups": [
-		"builtin",
-		"external",
-		"parent",
-		"sibling",
-		"index",
-	],
-	"newlines-between": "never",
-	"warnOnUnassignedImports": true,
-	"distinctGroup": true,
-};
-
-// Defaults from https://github.com/xojs/xo/blob/v0.57.0/config/plugins.cjs#L38
-exports.preventAbbreviations = (extras) => ({
-	checkFilenames: false,
-	checkDefaultAndNamespaceImports: false,
-	checkShorthandImports: false,
-	extendDefaultReplacements: true,
-	replacements: {
-		// https://thenextweb.com/dd/2020/07/13/linux-kernel-will-no-longer-use-terms-blacklist-and-slave/
-		whitelist: {
-			include: true,
-		},
-		blacklist: {
-			exclude: true,
-		},
-		master: {
-			main: true,
-		},
-		slave: {
-			secondary: true,
-		},
-
-		// Reverse.
-		application: {
-			app: true,
-		},
-		applications: {
-			apps: true,
-		},
-
-		// Disable some that may be too annoying.
-		env: false,
-		i: false, // Do it at some point, but not ready for it yet. Maybe 2025.
-
-		// Not part of `eslint-plugin-unicorn`. Upstream them at some point.
-		bin: {
-			binary: true,
-		},
-		eof: {
-			endOfFile: true,
-		},
-		impl: {
-			implement: true,
-			implementation: true,
-		},
-		anim: {
-			animation: true,
-		},
-		calc: {
-			calculate: true,
-		},
-		dict: {
-			dictionary: true,
-		},
-		dup: {
-			duplicate: true,
-		},
-		enc: {
-			encode: true,
-			encryption: true,
-		},
-		gen: {
-			generate: true,
-			general: true,
-		},
-		gfx: {
-			graphics: true,
-		},
-		inc: {
-			increment: true,
-		},
-		iter: {
-			iterate: true,
-			iterator: true,
-		},
-		nav: {
-			navigate: true,
-			navigation: true,
-		},
-		norm: {
-			normalize: true,
-		},
-		notif: {
-			notification: true,
-		},
-		perf: {
-			performance: true,
-		},
-		proc: {
-			process: true,
-		},
-		rand: {
-			random: true,
-		},
-		sys: {
-			system: true,
-		},
-		temp: {
-			temporary: true,
-		},
-
-		...extras,
-	},
-});