@kitschpatrol/shared-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/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@kitschpatrol/shared-config",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Linting and formatting for web projects.",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:kitschpatrol/shared-config.git"
+  },
+  "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": {
+    "shared-config-init": "./scripts/init.js",
+    "shared-config-fix": "./scripts/fix.js",
+    "shared-config-lint": "./scripts/lint.js"
+  },
+  "files": [
+    "scripts"
+  ],
+  "dependencies": {
+    "@kitschpatrol/eslint-config": "1.0.0",
+    "@kitschpatrol/npm-config": "1.0.0",
+    "@kitschpatrol/vscode-config": "1.0.0",
+    "@kitschpatrol/prettier-config": "1.0.0",
+    "@kitschpatrol/stylelint-config": "1.0.0",
+    "@kitschpatrol/markdownlint-config": "1.0.0",
+    "@kitschpatrol/cspell-config": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,95 @@
+# shared-config
+
+## Overview
+
+A collection of shared configurations for various linters and tools.
+
+This package takes a maximalist approach, bundling plugins I need on a regular basis into a single dependency.
+
+It takes care of dependencies and configurations for:
+
+- CSpell
+- ESLint (including Svelte, Astro, and Typescript support)
+- Stylelint
+- markdownlint
+- NPM (`.npmrc` config)
+- Prettier (including a bunch of extra plugins)
+- VSCode (extension recommendations and extension settings)
+
+It's only been tested with `pnpm`.
+
+## Setup
+
+1. Install the requisite `.npmrc`:
+
+   ```sh
+   pnpm dlx @kitschpatrol/npm-config
+   ```
+
+2. Install the package:
+
+   ```sh
+   pnpm add @kitschpatrol/shared-config
+   ```
+
+3. Add default config files for all the tools to your project root:
+
+   ```sh
+   pnpm shared-config-init
+   ```
+
+4. Add helper scripts to your `package.json`:
+
+   These work a bit like [npm-run-all](https://github.com/mysticatea/npm-run-all) to invoke all of the bundled tools.
+
+   ```json
+   ...
+   "scripts": {
+     "format": "shared-config-fix",
+     "lint": "shared-config-lint",
+   }
+   ...
+   ```
+
+   Note that Prettier formatting for Ruby requires some extra legwork to configure, see [`@kitschpatrol/prettier-config`](https://github.com/kitschpatrol/prettier-config) for more details.
+
+## Usage
+
+Various VSCode plugins should "just work".
+
+To lint your entire project:
+
+```sh
+pnpm run lint
+```
+
+To run all of the tools in a _potentially destructive_ "fix" capacity:
+
+```sh
+pnpm run format
+```
+
+## Todo
+
+- [ ] `.tsconfig`?
+- [ ] Interactive override / merge prompt
+- [ ] DRY script invocation / initial config copying?
+
+## Issues
+
+- CSpell, markdownlint, ESLint, and Prettier all need to be hoisted via `public-hoist-pattern` to be accessible in `pnpm exec` scripts and to VSCode plugins.
+
+- Even basic file-only packages like `vscode-config` and `npm-config` seem to need to be hoisted via for their bin scripts to be accessible via `pnpm exec`
+
+## Dev Notes
+
+- Note that `prettier` and `eslint` packages are [hoisted by default](https://pnpm.io/npmrc#public-hoist-pattern) in `pnpm`
+
+- For local development via `pnpm`, use `file:` dependency protocol instead of `link:`
+
+## Reference projects
+
+- [1stG/configs](https://github.com/1stG/configs)
+- [sheriff](https://www.eslint-config-sheriff.dev)
+- [xo](https://github.com/xojs/xo)
+- [standard](https://standardjs.com)

package/scripts/fix.js

@@ -0,0 +1,5 @@
+// Uses all tools to fix the project
+
+import { runAllCommands } from './run-helper.js';
+
+runAllCommands(true);

package/scripts/init.js

@@ -0,0 +1,39 @@
+// Copies configuration files for all tools to the root of the project
+// It does not overwrite existing files
+
+import { exec as execCallback } from 'node:child_process';
+import console from 'node:console';
+import { promisify } from 'node:util';
+
+const exec = promisify(execCallback);
+
+async function execCommand(command) {
+	try {
+		const { stderr, stdout } = await exec(command);
+		if (stderr) {
+			console.error(`stderr: ${stderr}`);
+		}
+		console.log(stdout);
+		return stdout;
+	} catch (error) {
+		console.error(`Error: ${error}`);
+		throw error; // Rethrow the error for further handling
+	}
+}
+
+async function runCommands() {
+	try {
+		await execCommand('pnpm exec eslint-config-init');
+		await execCommand('pnpm exec prettier-config-init');
+		await execCommand('pnpm exec stylelint-config-init');
+		await execCommand('pnpm exec npm-config-init');
+		await execCommand('pnpm exec markdownlint-config-init');
+		await execCommand('pnpm exec cspell-config-init');
+		await execCommand('pnpm exec vscode-config-init');
+		console.log('All configurations have been initialized successfully.');
+	} catch (error) {
+		console.error('An error occurred while initializing configurations:', error);
+	}
+}
+
+await runCommands();

package/scripts/lint.js

@@ -0,0 +1,5 @@
+// Uses all tools to check / lint the project
+
+import { runAllCommands } from './run-helper.js';
+
+runAllCommands(false);

package/scripts/run-helper.js

@@ -0,0 +1,128 @@
+/* eslint-disable unicorn/no-process-exit */
+// Helper to run multiple commands
+import { spawn } from 'node:child_process';
+import console from 'node:console';
+import { once } from 'node:events';
+import process from 'node:process';
+
+const commands = stylePrefixes([
+	{
+		command: 'eslint .',
+		fixArgument: '--fix',
+		lintArgument: '',
+		prefix: 'ESLint',
+	},
+	// Other commands...
+	{
+		command: 'stylelint --allow-empty-input "**/*.{css,scss,sass,svelte,html,astro}"',
+		fixArgument: '--fix',
+		lintArgument: '',
+		prefix: 'Stylelint',
+	},
+	{
+		command:
+			'prettier --plugin=@prettier/plugin-php --plugin=@prettier/plugin-ruby --plugin=@prettier/plugin-xml --plugin=prettier-plugin-astro --plugin=prettier-plugin-pkg --plugin=prettier-plugin-sh --plugin=prettier-plugin-sql --plugin=prettier-plugin-svelte --plugin=prettier-plugin-tailwindcss --plugin=prettier-plugin-toml .',
+		fixArgument: '--write',
+		lintArgument: '--check',
+		prefix: 'Prettier',
+	},
+	{
+		command: 'markdownlint "**/*.{md,mdx}" --ignore-path .gitignore',
+		fixArgument: '--fix',
+		lintArgument: '',
+		prefix: 'markdownlint',
+	},
+	{
+		command: 'cspell --quiet .',
+		fixArgument: '',
+		lintArgument: '',
+		prefix: 'CSpell',
+	},
+]);
+
+function stylePrefixes(commands) {
+	// ANSI color codes (excluding red and ANSI 256-colors)
+	const colors = [
+		'\u001B[32m', // Green
+		'\u001B[34m', // Blue
+		'\u001B[33m', // Yellow
+		'\u001B[35m', // Magenta
+		'\u001B[36m', // Cyan
+		'\u001B[94m', // Bright Blue
+		'\u001B[92m', // Bright Green
+		'\u001B[93m', // Bright Yellow
+		'\u001B[95m', // Bright Magenta
+	];
+	const boldCode = '\u001B[1m';
+	const resetCode = '\u001B[0m';
+
+	// Find the length of the longest prefix
+	const longestPrefixLength = commands.reduce((max, cmd) => Math.max(max, cmd.prefix.length), 0);
+
+	// Pad each prefix with spaces to match the length of the longest prefix
+	return commands.map((cmd, index) => {
+		const colorCode = boldCode + colors[index % colors.length];
+		const paddedLength = longestPrefixLength;
+		const paddingLength = paddedLength - cmd.prefix.length;
+		const paddedPrefix = colorCode + '[' + cmd.prefix + ' '.repeat(paddingLength) + ']' + resetCode;
+		return { ...cmd, prefix: paddedPrefix };
+	});
+}
+
+async function runCommand({ command, fixArgument, lintArgument, prefix }, fix = false) {
+	const fullCommand = `${command} ${fix ? fixArgument : lintArgument}`;
+	console.log(`${prefix} Running command: ${fullCommand}`);
+
+	const subprocess = spawn(fullCommand, {
+		env: { ...process.env, FORCE_COLOR: true },
+		shell: true,
+	});
+
+	subprocess.stdout.on('data', (data) => {
+		const lines = data.toString().split(/\r?\n/);
+		const prefixedLines = lines
+			.filter((line) => line.trim() !== '') // Filter out empty lines
+			.map((line) => `${prefix} ${line}`)
+			.join('\n');
+		if (prefixedLines) {
+			process.stdout.write(prefixedLines + '\n'); // Add a newline at the end if there's output
+		}
+	});
+
+	subprocess.stderr.on('data', (data) => {
+		const lines = data.toString().split(/\r?\n/);
+		const prefixedLines = lines
+			.filter((line) => line.trim() !== '') // Filter out empty lines
+			.map((line) => `${prefix} ${line}`)
+			.join('\n');
+		if (prefixedLines) {
+			console.error(prefixedLines + '\n'); // Add a newline at the end if there's output
+		}
+	});
+
+	// Wait for the 'close' event
+	const [code] = await once(subprocess, 'close');
+	if (code !== 0) {
+		throw new Error(`${prefix} Command failed with exit code ${code}`);
+	}
+}
+
+export async function runAllCommands(fix = false) {
+	let errors = [];
+	for (const cmd of commands) {
+		try {
+			await runCommand(cmd, fix);
+		} catch (error) {
+			errors.push(error.message);
+		}
+	}
+
+	if (errors.length > 0) {
+		console.error(`${errors.length} task(s) failed:`);
+		for (const error of errors) console.error(error);
+		process.exit(1);
+	} else {
+		console.log('All tasks completed successfully.');
+		process.exit(0);
+	}
+}