@kitschpatrol/shared-config 2.0.1 → 2.1.0

package/bin/cli.js

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

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@kitschpatrol/shared-config",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "type": "module",
   "description": "Linting and formatting for web projects.",
   "repository": {
     "type": "git",
-    "url": "git@github.com:kitschpatrol/shared-config.git"
+    "url": "git@github.com:kitschpatrol/shared-config.git",
+    "directory": "packages/shared-config"
   },
   "bugs": {
     "url": "https://github.com/kitschpatrol/shared-config/issues",
@@ -22,23 +23,34 @@
     "pnpm": ">=8.0.0"
   },
   "bin": {
-    "shared-config": "./cli.js"
+    "shared-config": "bin/cli.js"
   },
   "files": [
-    "cli.js"
+    "bin"
   ],
   "dependencies": {
-    "minimist": "^1.2.8",
-    "zx": "^7.2.3",
-    "@kitschpatrol/cspell-config": "2.0.0",
-    "@kitschpatrol/eslint-config": "2.0.0",
-    "@kitschpatrol/markdownlint-config": "2.0.0",
-    "@kitschpatrol/npm-config": "2.0.0",
-    "@kitschpatrol/stylelint-config": "2.0.0",
-    "@kitschpatrol/vscode-config": "2.0.0",
-    "@kitschpatrol/prettier-config": "2.0.0"
+    "chalk": "^5.3.0",
+    "execa": "^8.0.1",
+    "meow": "^12.1.1",
+    "package-up": "^5.0.0",
+    "@kitschpatrol/eslint-config": "2.1.0",
+    "@kitschpatrol/npm-config": "2.1.0",
+    "@kitschpatrol/cspell-config": "2.1.0",
+    "@kitschpatrol/markdownlint-config": "2.1.0",
+    "@kitschpatrol/prettier-config": "2.1.0",
+    "@kitschpatrol/stylelint-config": "2.1.0",
+    "@kitschpatrol/vscode-config": "2.1.0"
+  },
+  "devDependencies": {
+    "camelcase": "^8.0.0",
+    "globby": "^14.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "./scripts/capability-generator.ts && ../../scripts/build.ts",
+    "clean": "pnpm run bin-restore && git clean -fdX",
+    "cli": "node ./bin/cli.js"
   }
 }

package/cli.js

@@ -1,175 +0,0 @@
-#!/usr/bin/env zx
-/* eslint-disable unicorn/prefer-module */
-import minimist from 'minimist';
-import { spawn } from 'node:child_process';
-import { once } from 'node:events';
-import { $ } from 'zx';
-
-const options = ['fix', 'init', 'check'];
-async function main() {
-	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(`[SharedConfig] Please provide exactly one of ${options.map((opt) => `--${opt}`).join(' or ')}`);
-		process.exit(1);
-	}
-
-	const commands = [
-		'cspell-config',
-		'eslint-config',
-		'markdownlint-config',
-		'npm-config',
-		'prettier-config',
-		'stylelint-config',
-		'vscode-config',
-	];
-
-	const capabilities = await getCapabilities(commands);
-
-	process.env.FORCE_COLOR = '1';
-	if (args.init) {
-		const capabilitiesWithInit = stylePrefixes(capabilities.filter((capability) => capability.init));
-
-		for (const capability of capabilitiesWithInit) {
-			console.log(`${capability.name} Running command: ${capability.command} --init`);
-			await $`${capability.command} --init`;
-			console.log('\n');
-		}
-		console.log('Initialization complete.');
-	} else if (args.fix) {
-		runAllCommands(capabilities, 'fix');
-	} else if (args.check) {
-		runAllCommands(capabilities, 'check');
-	}
-}
-
-await main();
-
-// helpers
-async function runCommand(command, prefix) {
-	// console.log(`${prefix} Running command: ${command}`);
-
-	const subprocess = spawn(command, {
-		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); // 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); // 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}`);
-	}
-}
-
-function stylePrefixes(capabilities) {
-	// 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 = capabilities.reduce((max, capability) => Math.max(max, capability.name.length), 0);
-
-	// Pad each prefix with spaces to match the length of the longest prefix
-	return capabilities.map((cmd, index) => {
-		const colorCode = boldCode + colors[index % colors.length];
-		const paddedLength = longestPrefixLength;
-		const paddingLength = paddedLength - cmd.name.length;
-		const paddedPrefix = colorCode + '[' + cmd.name + ' '.repeat(paddingLength) + ']' + resetCode;
-		return { ...cmd, name: paddedPrefix };
-	});
-}
-
-export async function runAllCommands(capabilities, option) {
-	const capabilitiesWithCommand = stylePrefixes(capabilities.filter((commandInfo) => commandInfo[option]));
-
-	let errors = [];
-	for (const cmd of capabilitiesWithCommand) {
-		try {
-			await runCommand(`${cmd.command} --${option}`, cmd.name);
-		} 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);
-	}
-}
-
-async function getCapabilities(commands) {
-	$.verbose = false;
-	const capabilities = await Promise.all(
-		commands.map(async (command) => {
-			try {
-				await $`${command}`;
-				// console.log('Command completed successfully.');
-			} catch (error) {
-				return {
-					command,
-					...parseCapabilities(error.stderr.trim()),
-				};
-			}
-
-			console.error(`[SharedConfig] ${command} did not return any capabilities.`);
-			return '';
-		}),
-	);
-	$.verbose = true;
-	return capabilities;
-}
-
-function parseCapabilities(output) {
-	const parts = output.match(/\[(.*?)] Please provide exactly one of (.*)/);
-	if (!parts) return;
-
-	const name = parts[1];
-	const options = new Set(parts[2].split(' or ').map((opt) => opt.trim().replace('--', '')));
-
-	return {
-		check: options.has('check'),
-		fix: options.has('fix'),
-		init: options.has('init'),
-		name,
-	};
-}

package/readme.md

@@ -1,95 +0,0 @@
-# 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 -D @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, after configuring the `package.json` as shown above:
-
-```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)