@kitschpatrol/repo-config 6.2.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bin/cli.js CHANGED
@@ -1,5 +1,7 @@
1
1
  #!/usr/bin/env node
2
- import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"@pinojs/json-colorizer";import p from"decircular";import m from"deepmerge";import h from"json-stringify-pretty-compact";import{findWorkspaces as g,findWorkspacesRoot as _}from"find-workspaces";import v from"node:fs/promises";import{globby as y}from"globby";import b,{gt as x,minVersion as S}from"semver";import{readWantedLockfile as C}from"@pnpm/lockfile.fs";var w=`6.2.0`;function ee(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function T(e){return f(h(p(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const E=(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]=D(e[i],a,n):e.includes(a)||r.push(a);return r};function D(e,t,n={arrayMerge:E}){return m(e,t,n)}function te(e,t){return e.startsWith(t+r.sep)}function ne(){let e=O(),t=new Set([e]),n=g();if(n!==null)for(let i of n){let n=r.resolve(i.location);te(n,e)&&t.add(n)}return[...t]}function O(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return r.dirname(e)}function k(){let e=_();return e===null?O():r.resolve(e.location)}function A(e){if(e===`workspace-root`)return k();if(e===`package-dir`)return O();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function j(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 M(e){try{await j(e,await v.readFile(e,`utf8`))}catch{}}function N(e,t){return new a({transform(n,r,i){let a=n.toString().split(/\r?\n/).filter(e=>e.trim().length>0).map(n=>`${e?t===void 0?e:l[t](e):``} ${n}\n`).join(``);this.push(a),i()}})}async function re(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 P(e,t){return t===1?e:e+`s`}async function ie(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(l.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 ae(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=N(a.logPrefix,a.logColor);e.pipe(t),c=e}let l=a.subcommands??[],u=[...a.receivePositionalArguments?n:[],...a.positionalArguments??[]],d=[...a.receiveOptionFlags?r:[],...a.optionFlags??[]],f=[...l,...d,...u],p=A(a.cwdOverride);o&&c.write(`Running: "${a.name} ${f.join(` `)}"`);let m=a.prettyJsonOutput?new i:c;try{let t=e(a.name,f,{cwd:p,env:{...process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}},preferLocal:!0,reject:!1,stdin:`inherit`});if(t.stdout.pipe(m,{end:!1}),t.stderr.pipe(m,{end:!1}),await t,a.prettyJsonOutput){m.end();let e=await re(m),t=T(JSON.parse(e)).split(`
3
- `);for(let e of t)c.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${a.name} failed with error:`),console.error(e),ee(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function oe(e){return`execute`in e}async function F(e,t,n,r,i,a){let o=[];for(let a of r){let r=await(oe(a)?ie(e,t,n,a,i):ae(e,t,n,a,i));o.push({exitCode:r,name:a.name})}if(a){let t=o.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=o.filter(({exitCode:e})=>e!==0).map(({name:e})=>e),r=o.length;t.length>0&&e.write(`✅ ${l.green(l.bold(`${t.length} / ${r} ${P(`Command`,t.length)} Succeeded:`))} ${l.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${l.red(l.bold(`${n.length} / ${r} ${P(`Command`,n.length)} Failed:`))} ${l.red(n.join(`, `))}\n`)}return o.every(({exitCode:e})=>e===0)?0:1}async function I(e,i,a,c){let l=await s();if(l===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let u=await s({cwd:o(import.meta.url)});if(u===void 0)return e.write(`Error: The script being called was not in a package, weird.
4
- `),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0];if(i===`package`){let r=t.readJsonSync(l);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=D(r,c);t.writeJSONSync(l,i,{spaces:` `}),await M(l)}else{let r=t.readJsonSync(l);Object.keys(r).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete r[n],t.writeJSONSync(l,r,{spaces:` `}),await M(l))}}if(!await t.pathExists(d))return 0;if((await t.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await t.copy(d,f,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(p&&i===`package`&&o.includes(a))return l?(e.write(`Deleting: \n"${o}" → "${s}" (Because --location is set to "package")\n`),t.removeSync(s)):e.write(`Skipping: \n"${o}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&r.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=D(t.readJSONSync(s),n);return t.writeJSONSync(s,r,{spaces:` `}),await M(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await M(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await M(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function L(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e,p=N(s,o);p.pipe(process.stdout);let m=u(d(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&m.command({builder(e){return n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`TK`,type:`string`}):e},command:`init`,describe:n.description??`Initialize by copying starter config files to your project root${n.locationOptionFlag?` or to your package.json file.`:`.`}`,async handler(e){let t=n.locationOptionFlag?e.location:void 0,r=await F(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return I(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]]);process.exit(r)}}),r!==void 0&&m.command({builder(e){return r.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...r.positionalArgumentDefault===void 0?{}:{default:r.positionalArgumentDefault},describe:`Files or glob pattern to lint.`,type:`string`})},command:r.positionalArgumentMode===`none`?`lint`:r.positionalArgumentMode===`optional`?`lint [files..]`:`lint <files..>`,describe:r.description,async handler(e){let t=await F(p,e.files??[],[],r.commands,f,l);process.exit(t)}}),t!==void 0&&m.command({builder(e){return t.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...t.positionalArgumentDefault===void 0?{}:{default:t.positionalArgumentDefault},describe:`Files or glob pattern to fix.`,type:`string`})},command:t.positionalArgumentMode===`none`?`fix`:t.positionalArgumentMode===`optional`?`fix [files..]`:`fix <files..>`,describe:t.description,async handler(e){let n=await F(p,e.files??[],[],t.commands);process.exit(n)}}),i!==void 0&&m.command({builder(e){return i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault===void 0?{}:{default:i.positionalArgumentDefault},describe:`File or glob pattern to TK.`,type:`string`})},command:i.positionalArgumentMode===`none`?`print-config`:i.positionalArgumentMode===`optional`?`print-config [file]`:`print-config <file>`,describe:i.description,async handler(e){let t=e.file??void 0,n=await F(p,t===void 0?[]:[t],[],i.commands,f,l);process.exit(n)}}),m.alias(`h`,`help`),m.version(w),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const R={fileRun:`Matches files below the current working directory by default.`,monorepoRun:`In a monorepo, it will also run in all packages below the current working directory.`,monorepoSearch:`Searches up to the root of a monorepo if necessary.`,multiArgumentCaveat:`Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.`,multiOptionCaveat:`Will use option flags where possible if provided, but some of the invoked tools will ignore them.`,optionalFileRun:`Package-scoped by default, file-scoped if a file argument is provided.`,packageRun:`Package-scoped.`,packageSearch:`Package-scoped.`},z=[/Version 2\.0,?\s*January 2004/g,/Version 1,?\s*February 1989/g,/Version 2,?\s*June 1991/g,/Version 3,?\s*29 June 2007/g,/Version 2\.1,?\s*February 1999/g,/Version 3,?\s*19 November 2007/g,/Version 1\.0\s*-\s*August 17th,?\s*2003/g,/Version 1\.1,?\s*March 2000/g,/Version 1\.2,?\s*November 2002/g,/Version 1\.3,?\s*3 November 2008/g,/Version 1\.0\s*-\s*22 November 2005/g,/Version 1\.1\s*-\s*26 February 2007/g,/Version 2,?\s*December 2004/g,/20 December 1996/g,/December 20,?\s*1996/g,/11 March 1996/g,/28 March 2007/g,/November 1,?\s*2008/g,/August 1,?\s*2009/g,/1 April 19\d{2}/g,/Copyright \(c\) 2000-2006,?\s*The Perl Foundation/gi,/Copyright \(C\) (?:\d{4},?\s*)+Free Software Foundation/g],B=[`node_modules/**`,`test/**`];function V(e){let t=e;for(let e of z)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/g,`X`));return t}function H(e,t){let n=V(e),r=/(\d{4})\s*-\s*(\d{4})/,i=r.exec(n);if(i){let[,n,a]=i;if(Number.parseInt(a,10)!==t){let a=`${n}-${t}`;return e.slice(0,i.index)+e.slice(i.index).replace(r,a)}return e}let a=/(\d{4})/,o=a.exec(n);if(o){let[,n]=o;if(Number.parseInt(n,10)!==t){let r=`${n}-${t}`;return e.slice(0,o.index)+e.slice(o.index).replace(a,r)}return e}return e}async function U(e,t=!1){let n=new Date().getFullYear(),r=[],i=await y([`**/license.txt`,`**/license`,...B.map(e=>`!${e}`)],{caseSensitiveMatch:!1,cwd:O(),followSymbolicLinks:!1,gitignore:!0});for(let e of i)r.push(e);let a=[];for(let e of r)try{let r=await v.readFile(e,`utf8`),i=H(r,n);i!==r&&(a.push(e),t&&await v.writeFile(e,i,`utf8`))}catch(t){console.error(`Failed to process ${e}:`,t)}if(a.length>0){e.write(`${t?`Fixed`:`Found`} ${a.length} license ${P(`file`,a.length)} with outdated copyright year:\n`);for(let t of a)e.write(` - ${t}\n`);return t?0:1}return 0}async function W(e){return U(e,!1)}async function G(e){return U(e,!0)}const K=`pnpm-lock.yaml`;function se(e){let n=k(),i=r.resolve(e);for(;;){if(t.existsSync(r.join(i,K)))return i;if(i===n)break;let e=r.dirname(i);if(e===i)break;i=e}}function ce(e,t,n){let r=`${e}@${t}`;if(r in n)return r;if(t in n)return t}async function q(e){let t=se(e);if(!t)throw Error(`${K} not found at or above "${e}".`);let n=r.join(t,K),i=await C(t,{ignoreIncompatible:!1});if(!i?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let a=i.packages??{},o,s,c={},l={};function u(e,t){let n,r=new Set;function i(e,t){if(t.startsWith(`link:`))return;let o=ce(e,t,a);if(!o||r.has(o))return;r.add(o);let s=a[o],c=s?.engines?.node;if(c){let e=S(c)?.version;e&&(!n||x(e,n))&&(n=e)}if(s?.dependencies)for(let[e,t]of Object.entries(s.dependencies))typeof t==`string`&&i(e,t)}return i(e,t),n}function d(e,t){for(let[n,r]of Object.entries(e)){let e=u(n,typeof r==`string`?r:r.version);if(e){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:o;(!i||x(e,i))&&(t?s=e:o=e)}}}let f=r.relative(t,e)||`.`,p=i.importers[f];p&&(p.dependencies&&d(p.dependencies,!1),p.devDependencies&&d(p.devDependencies,!0));let m=o&&s?x(o,s)?`>=${o}`:`>=${s}`:o?`>=${o}`:s?`>=${s}`:void 0;return{dependencies:o?{topLevelCauses:[...c[o]],version:`>=${o}`}:void 0,devDependencies:s?{topLevelCauses:[...l[s]],version:`>=${s}`}:void 0,lockfile:n,version:m}}function le(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function J(e,t){let n=e.devEngines??{};if(n.runtime)if(Array.isArray(n.runtime)){let e=n.runtime.findIndex(e=>e.name===`node`);e===-1?n.runtime.push({name:`node`,version:t}):n.runtime[e].version=t}else n.runtime.name===`node`?n.runtime.version=t:n.runtime=[n.runtime,{name:`node`,version:t}];else n.runtime={name:`node`,version:t};e.devEngines=n}function ue(e){let t=e.devEngines;t?.runtime&&(Array.isArray(t.runtime)?(t.runtime=t.runtime.filter(e=>e.name!==`node`),t.runtime.length===0?delete t.runtime:t.runtime.length===1&&(t.runtime=t.runtime[0])):t.runtime.name===`node`&&delete t.runtime,Object.keys(t).length===0&&delete e.devEngines)}function Y(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function de(e,n,i){let a=r.join(i,`package.json`);if(!t.existsSync(a))return 0;let o=t.readJsonSync(a),s=o.engines?.node,c=le(o),l=await q(i),u=l.dependencies?.version,d=l.dependencies?.topLevelCauses??[],f=l.version,p=l.devDependencies?.topLevelCauses??[],m=[];if(u!==void 0)if(s===void 0){if(m.push(`Missing engines.node — suggest setting to "${u}"${Y(d)}`),n){let e=o.engines??{};e.node=u,o.engines=e}}else{let e=b.minVersion(s),t=b.minVersion(u);e&&t&&b.lt(e,t)&&(m.push(`engines.node is "${s}" but production dependencies require at least "${u}"${Y(d)}`),n&&(o.engines.node=u))}let h=(()=>{if(u&&s){let e=b.minVersion(u),t=b.minVersion(s);if(e&&t)return b.gt(e,t)?u:s}return u??s})(),g=h?b.minVersion(h):void 0,_=f?b.minVersion(f):void 0,v=_&&g&&b.gt(_,g);if(f!==void 0&&v)if(c===void 0)m.push(`devDependencies require a higher Node.js minimum (${f}) than engines.node (${h??`none`}) — suggest adding devEngines.runtime for node with version "${f}"${Y(p)}`),n&&J(o,f);else{let e=b.minVersion(c);e&&b.lt(e,_)&&(m.push(`devEngines.runtime.version for node is "${c}" but all dependencies require at least "${f}"${Y(p)}`),n&&J(o,f))}else if(c!==void 0){let e=b.minVersion(c);e&&g&&b.lte(e,g)&&(m.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),n&&ue(o))}if(m.length>0){e.write(`${n?`Fixed`:`Found`} ${m.length} Node.js version ${P(`issue`,m.length)} in ${a}:\n`);for(let t of m)e.write(` - ${t}\n`);return n?(t.writeJsonSync(a,o,{spaces:` `}),await M(a),0):1}return 0}async function X(e,t){let n=ne(),r=0;for(let i of n)await de(e,t,i)!==0&&(r=1);return r}async function Z(e){let t=T(await q(O())).split(`
5
- `);for(let n of t)e.write(`${n}\n`);return 0}async function Q(e){return X(e,!1)}async function $(e){return X(e,!0)}await L({commands:{fix:{commands:[{execute:G,name:W.name},{execute:$,name:$.name}],description:`Fix common issues like outdated copyright years in license files. ${R.packageRun} ${R.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{execute:W,name:G.name},{execute:Q,name:Q.name}],description:`Check the repo for common issues. ${R.packageRun} ${R.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:Z,name:Z.name}],description:`Print minimum Node.js version constraints from the pnpm lockfile.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's repository-related shared configuration tools.`,logColor:`gray`,logPrefix:`[Repo Config]`,name:`ksc-repo`,order:1});export{};
2
+ import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"@pinojs/json-colorizer";import p from"decircular";import m from"deepmerge";import h from"json-stringify-pretty-compact";import{findWorkspaces as g,findWorkspacesRoot as _}from"find-workspaces";import v from"node:fs/promises";import{stripVTControlCharacters as y}from"node:util";import{globby as ee}from"globby";import b,{gt as x,minVersion as te}from"semver";import{readWantedLockfile as S}from"@pnpm/lockfile.fs";var ne=`7.0.0`;function re(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function C(e){return f(h(p(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const ie=(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]=w(e[i],a,n):e.includes(a)||r.push(a);return r};function w(e,t,n={arrayMerge:ie}){return m(e,t,n)}function ae(e,t){return e.startsWith(t+r.sep)}function T(){let e=E(),t=new Set([e]),n=g();if(n!==null)for(let i of n){let n=r.resolve(i.location);ae(n,e)&&t.add(n)}return[...t]}function E(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return r.dirname(e)}function D(){let e=_();return e===null?E():r.resolve(e.location)}function oe(e){if(e===`workspace-root`)return D();if(e===`package-dir`)return E();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function se(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 O(e){try{await se(e,await v.readFile(e,`utf8`))}catch{}}const k=/\r?\n/;function A(e){return new a({transform(t,n,r){let i=t.toString().split(k).filter(t=>t.trim()!==``&&!e(y(t))).join(`
3
+ `);this.push(i+`
4
+ `),r()}})}function j(e,t){return new a({transform(n,r,i){let a=n.toString().split(k).filter(e=>e.trim().length>0).map(n=>`${e?t===void 0?e:l[t](e):``} ${n}\n`).join(``);this.push(a),i()}})}async function ce(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 M(e,t){return t===1?e:e+`s`}async function le(e,t,n,r,i){let a=1,o;if(r.logPrefix===void 0)o=e;else{let t=j(r.logPrefix,r.logColor);t.pipe(e),o=t}i&&o.write(l.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 ue(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=j(a.logPrefix,a.logColor);e.pipe(t),c=e}let l=a.subcommands??[],u=[...a.receivePositionalArguments?n:[],...a.positionalArguments??[]],d=[...a.receiveOptionFlags?r:[],...a.optionFlags??[]],f=[...l,...d,...u],p=oe(a.cwdOverride);o&&c.write(`Running: "${a.name} ${f.join(` `)}"`);let m=a.prettyJsonOutput?new i:c;try{let t=e(a.name,f,{cwd:p,env:{...process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}},preferLocal:!0,reject:!1,stdin:`inherit`});if(a.outputFilter){let e=A(a.outputFilter),n=A(a.outputFilter);t.stdout.pipe(e).pipe(m,{end:!1}),t.stderr.pipe(n).pipe(m,{end:!1})}else t.stdout.pipe(m,{end:!1}),t.stderr.pipe(m,{end:!1});if(await t,a.prettyJsonOutput){m.end();let e=await ce(m),t=C(JSON.parse(e)).split(`
5
+ `);for(let e of t)c.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${a.name} failed with error:`),console.error(e),re(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function de(e){return`execute`in e}async function N(e,t,n,r,i,a){let o=[];for(let a of r){let r=await(de(a)?le(e,t,n,a,i):ue(e,t,n,a,i));o.push({exitCode:r,name:a.name})}if(a){let t=o.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=o.filter(({exitCode:e})=>e!==0).map(({name:e})=>e),r=o.length;t.length>0&&e.write(`✅ ${l.green(l.bold(`${t.length} / ${r} ${M(`Command`,t.length)} Succeeded:`))} ${l.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${l.red(l.bold(`${n.length} / ${r} ${M(`Command`,n.length)} Failed:`))} ${l.red(n.join(`, `))}\n`)}return o.every(({exitCode:e})=>e===0)?0:1}async function P(e,i,a,c){let l=await s();if(l===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let u=await s({cwd:o(import.meta.url)});if(u===void 0)return e.write(`Error: The script being called was not in a package, weird.
6
+ `),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0];if(i===`package`){let r=t.readJsonSync(l);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=w(r,c);t.writeJSONSync(l,i,{spaces:` `}),await O(l)}else{let r=t.readJsonSync(l);Object.keys(r).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete r[n],t.writeJSONSync(l,r,{spaces:` `}),await O(l))}}if(!await t.pathExists(d))return 0;if((await t.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await t.copy(d,f,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(p&&i===`package`&&o.includes(a))return l?(e.write(`Deleting: \n"${o}" → "${s}" (Because --location is set to "package")\n`),t.removeSync(s)):e.write(`Skipping: \n"${o}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&r.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=w(t.readJSONSync(s),n);return t.writeJSONSync(s,r,{spaces:` `}),await O(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await O(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await O(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function F(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e,p=j(s,o);p.pipe(process.stdout);let m=u(d(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&m.command({builder(e){return n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`Where to store the configuration.`,type:`string`}):e},command:`init`,describe:n.description??`Initialize by copying starter config files to your project root${n.locationOptionFlag?` or to your package.json file.`:`.`}`,async handler(e){let t=n.locationOptionFlag?e.location:void 0,r=await N(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return P(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]]);process.exit(r)}}),r!==void 0&&m.command({builder(e){return r.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...r.positionalArgumentDefault===void 0?{}:{default:r.positionalArgumentDefault},describe:`Files or glob pattern to lint.`,type:`string`})},command:r.positionalArgumentMode===`none`?`lint`:r.positionalArgumentMode===`optional`?`lint [files..]`:`lint <files..>`,describe:r.description,async handler(e){let t=await N(p,e.files??[],[],r.commands,f,l);process.exit(t)}}),t!==void 0&&m.command({builder(e){return t.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...t.positionalArgumentDefault===void 0?{}:{default:t.positionalArgumentDefault},describe:`Files or glob pattern to fix.`,type:`string`})},command:t.positionalArgumentMode===`none`?`fix`:t.positionalArgumentMode===`optional`?`fix [files..]`:`fix <files..>`,describe:t.description,async handler(e){let n=await N(p,e.files??[],[],t.commands);process.exit(n)}}),i!==void 0&&m.command({builder(e){return i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault===void 0?{}:{default:i.positionalArgumentDefault},describe:`File or glob pattern to print configuration for.`,type:`string`})},command:i.positionalArgumentMode===`none`?`print-config`:i.positionalArgumentMode===`optional`?`print-config [file]`:`print-config <file>`,describe:i.description,async handler(e){let t=e.file??void 0,n=await N(p,t===void 0?[]:[t],[],i.commands,f,l);process.exit(n)}}),m.alias(`h`,`help`),m.version(ne),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const I={fileRun:`Matches files below the current working directory by default.`,monorepoRun:`In a monorepo, it will also run in all packages below the current working directory.`,monorepoSearch:`Searches up to the root of a monorepo if necessary.`,multiArgumentCaveat:`Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.`,multiOptionCaveat:`Will use option flags where possible if provided, but some of the invoked tools will ignore them.`,optionalFileRun:`Package-scoped by default, file-scoped if a file argument is provided.`,packageRun:`Package-scoped.`,packageSearch:`Package-scoped.`},L=[/Version 2\.0,?\s*January 2004/g,/Version 1,?\s*February 1989/g,/Version 2,?\s*June 1991/g,/Version 3,?\s*29 June 2007/g,/Version 2\.1,?\s*February 1999/g,/Version 3,?\s*19 November 2007/g,/Version 1\.0\s*-\s*August 17th,?\s*2003/g,/Version 1\.1,?\s*March 2000/g,/Version 1\.2,?\s*November 2002/g,/Version 1\.3,?\s*3 November 2008/g,/Version 1\.0\s*-\s*22 November 2005/g,/Version 1\.1\s*-\s*26 February 2007/g,/Version 2,?\s*December 2004/g,/20 December 1996/g,/December 20,?\s*1996/g,/11 March 1996/g,/28 March 2007/g,/November 1,?\s*2008/g,/August 1,?\s*2009/g,/1 April 19\d{2}/g,/Copyright \(c\) 2000-2006,?\s*The Perl Foundation/gi,/Copyright \(C\) (?:\d{4},?\s*)+Free Software Foundation/g],R=[`node_modules/**`,`test/**`];function z(e){let t=e;for(let e of L)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/g,`X`));return t}const B=/(\d{4})\s*-\s*(\d{4})/,V=/(\d{4})/;function fe(e,t){let n=z(e),r=B,i=r.exec(n);if(i){let[,n,a]=i;if(Number.parseInt(a,10)!==t){let a=`${n}-${t}`;return e.slice(0,i.index)+e.slice(i.index).replace(r,a)}return e}let a=V,o=a.exec(n);if(o){let[,n]=o;if(Number.parseInt(n,10)!==t){let r=`${n}-${t}`;return e.slice(0,o.index)+e.slice(o.index).replace(a,r)}return e}return e}async function H(e,t=!1){let n=new Date().getFullYear(),r=[],i=await ee([`**/license.txt`,`**/license`,...R.map(e=>`!${e}`)],{caseSensitiveMatch:!1,cwd:E(),followSymbolicLinks:!1,gitignore:!0});for(let e of i)r.push(e);let a=[];for(let e of r)try{let r=await v.readFile(e,`utf8`),i=fe(r,n);i!==r&&(a.push(e),t&&await v.writeFile(e,i,`utf8`))}catch(t){console.error(`Failed to process ${e}:`,t)}if(a.length>0){e.write(`${t?`Fixed`:`Found`} ${a.length} license ${M(`file`,a.length)} with outdated copyright year:\n`);for(let t of a)e.write(` - ${t}\n`);return t?0:1}return 0}async function U(e){return H(e,!1)}async function W(e){return H(e,!0)}const G=`pnpm-lock.yaml`;function pe(e){let n=D(),i=r.resolve(e);for(;;){if(t.existsSync(r.join(i,G)))return i;if(i===n)break;let e=r.dirname(i);if(e===i)break;i=e}}function K(e,t,n){let r=`${e}@${t}`;if(r in n)return r;if(t in n)return t}async function q(e){let t=pe(e);if(!t)throw Error(`${G} not found at or above "${e}".`);let n=r.join(t,G),i=await S(t,{ignoreIncompatible:!1});if(!i?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let a=i.packages??{},o,s,c={},l={};function u(e,t){let n,r=new Set;function i(e,t){if(t.startsWith(`link:`))return;let o=K(e,t,a);if(!o||r.has(o))return;r.add(o);let s=a[o],c=s?.engines?.node;if(c){let e=te(c)?.version;e&&(!n||x(e,n))&&(n=e)}if(s?.dependencies)for(let[e,t]of Object.entries(s.dependencies))typeof t==`string`&&i(e,t)}return i(e,t),n}function d(e,t){for(let[n,r]of Object.entries(e)){let e=u(n,typeof r==`string`?r:r.version);if(e){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:o;(!i||x(e,i))&&(t?s=e:o=e)}}}let f=r.relative(t,e)||`.`,p=i.importers[f];p&&(p.dependencies&&d(p.dependencies,!1),p.devDependencies&&d(p.devDependencies,!0));let m=o&&s?x(o,s)?`>=${o}`:`>=${s}`:o?`>=${o}`:s?`>=${s}`:void 0;return{dependencies:o?{topLevelCauses:[...c[o]],version:`>=${o}`}:void 0,devDependencies:s?{topLevelCauses:[...l[s]],version:`>=${s}`}:void 0,lockfile:n,version:m}}function me(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function J(e,t){let n=e.devEngines??{};if(n.runtime)if(Array.isArray(n.runtime)){let e=n.runtime.findIndex(e=>e.name===`node`);e===-1?n.runtime.push({name:`node`,version:t}):n.runtime[e].version=t}else n.runtime.name===`node`?n.runtime.version=t:n.runtime=[n.runtime,{name:`node`,version:t}];else n.runtime={name:`node`,version:t};e.devEngines=n}function he(e){let t=e.devEngines;t?.runtime&&(Array.isArray(t.runtime)?(t.runtime=t.runtime.filter(e=>e.name!==`node`),t.runtime.length===0?delete t.runtime:t.runtime.length===1&&(t.runtime=t.runtime[0])):t.runtime.name===`node`&&delete t.runtime,Object.keys(t).length===0&&delete e.devEngines)}function Y(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function ge(e,n,i){let a=r.join(i,`package.json`);if(!t.existsSync(a))return 0;let o=t.readJsonSync(a),s=o.engines?.node,c=me(o),l=await q(i),u=l.dependencies?.version,d=l.dependencies?.topLevelCauses??[],f=l.version,p=l.devDependencies?.topLevelCauses??[],m=[];if(u!==void 0)if(s===void 0){if(m.push(`Missing engines.node — suggest setting to "${u}"${Y(d)}`),n){let e=o.engines??{};e.node=u,o.engines=e}}else{let e=b.minVersion(s),t=b.minVersion(u);e&&t&&b.lt(e,t)&&(m.push(`engines.node is "${s}" but production dependencies require at least "${u}"${Y(d)}`),n&&(o.engines.node=u))}let h=(()=>{if(u&&s){let e=b.minVersion(u),t=b.minVersion(s);if(e&&t)return b.gt(e,t)?u:s}return u??s})(),g=h?b.minVersion(h):void 0,_=f?b.minVersion(f):void 0,v=_&&g&&b.gt(_,g);if(f!==void 0&&v)if(c===void 0)m.push(`devDependencies require a higher Node.js minimum (${f}) than engines.node (${h??`none`}) — suggest adding devEngines.runtime for node with version "${f}"${Y(p)}`),n&&J(o,f);else{let e=b.minVersion(c);e&&b.lt(e,_)&&(m.push(`devEngines.runtime.version for node is "${c}" but all dependencies require at least "${f}"${Y(p)}`),n&&J(o,f))}else if(c!==void 0){let e=b.minVersion(c);e&&g&&b.lte(e,g)&&(m.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),n&&he(o))}if(m.length>0){e.write(`${n?`Fixed`:`Found`} ${m.length} Node.js version ${M(`issue`,m.length)} in ${a}:\n`);for(let t of m)e.write(` - ${t}\n`);return n?(t.writeJsonSync(a,o,{spaces:` `}),await O(a),0):1}return 0}async function X(e,t){let n=T(),r=0;for(let i of n)await ge(e,t,i)!==0&&(r=1);return r}async function Z(e){let t=C(await q(E())).split(`
7
+ `);for(let n of t)e.write(`${n}\n`);return 0}async function Q(e){return X(e,!1)}async function $(e){return X(e,!0)}await F({commands:{fix:{commands:[{execute:W,name:U.name},{execute:$,name:$.name}],description:`Fix common issues like outdated copyright years in license files. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{execute:U,name:W.name},{execute:Q,name:Q.name}],description:`Check the repo for common issues. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:Z,name:Z.name}],description:`Print minimum Node.js version constraints from the pnpm lockfile.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's repository-related shared configuration tools.`,logColor:`gray`,logPrefix:`[Repo Config]`,name:`ksc-repo`,order:1});export{};
@@ -0,0 +1,51 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ workflow_dispatch: {}
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ concurrency:
13
+ group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
14
+ cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
15
+
16
+ jobs:
17
+ ci:
18
+ runs-on: ${{ matrix.os }}
19
+ timeout-minutes: 20
20
+
21
+ strategy:
22
+ fail-fast: false
23
+ matrix:
24
+ os: [ubuntu-latest, macos-latest, windows-latest]
25
+
26
+ steps:
27
+ - name: Checkout
28
+ uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
29
+ with:
30
+ persist-credentials: false
31
+
32
+ - name: Install pnpm
33
+ uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5
34
+
35
+ - name: Setup Node.js
36
+ uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
37
+ with:
38
+ node-version: 24
39
+ cache: 'pnpm'
40
+
41
+ - name: Install dependencies
42
+ run: pnpm install --frozen-lockfile
43
+
44
+ - name: Build
45
+ run: pnpm run build
46
+
47
+ - name: Lint
48
+ run: pnpm run lint
49
+
50
+ - name: Test
51
+ run: pnpm run test
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kitschpatrol/repo-config",
3
- "version": "6.2.0",
3
+ "version": "7.0.0",
4
4
  "description": "Repository configuration and GitHub workflows for @kitschpatrol/shared-config.",
5
5
  "keywords": [
6
6
  "shared-config",
@@ -50,13 +50,7 @@
50
50
  "yargs": "^18.0.0"
51
51
  },
52
52
  "engines": {
53
- "node": ">=20.19.0"
54
- },
55
- "devEngines": {
56
- "runtime": {
57
- "name": "node",
58
- "version": ">=22.18.0"
59
- }
53
+ "node": ">=22.18.0"
60
54
  },
61
55
  "publishConfig": {
62
56
  "access": "public"
package/readme.md CHANGED
@@ -1,5 +1,3 @@
1
- <!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
2
-
3
1
  <!-- title -->
4
2
 
5
3
  # @kitschpatrol/repo-config
@@ -30,13 +28,13 @@ The `lint` and `fix` commands check and correct:
30
28
 
31
29
  This includes the following:
32
30
 
33
- - [`.npmrc`](https://pnpm.io/npmrc) with publish branch guards and support for an NPM authentication environment variable for local publishing to NPM
34
31
  - [`pnpm-workspace.yaml`](https://pnpm.io/pnpm-workspace_yaml) with hoisting patterns for `ksc` tool access and trusted dependency installation scripts.
35
32
  - `.gitignore` with typical patterns
36
33
  - `.vscode` extension recommendations (additional settings and recommendations come from other `@kitschpatrol/shared-config` packages)
37
34
  - `.github` folder with workflows:
38
35
  - `github-release.yml` Automates turning turning vX.X.X tags on main into GitHub releases with changelogs
39
36
  - `set-github-metadata.yml` Populates GitHub repo metadata from package.json
37
+ - `ci.yml` Basic cross-platform CI action
40
38
 
41
39
  In order to work around some hoisting issues related to plugin resolution in the other `@kitschpatrol/shared-config` packages, it's critical that it is applied _before_ any other `@kitschpatrol/shared-config` packages are installed.
42
40
 
package/init/.npmrc DELETED
@@ -1,2 +0,0 @@
1
- # Required for automated local publishing
2
- //registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}