@kitschpatrol/eslint-config 1.0.0 → 2.0.0

package/cli.js

@@ -0,0 +1,29 @@
+#!/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();

package/main.cjs

@@ -1,10 +1,10 @@
 // eslint-disable-next-line no-undef
+/* @type {import('eslint').Linter.Config} */
 module.exports = {
-	// env: {
-	// 	browser: true,
-	// 	es2017: true,
-	// 	node: true,
-	// },
+	env: {
+		browser: true,
+		node: true,
+	},
 	extends: [
 		'eslint:recommended',
 		'plugin:@typescript-eslint/recommended',
@@ -69,6 +69,8 @@ module.exports = {
 			{
 				allowList: {
 					Props: true,
+					props: true,
+					args: true,
 				},
 			},
 		],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/eslint-config",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "Eslint config for @kitschpatrol/shared-config",
   "repository": {
@@ -23,7 +23,7 @@
     "pnpm": ">=8.0.0"
   },
   "bin": {
-    "eslint-config-init": "./init.js"
+    "eslint-config": "./cli.js"
   },
   "main": "main.cjs",
   "peerDependencies": {
@@ -38,7 +38,9 @@
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-perfectionist": "^2.5.0",
     "eslint-plugin-svelte": "^2.35.1",
-    "eslint-plugin-unicorn": "^49.0.0"
+    "eslint-plugin-unicorn": "^49.0.0",
+    "minimist": "^1.2.8",
+    "zx": "^7.2.3"
   },
   "publishConfig": {
     "access": "public"

package/readme.md

@@ -19,26 +19,28 @@ To use just this ESLint config in isolation:
 2. Add the package:
 
    ```sh
-   pnpm add @kitschpatrol/eslint-config
+   pnpm add -D @kitschpatrol/eslint-config
    ```
 
 3. Add the starter `.eslintrc.cjs` config and `.eslintignore` files to your project root, and add any overrides you'd like:
 
    ```sh
-   pnpm exec eslint-config-init
+   pnpm exec eslint-config --init
    ```
 
 ## Usage
 
 The ESLint binary should be picked up automatically by VSCode plugins.
 
+You can call it directly, or use the script bundled with the config.
+
 Integrate with your `package.json` scripts as you see fit, for example:
 
 ```json
 ...
 "scripts": {
-  "lint": "eslint ."
-  "fix": "eslint --fix ."
+  "lint": "eslint-config --check"
+  "fix": "eslint-config --fix"
 }
 ...
 ```

package/init.js

@@ -1,22 +0,0 @@
-import console from 'node:console';
-import fs from 'node:fs';
-import path from 'node:path';
-import process from 'node:process';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-const sourceDirectory = path.join(__dirname, 'init');
-const destinationDirectory = process.cwd(); // (project root)
-
-for (const file of fs.readdirSync(sourceDirectory)) {
-	const sourcePath = path.join(sourceDirectory, file);
-	const destinationPath = path.join(destinationDirectory, file);
-
-	if (fs.existsSync(destinationPath)) {
-		console.log(`${file} already exists in project root, skipping.`);
-	} else {
-		fs.copyFileSync(sourcePath, destinationPath);
-		console.log(`Copied ${file} to project root.`);
-	}
-}