@kitschpatrol/eslint-config 2.0.0 → 2.1.1

package/bin/cli.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import F from"chalk";import{execa as x}from"execa";import O from"meow";import d from"node:path";import{Transform as A}from"node:stream";import{fileURLToPath as S}from"node:url";import{packageUp as k}from"package-up";function $(o,t){return new A({transform(n,e,i){let m=n.toString().split(/\r?\n/).filter(l=>l.trim().length>0).map(l=>`${o?F[t]("["+o+"] "):""}${l}`).join(`
+`)+`
+`;this.push(m),i()}})}function N(o,t){let n=`
+  Usage
+    $ ${o} [<file|glob> ...]
+  `;if(Object.keys(t).length>0){n+=`
+  Options`;for(let e of Object.keys(t))switch(e){case"init":{n+=`
+    --init, -i            Initialize by copying starter config files to your project root.`;break}case"check":{n+=`
+    --check, -c           Check for and report issues. Same as ${o}.`;break}case"fix":{n+=`
+    --fix, -f             Fix all auto-fixable issues, and report the un-fixable.`;break}case"printConfig":{n+=`
+    --print-config <file> Print the effective configuration for a file`;break}default:console.error(`Unknown command name: ${e}`)}}return n}function j(o){return Object.keys(o).reduce((t,n)=>{let e={};switch(n){case"init":{e={shortFlag:"i",type:"boolean"};break}case"check":{e={aliases:["lint",""],shortFlag:"l",type:"boolean"};break}case"fix":{e={shortFlag:"f",type:"boolean"};break}case"printConfig":{e={type:"boolean"};break}default:console.error(`Unknown command name: ${n}`)}return t[n]=e,t},{})}async function y(o,t,n=[]){if(t.command!==void 0&&typeof t.command=="string"){let e;try{let i=x(t.command,[...t.options??[],...n],{env:{FORCE_COLOR:"true"},stdin:"inherit"});i.stdout?.pipe(o,{end:!1}),i.stderr?.pipe(o,{end:!1}),await i,e=i.exitCode??1}catch(i){e=typeof i.exitCode=="number"?i.exitCode:1}return e}return o.write(`Error: Invalid optionCommand: ${JSON.stringify(t,void 0,2)}`),1}function h(o,t,n){o.length===0&&!t.defaultArguments&&(n.write(`Error: This command must be used with a file argument
+`),process.exit(1))}async function C(o,t,n,e){let i=O(N(o,e),{allowUnknownFlags:!1,booleanDefault:void 0,flags:j(e),importMeta:import.meta}),{flags:u,input:m}=i,l=Object.keys(e).reduce((c,r)=>(u[r]&&(c[r]=e[r]),c),{});Object.keys(l).length===0&&(l.check=e.check);let s=$(t,n);s.pipe(process.stdout);let a=0;for(let[c,r]of Object.entries(l))if(typeof r.command=="function"){h(m,r,s);let f=m.length===0?r.defaultArguments??[]:m,g=r.options??[];a+=await r.command(s,f,g)}else if(typeof r.command=="string")h(m,r,s),a+=await y(s,r,m.length===0?r.defaultArguments:m);else switch(c){case"init":{let f=await k();if(f===void 0){s.write("Error: The `--init` flag must be used in a directory with a package.json file\n"),a+=1;break}let g=await k({cwd:S(import.meta.url)});if(g===void 0){s.write(`Error: The script being called was not in a package, weird.
+`),a+=1;break}let p=d.join(d.dirname(g),"init/"),b=d.dirname(f);s.write(`Copying initial configuration files from:
+"${p}" \u2192 "${b}"
+`);let w={command:"cp",options:["-Ri",`${p}`,`${b}`]};a+=await y(s,w);break}case"check":{console.error("No default implementation for check"),a+=1;break}case"fix":{console.error("No default implementation for fix"),a+=1;break}case"printConfig":{console.error("No default implementation for print-config"),a+=1;break}default:{console.error(`Unknown command name: ${c}`),a+=1;break}}process.exit(a>0?1:0)}await C("eslint-config","ESLint","magenta",{check:{command:"eslint",defaultArguments:["."]},fix:{command:"eslint",defaultArguments:["."],options:["--fix"]},init:{},printConfig:{command:"eslint",options:["--print-config"]}});

package/init/.eslintrc.cjs

@@ -1,4 +1,3 @@
-// eslint-disable-next-line no-undef
 module.exports = {
 	extends: ['@kitschpatrol/eslint-config'],
 };

package/main.cjs

@@ -1,23 +1,59 @@
-// eslint-disable-next-line no-undef
 /* @type {import('eslint').Linter.Config} */
+
+const extendsPrefix = [
+	'eslint:recommended',
+	'plugin:n/recommended',
+	'plugin:unicorn/recommended',
+	'xo',
+	'plugin:perfectionist/recommended-natural',
+];
+
+const extendsSuffix = ['prettier'];
+
+const rulesConfig = {
+	// Possible perfectionist conflicts
+	'@typescript-eslint/adjacent-overload-signatures': 'off',
+	'@typescript-eslint/sort-type-constituents': 'off',
+	'import/order': 'off',
+	'n/no-process-exit': 'off', // Duplicated in unicorn
+	'no-await-in-loop': 'off',
+	'no-warning-comments': 'off',
+	'perfectionist/sort-imports': [
+		'error',
+		{
+			'newlines-between': 'never',
+		},
+	],
+	'react/jsx-sort-props': 'off',
+	'sort-imports': 'off',
+	'unicorn/no-array-reduce': 'off',
+	'unicorn/prevent-abbreviations': [
+		'error',
+		{
+			allowList: {
+				Props: true,
+				acc: true,
+				args: true,
+				props: true,
+			},
+		},
+	],
+};
+
 module.exports = {
 	env: {
 		browser: true,
 		node: true,
 	},
-	extends: [
-		'eslint:recommended',
-		'plugin:@typescript-eslint/recommended',
-		'plugin:@typescript-eslint/recommended',
-		'plugin:astro/recommended',
-		'plugin:astro/jsx-a11y-recommended',
-		'plugin:svelte/recommended',
-		'plugin:unicorn/recommended',
-		'prettier',
-		'plugin:perfectionist/recommended-natural',
-	],
+	extends: [...extendsPrefix, ...extendsSuffix],
 	overrides: [
 		{
+			extends: [...extendsPrefix, 'plugin:@typescript-eslint/recommended', 'xo-typescript', ...extendsSuffix],
+			files: ['*.ts', '*.tsx', '*.mts', '*.cts'],
+			rules: rulesConfig,
+		},
+		{
+			extends: [...extendsPrefix, 'plugin:svelte/recommended', 'xo-typescript', ...extendsSuffix],
 			files: ['*.astro'],
 			parser: 'astro-eslint-parser',
 			parserOptions: {
@@ -25,6 +61,7 @@ module.exports = {
 				parser: '@typescript-eslint/parser',
 			},
 			rules: {
+				...rulesConfig,
 				'no-unused-vars': [
 					'error',
 					{
@@ -32,47 +69,34 @@ module.exports = {
 						destructuredArrayIgnorePattern: '^_',
 					},
 				],
+				// Todo enforce capitalization?
 				'unicorn/filename-case': 'off',
 			},
 		},
 		{
+			extends: [
+				...extendsPrefix,
+				'plugin:astro/recommended',
+				'plugin:astro/jsx-a11y-recommended',
+				'plugin:@typescript-eslint/recommended',
+				'xo-typescript',
+				...extendsSuffix,
+			],
 			files: ['*.svelte'],
 			parser: 'svelte-eslint-parser',
 			parserOptions: {
 				parser: '@typescript-eslint/parser',
 			},
 			rules: {
+				...rulesConfig,
 				// https://github.com/nuxt/eslint-config/issues/140
 				'@typescript-eslint/ban-types': 'off',
 				// https://github.com/typescript-eslint/typescript-eslint/blob/1cf9243/docs/getting-started/linting/FAQ.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
 				'no-undef': 'off',
+				// Todo enforce capitalization?
 				'unicorn/filename-case': 'off',
 			},
 		},
 	],
-	rules: {
-		// possible perfectionist conflicts
-		'@typescript-eslint/adjacent-overload-signatures': 'off',
-		'@typescript-eslint/sort-type-constituents': 'off',
-		'import/order': 'off',
-		'perfectionist/sort-imports': [
-			'error',
-			{
-				'newlines-between': 'never',
-			},
-		],
-		'react/jsx-sort-props': 'off',
-		'sort-imports': 'off',
-		'unicorn/no-array-reduce': 'off',
-		'unicorn/prevent-abbreviations': [
-			'error',
-			{
-				allowList: {
-					Props: true,
-					props: true,
-					args: true,
-				},
-			},
-		],
-	},
+	rules: rulesConfig,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/eslint-config",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "type": "module",
   "description": "Eslint config for @kitschpatrol/shared-config",
   "repository": {
@@ -23,26 +23,39 @@
     "pnpm": ">=8.0.0"
   },
   "bin": {
-    "eslint-config": "./cli.js"
+    "eslint-config": "bin/cli.js"
   },
-  "main": "main.cjs",
+  "main": "./main.cjs",
+  "files": [
+    "bin",
+    "init"
+  ],
   "peerDependencies": {
     "eslint": ">=8.52.0"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
     "astro-eslint-parser": "^0.16.0",
+    "chalk": "^5.3.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-config-xo": "^0.43.1",
+    "eslint-config-xo-typescript": "^1.0.1",
     "eslint-plugin-astro": "^0.30.0",
     "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.4.0",
     "eslint-plugin-perfectionist": "^2.5.0",
     "eslint-plugin-svelte": "^2.35.1",
     "eslint-plugin-unicorn": "^49.0.0",
-    "minimist": "^1.2.8",
-    "zx": "^7.2.3"
+    "execa": "^8.0.1",
+    "meow": "^12.1.1",
+    "package-up": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "../../scripts/build.ts",
+    "cli": "node ./bin/cli.js"
   }
 }

package/cli.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env zx
-/* eslint-disable unicorn/prefer-module */
-import minimist from 'minimist';
-import { $, path } from 'zx';
-import 'zx/globals';
-
-async function main() {
-	const options = ['init', 'fix', 'check'];
-	const args = minimist(process.argv.slice(2), {
-		boolean: options,
-	});
-
-	const argumentCount = options.reduce((count, argument) => count + (args[argument] ? 1 : 0), 0);
-	if (argumentCount !== 1) {
-		console.error(`[ESLint] Please provide exactly one of ${options.map((opt) => `--${opt}`).join(' or ')}`);
-		process.exit(1);
-	}
-
-	process.env.FORCE_COLOR = '1';
-	if (args.init) {
-		await $`cp -Ri ${path.join(__dirname, 'init')}/. ${process.cwd()}`.nothrow();
-	} else if (args.fix) {
-		await $`eslint --fix .`;
-	} else if (args.check) {
-		await $`eslint .`;
-	}
-}
-
-await main();