@kitschpatrol/shared-config 7.1.0 → 7.2.0

package/bin/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import h from"@pinojs/json-colorizer";import g from"decircular";import _ from"deepmerge";import ee from"json-stringify-pretty-compact";import{findWorkspaces as te,findWorkspacesRoot as ne}from"find-workspaces";import v,{access as re}from"node:fs/promises";import{stripVTControlCharacters as y}from"node:util";import{getDefaultConfigLoader as b,resolveConfigFileImports as x}from"cspell-lib";import{lint as ie}from"cspell";import"deepmerge-ts";import{loadConfig as S}from"mdat";import{globby as ae}from"globby";import C,{gt as w,minVersion as oe}from"semver";import{readWantedLockfile as se}from"@pnpm/lockfile.fs";import ce from"stylelint";var le=`7.1.0`;function ue(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function T(e){return h(ee(g(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const de=(e,t,n)=>{let r=[...e];for(let[i,a]of t.entries())r[i]===void 0?r[i]=n.cloneUnlessOtherwiseSpecified(a,n):n.isMergeableObject(a)?r[i]=E(e[i],a,n):e.includes(a)||r.push(a);return r};function E(e,t,n={arrayMerge:de}){return _(e,t,n)}function fe(e,t){return e.startsWith(t+o.sep)}function pe(){let e=D(),t=new Set([e]),n=te();if(n!==null)for(let r of n){let n=o.resolve(r.location);fe(n,e)&&t.add(n)}return[...t]}function D(){let e=d();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function me(){return ne()!==null}function O(){let e=ne();return e===null?D():o.resolve(e.location)}function k(e){let t=o.join(O(),e);if(r.existsSync(t))return t}function A(e){if(e===`workspace-root`)return O();if(e===`package-dir`)return D();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function he(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await v.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function j(e){try{await he(e,await v.readFile(e,`utf8`))}catch{}}const ge=/\r?\n/;function M(e){return new c({transform(t,n,r){let i=t.toString().split(ge).filter(t=>t.trim()!==``&&!e(y(t))).join(`
+import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import h from"@pinojs/json-colorizer";import g from"decircular";import _ from"deepmerge";import ee from"json-stringify-pretty-compact";import{findWorkspaces as te,findWorkspacesRoot as ne}from"find-workspaces";import v,{access as re}from"node:fs/promises";import{stripVTControlCharacters as y}from"node:util";import{getDefaultConfigLoader as b,resolveConfigFileImports as x}from"cspell-lib";import{lint as ie}from"cspell";import"deepmerge-ts";import{loadConfig as S}from"mdat";import{globby as ae}from"globby";import C,{gt as w,minVersion as oe}from"semver";import{readWantedLockfile as se}from"@pnpm/lockfile.fs";import ce from"stylelint";var le=`7.2.0`;function ue(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function T(e){return h(ee(g(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const de=(e,t,n)=>{let r=[...e];for(let[i,a]of t.entries())r[i]===void 0?r[i]=n.cloneUnlessOtherwiseSpecified(a,n):n.isMergeableObject(a)?r[i]=E(e[i],a,n):e.includes(a)||r.push(a);return r};function E(e,t,n={arrayMerge:de}){return _(e,t,n)}function fe(e,t){return e.startsWith(t+o.sep)}function pe(){let e=D(),t=new Set([e]),n=te();if(n!==null)for(let r of n){let n=o.resolve(r.location);fe(n,e)&&t.add(n)}return[...t]}function D(){let e=d();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function me(){return ne()!==null}function O(){let e=ne();return e===null?D():o.resolve(e.location)}function k(e){let t=o.join(O(),e);if(r.existsSync(t))return t}function A(e){if(e===`workspace-root`)return O();if(e===`package-dir`)return D();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function he(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await v.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function j(e){try{await he(e,await v.readFile(e,`utf8`))}catch{}}const ge=/\r?\n/;function M(e){return new c({transform(t,n,r){let i=t.toString().split(ge).filter(t=>t.trim()!==``&&!e(y(t))).join(`
 `);this.push(i+`
 `),r()}})}function N(e,t){return new c({transform(n,r,i){let a=n.toString().split(ge).filter(e=>e.trim().length>0).map(n=>`${e?t===void 0?e:f[t](e):``} ${n}\n`).join(``);this.push(a),i()}})}async function _e(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>t.push(e)),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function ve(e){return e.replaceAll(/[A-Z\u00C0-\u00D6\u00D8-\u00DE]/g,e=>`-`+e.toLowerCase())}function P(e,t){return t===1?e:e+`s`}async function ye(e,t,n,r,i){let a=1,o;if(r.logPrefix===void 0)o=e;else{let t=N(r.logPrefix,r.logColor);t.pipe(e),o=t}i&&o.write(f.bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`));try{a=await r.execute(o,t,n)}catch(e){console.error(String(e)),a=1}return a}async function be(e,t,r,i,a){let o=1,c;if(i.logPrefix===void 0)c=e;else{let t=N(i.logPrefix,i.logColor);t.pipe(e),c=t}let l=i.subcommands??[],u=[...i.receivePositionalArguments?t:[],...i.positionalArguments??[]],d=[...i.receiveOptionFlags?r:[],...i.optionFlags??[]],f=[...l,...d,...u],p=A(i.cwdOverride);a&&c.write(`Running: "${i.name} ${f.join(` `)}"`);let m=i.prettyJsonOutput?new s:c;try{let e=n(i.name,f,{cwd:p,env:{...process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}},preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let t=M(i.outputFilter),n=M(i.outputFilter);e.stdout.pipe(t).pipe(m,{end:!1}),e.stderr.pipe(n).pipe(m,{end:!1})}else e.stdout.pipe(m,{end:!1}),e.stderr.pipe(m,{end:!1});if(await e,i.prettyJsonOutput){m.end();let e=await _e(m),t=T(JSON.parse(e)).split(`
 `);for(let e of t)c.write(`${e}\n`)}o=e.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),ue(e)&&(o=typeof e.exitCode==`number`?e.exitCode:1)}return o}function xe(e){return`execute`in e}const Se=/^ksc-/;function F(e){return e.replace(Se,``)}function I(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>F(e.trim()))}function L(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}async function R(e,t,n,r,i,a,o){let s=o??[],c=[],l=[];for(let e of r)s.length>0&&s.includes(F(e.name))?l.push(e):c.push(e);if(s.length>0){let t=new Set(l.map(e=>F(e.name))),n=s.filter(e=>!t.has(e));if(n.length>0){let t=r.map(e=>F(e.name)).join(`, `);e.write(`⚠️  ${f.yellow(`Unrecognized --skip ${P(`value`,n.length)}: ${n.join(`, `)}. Available: ${t}`)}\n`)}}let u=[];for(let r of c){let a=await(xe(r)?ye(e,t,n,r,i):be(e,t,n,r,i));u.push({exitCode:a,name:r.name})}let d=r.length;if(l.length>0){let t=l.map(({name:e})=>e);e.write(`⏭️ ${f.dim(f.bold(`${t.length} / ${d} ${P(`Command`,t.length)} Skipped:`))} ${f.dim(t.join(`, `))}\n`)}if(a){let t=u.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=u.filter(({exitCode:e})=>e!==0).map(({name:e})=>e);t.length>0&&e.write(`✅ ${f.green(f.bold(`${t.length} / ${d} ${P(`Command`,t.length)} Succeeded:`))} ${f.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${f.red(f.bold(`${n.length} / ${d} ${P(`Command`,n.length)} Failed:`))} ${f.red(n.join(`, `))}\n`)}return u.every(({exitCode:e})=>e===0)?0:1}async function Ce(e,t,n,a){let s=await u();if(s===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let c=await u({cwd:l(import.meta.url)});if(c===void 0)return e.write(`Error: The script being called was not in a package, weird.

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { FileType, FileType as FileType$1 } from "@kitschpatrol/prettier-config";
+
+//#region src/api.d.ts
+/**
+ * Fix a source string by running all shared-config tools in sequence: Mdat →
+ * ESLint → Stylelint → Prettier. Each tool silently skips content it doesn't
+ * understand.
+ *
+ * @param source - The source code to fix.
+ * @param fileType - A file extension (e.g. `'ts'`, `'css'`, `'md'`) or virtual
+ *   filepath for parser inference. Defaults to `'ts'`.
+ *
+ * @returns The fixed source string.
+ */
+declare function fix(source: string, fileType?: FileType$1): Promise<string>;
+/**
+ * Fix a file in place by running all shared-config tools in sequence: Mdat →
+ * ESLint → Stylelint → Prettier. Each tool silently skips content it doesn't
+ * understand.
+ *
+ * @param filePath - Path to the file to fix.
+ */
+declare function fixFile(filePath: string): Promise<void>;
+/**
+ * Clear all cached tool modules and instances. Subsequent calls to `fix` or
+ * `fixFile` will re-import all tools.
+ */
+declare function clearCache(): void;
+//#endregion
+export { type FileType, clearCache, fix, fixFile };

package/dist/index.js

@@ -0,0 +1 @@
+import{clearCache as e,fix as t,fixFile as n}from"@kitschpatrol/eslint-config";import{clearCache as r,fix as i,fixFile as a}from"@kitschpatrol/mdat-config";import{clearCache as o,fix as s,fixFile as c}from"@kitschpatrol/prettier-config";import{clearCache as l,fix as u,fixFile as d}from"@kitschpatrol/stylelint-config";async function f(e,n){let r=e;try{r=await i(r)}catch{}try{r=await t(r,n)}catch{}try{r=await u(r,n)}catch{}try{r=await s(r,n)}catch{}return r}async function p(e){try{await a(e)}catch{}try{await n(e)}catch{}try{await d(e)}catch{}try{await c(e)}catch{}}function m(){r(),e(),l(),o()}export{m as clearCache,f as fix,p as fixFile};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/shared-config",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "A collection of shared configurations, linters, and formatting tools for TypeScript projects. All managed as a single dependency, and invoked via a single CLI command.",
   "keywords": [
     "shared-config",
@@ -30,19 +30,28 @@
   },
   "sideEffects": false,
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
     "ksc": "bin/cli.js"
   },
   "files": [
-    "bin/*"
+    "bin/*",
+    "dist/*"
   ],
   "dependencies": {
     "@pinojs/json-colorizer": "^4.0.0",
     "@pnpm/lockfile.fs": "^1001.1.32",
     "cosmiconfig": "^9.0.1",
     "cosmiconfig-typescript-loader": "^6.2.0",
-    "cspell": "^9.8.0",
-    "cspell-lib": "^9.8.0",
+    "cspell": "^10.0.0",
+    "cspell-lib": "^10.0.0",
     "decircular": "^1.0.0",
     "deepmerge": "^4.3.1",
     "deepmerge-ts": "^7.1.5",
@@ -51,22 +60,22 @@
     "fs-extra": "^11.3.4",
     "globby": "^16.2.0",
     "json-stringify-pretty-compact": "^4.0.0",
-    "mdat": "^2.2.0",
+    "mdat": "^2.2.1",
     "package-up": "^5.0.0",
     "picocolors": "^1.1.1",
     "prettier": "^3.8.1",
     "semver": "^7.7.4",
     "stylelint": "^17.6.0",
     "yargs": "^18.0.0",
-    "@kitschpatrol/cspell-config": "7.1.0",
-    "@kitschpatrol/eslint-config": "7.1.0",
-    "@kitschpatrol/mdat-config": "7.1.0",
-    "@kitschpatrol/remark-config": "7.1.0",
-    "@kitschpatrol/repo-config": "7.1.0",
-    "@kitschpatrol/stylelint-config": "7.1.0",
-    "@kitschpatrol/knip-config": "7.1.0",
-    "@kitschpatrol/typescript-config": "7.1.0",
-    "@kitschpatrol/prettier-config": "7.1.0"
+    "@kitschpatrol/cspell-config": "7.2.0",
+    "@kitschpatrol/eslint-config": "7.2.0",
+    "@kitschpatrol/knip-config": "7.2.0",
+    "@kitschpatrol/prettier-config": "7.2.0",
+    "@kitschpatrol/mdat-config": "7.2.0",
+    "@kitschpatrol/remark-config": "7.2.0",
+    "@kitschpatrol/stylelint-config": "7.2.0",
+    "@kitschpatrol/typescript-config": "7.2.0",
+    "@kitschpatrol/repo-config": "7.2.0"
   },
   "engines": {
     "node": ">=22.18.0"
@@ -77,6 +86,7 @@
   "scripts": {
     "build": "tsdown",
     "clean": "pnpm run bin-restore ; git clean -fdX",
-    "cli": "node ./bin/cli.js"
+    "cli": "node ./bin/cli.js",
+    "test": "vitest run"
   }
 }

package/readme.md

@@ -324,6 +324,32 @@ ksc print-config [file]
 
 Recall that the `@kitschpatrol/shared-config` package aggregates integration and invocation of the other tool-specific packages in this monorepo. Running a cli command on `ksc` effectively runs the same command against all the tool-specific packages.
 
+### API
+
+The package also exports `fix`, `fixFile` functions that run all shared-config tools in sequence, matching the order of `ksc fix`: Mdat → ESLint → Stylelint → Prettier. Each tool silently skips content it doesn't understand.
+
+The CLI is preferred, but there are occasionally edge cases where it's handy to run a string or a generated file through the shared-config pipeline without leaving TypeScript.
+
+```typescript
+import { clearCache, fix, fixFile } from '@kitschpatrol/shared-config'
+
+// Fix a string with all tools (defaults to TypeScript)
+const fixed = await fix('let x = 1\nconsole.log(x)\n')
+
+// Fix with a file type hint
+const fixedCss = await fix(cssSource, 'css')
+const fixedMarkdown = await fix(mdSource, 'md')
+
+// Fix a file in place with all tools
+await fixFile('./src/index.ts')
+await fixFile('./src/styles.css')
+
+// Clear all cached tool modules
+clearCache()
+```
+
+Each sub-package with a `fix` command also exports its own `fix`, `fixFile`, and `clearCache` for standalone use. See the individual package readmes for details. (With the exception of, `ksc-repo`, whose `fix` behavior is too file-specific to be generically useful.)
+
 ## Implementation notes
 
 ### Line endings