@tommy-mitchell/eslint-config-xo 0.1.1 → 0.2.0

package/helpers.js

@@ -10,3 +10,107 @@ exports.importOrder = {
 	"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,
+	},
+});

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const { importOrder } = require("./helpers.js");
+const { importOrder, preventAbbreviations } = require("./helpers.js");
 
 module.exports = {
 	extends: ["plugin:@phaphoso/dprint/disable-conflict-rules"],
@@ -16,6 +16,15 @@ module.exports = {
 			ignoreConsecutiveComments: true,
 		}],
 		"import/order": ["error", importOrder],
+		"unicorn/prevent-abbreviations": [
+			"error",
+			preventAbbreviations({
+				pkg: false,
+				args: false,
+				req: false,
+				res: false,
+			}),
+		],
 	},
 	overrides: [{
 		files: "**/*.{ts,cts,mts,tsx}",
@@ -26,6 +35,8 @@ module.exports = {
 			"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,6 +1,6 @@
 {
 	"name": "@tommy-mitchell/eslint-config-xo",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "Personal config for XO.",
 	"keywords": [
 		"nodejs",

package/readme.md

@@ -42,6 +42,16 @@ Add to the `extends` section of your `XO` config:
 "extends": ["@tommy-mitchell/xo", "@tommy-mitchell/xo/tailwind"],
 ```
 
+### VS Code
+
+Add the following to your `settings.json`:
+
+```jsonc
+"xo.enable": true,
+"xo.format.enable": true,
+"xo.overrideSeverity": "warn",
+```
+
 ## Related
 
 - [XO (VS Code Extension)](https://marketplace.visualstudio.com/items?itemName=samverschueren.linter-xo) - Linter for XO.