@kitschpatrol/eslint-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Eric Mika
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/init/.eslintignore

@@ -0,0 +1 @@
+# TODO

package/init/.eslintrc.cjs

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

package/init.js

@@ -0,0 +1,22 @@
+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.`);
+	}
+}

package/main.cjs

@@ -0,0 +1,76 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+	// env: {
+	// 	browser: true,
+	// 	es2017: 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',
+	],
+	overrides: [
+		{
+			files: ['*.astro'],
+			parser: 'astro-eslint-parser',
+			parserOptions: {
+				extraFileExtensions: ['.astro'],
+				parser: '@typescript-eslint/parser',
+			},
+			rules: {
+				'no-unused-vars': [
+					'error',
+					{
+						argsIgnorePattern: '^_',
+						destructuredArrayIgnorePattern: '^_',
+					},
+				],
+				'unicorn/filename-case': 'off',
+			},
+		},
+		{
+			files: ['*.svelte'],
+			parser: 'svelte-eslint-parser',
+			parserOptions: {
+				parser: '@typescript-eslint/parser',
+			},
+			rules: {
+				// 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',
+				'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,
+				},
+			},
+		],
+	},
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@kitschpatrol/eslint-config",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Eslint config for @kitschpatrol/shared-config",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:kitschpatrol/shared-config.git",
+    "directory": "packages/eslint-config"
+  },
+  "bugs": {
+    "url": "https://github.com/kitschpatrol/shared-config/issues",
+    "email": "eric@ericmika.com"
+  },
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.0.0"
+  },
+  "bin": {
+    "eslint-config-init": "./init.js"
+  },
+  "main": "main.cjs",
+  "peerDependencies": {
+    "eslint": ">=8.52.0"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "astro-eslint-parser": "^0.16.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-astro": "^0.30.0",
+    "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"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,48 @@
+# @kitschpatrol/eslint-config
+
+## Overview
+
+It's a shared [ESLint](https://eslint.org) config.
+
+**See [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) for the recommended single-package approach.**
+
+## Setup
+
+To use just this ESLint config in isolation:
+
+1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
+
+   ```sh
+   pnpm dlx @kitschpatrol/npm-config
+   ```
+
+2. Add the package:
+
+   ```sh
+   pnpm add @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
+   ```
+
+## Usage
+
+The ESLint binary should be picked up automatically by VSCode plugins.
+
+Integrate with your `package.json` scripts as you see fit, for example:
+
+```json
+...
+"scripts": {
+  "lint": "eslint ."
+  "fix": "eslint --fix ."
+}
+...
+```
+
+## Notes
+
+The whole flat file config thing is pending...