@kitschpatrol/prettier-config 1.0.1 → 2.1.0

package/bin/cli.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import O from"chalk";import{execa as x}from"execa";import A from"meow";import f from"node:path";import{Transform as $}from"node:stream";import{fileURLToPath as S}from"node:url";import{packageUp as k}from"package-up";function N(r,e){return new $({transform(n,t,i){let s=n.toString().split(/\r?\n/).filter(l=>l.trim().length>0).map(l=>`${r?O[e]("["+r+"] "):""}${l}`).join(`
+`)+`
+`;this.push(s),i()}})}function j(r,e){let n=`
+  Usage
+    $ ${r} [<file|glob> ...]
+  `;if(Object.keys(e).length>0){n+=`
+  Options`;for(let t of Object.keys(e))switch(t){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 ${r}.`;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: ${t}`)}}return n}function T(r){return Object.keys(r).reduce((e,n)=>{let t={};switch(n){case"init":{t={shortFlag:"i",type:"boolean"};break}case"check":{t={aliases:["lint",""],shortFlag:"l",type:"boolean"};break}case"fix":{t={shortFlag:"f",type:"boolean"};break}case"printConfig":{t={type:"boolean"};break}default:console.error(`Unknown command name: ${n}`)}return e[n]=t,e},{})}async function h(r,e,n=[]){if(e.command!==void 0&&typeof e.command=="string"){let t;try{let i=x(e.command,[...e.options??[],...n],{env:{FORCE_COLOR:"true"},stdin:"inherit"});i.stdout?.pipe(r,{end:!1}),await i,t=i.exitCode??1}catch(i){t=typeof i.exitCode=="number"?i.exitCode:1}return t}return console.error(`Invalid optionCommand: ${JSON.stringify(e,void 0,2)}`),1}function y(r,e){r.length===0&&!e.defaultArguments&&(console.error("This command must be used with a file argument"),process.exit(1))}async function C(r,e,n,t){let i=A(j(r,t),{allowUnknownFlags:!1,booleanDefault:void 0,flags:T(t),importMeta:import.meta}),{flags:u,input:s}=i,l=Object.keys(t).reduce((c,o)=>(u[o]&&(c[o]=t[o]),c),{});Object.keys(l).length===0&&(l.check=t.check);let m=N(e,n);m.pipe(process.stdout);let a=0;for(let[c,o]of Object.entries(l))if(typeof o.command=="function"){y(s,o);let g=s.length===0?o.defaultArguments??[]:s,p=o.options??[];a+=await o.command(m,g,p)}else if(typeof o.command=="string")y(s,o),a+=await h(m,o,s.length===0?o.defaultArguments:s);else switch(c){case"init":{let g=await k();if(g===void 0){console.error("The `--init` flag must be used in a directory with a package.json file"),a+=1;break}let p=await k({cwd:S(import.meta.url)});if(p===void 0){console.error("The script being called was not in a package, weird."),a+=1;break}let d=f.join(f.dirname(p),"init/"),b=f.dirname(g);console.log(`Copying initial configuration files from:
+"${d}" \u2192 "${b}"`);let F={command:"cp",options:["-Ri",`${d}`,`${b}`]};a+=await h(m,F);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)}import{resolveConfig as v}from"prettier";var w=["--log-level=warn","--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"];await C("prettier-config","Prettier","blue",{check:{command:"prettier",defaultArguments:["."],options:[...w,"--check"]},fix:{command:"prettier",defaultArguments:["."],options:[...w,"--write"]},init:{},printConfig:{async command(r,e){let n=e?.at(0);return n?(r.write(JSON.stringify(await v(n,{}),void 0,2)),r.write(`
+`),0):1}}});

package/init/.prettierignore

@@ -1 +1 @@
-# TODO
+pnpm-lock.yaml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/prettier-config",
-  "version": "1.0.1",
+  "version": "2.1.0",
   "type": "module",
   "description": "Prettier config for @kitschpatrol/shared-config",
   "repository": {
@@ -23,9 +23,13 @@
     "pnpm": ">=8.0.0"
   },
   "bin": {
-    "prettier-config-init": "./init.js"
+    "prettier-config": "bin/cli.js"
   },
   "main": "main.js",
+  "files": [
+    "bin",
+    "init"
+  ],
   "peerDependencies": {
     "prettier": "^3.0.0"
   },
@@ -33,6 +37,10 @@
     "@prettier/plugin-php": "^0.21.0",
     "@prettier/plugin-ruby": "^4.0.3",
     "@prettier/plugin-xml": "^3.2.2",
+    "chalk": "^5.3.0",
+    "execa": "^8.0.1",
+    "meow": "^12.1.1",
+    "package-up": "^5.0.0",
     "prettier-plugin-astro": "^0.12.2",
     "prettier-plugin-pkg": "^0.18.0",
     "prettier-plugin-sh": "^0.13.1",
@@ -43,5 +51,9 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "../../scripts/build.ts",
+    "cli": "node ./bin/cli.js"
   }
 }

package/readme.md

@@ -25,25 +25,27 @@ To use just this Prettier config in isolation:
 3. Add the starter `.prettierrc.js` and `.prettierignore` files to your project root, and add any customizations you'd like:
 
    ```sh
-   pnpm exec prettier-config-init
+   pnpm exec prettier-config --init
    ```
 
 ## Usage
 
 The Prettier 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": "prettier --check ."
-  "format": "prettier --write ."
+  "lint": "prettier-config --check"
+  "format": "prettier-config --fix"
 }
 ...
 ```
 
-You might need to pass certain plugins in explicitly. The `shared-config-fix` and `shared-config-lint` scripts take care of this for you.
+You might need to pass certain plugins in explicitly. The `shared-config --fix` and `shared-config --lint` scripts take care of this for you.
 
 ## Ruby support
 

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.`);
-	}
-}