@kitschpatrol/repo-config
Version:
Repository configuration and GitHub workflows for @kitschpatrol/shared-config.
7 lines • 17 kB
JavaScript
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 ee}from"node:util";import{globby as te}from"globby";import y,{gt as b,minVersion as x}from"semver";import{readWantedLockfile as S}from"@pnpm/lockfile.fs";var ne=`7.6.4`;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 O(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 oe(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 k(e){try{await oe(e,await v.readFile(e,`utf8`))}catch{}}const A=/\r?\n/;function j(e){return new a({transform(t,n,r){let i=t.toString().split(A).filter(t=>t.trim()!==``&&!e(ee(t))).join(`
`);this.push(i+`
`),r()}})}function M(e,t){return new a({transform(n,r,i){let a=n.toString().split(A).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 se(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 N(e,t){return t===1?e:e+`s`}async function ce(e,t,n,r,i){let a=1,o;if(r.logPrefix===void 0)o=e;else{let t=M(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 le(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=M(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=O(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=j(a.outputFilter),n=j(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 se(m),t=C(JSON.parse(e)).split(`
`);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 ue(e){return`execute`in e}const de=/^ksc-/;function P(e){return e.replace(de,``)}function F(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>P(e.trim()))}function I(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}async function L(e,t,n,r,i,a,o){let s=o??[],c=[],u=[];for(let e of r)s.length>0&&s.includes(P(e.name))?u.push(e):c.push(e);if(s.length>0){let t=new Set(u.map(e=>P(e.name))),n=s.filter(e=>!t.has(e));if(n.length>0){let t=r.map(e=>P(e.name)).join(`, `);e.write(`⚠️ ${l.yellow(`Unrecognized --skip ${N(`value`,n.length)}: ${n.join(`, `)}. Available: ${t}`)}\n`)}}let d=[];for(let r of c){let a=await(ue(r)?ce(e,t,n,r,i):le(e,t,n,r,i));d.push({exitCode:a,name:r.name})}let f=r.length;if(u.length>0){let t=u.map(({name:e})=>e);e.write(`⏭️ ${l.dim(l.bold(`${t.length} / ${f} ${N(`Command`,t.length)} Skipped:`))} ${l.dim(t.join(`, `))}\n`)}if(a){let t=d.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=d.filter(({exitCode:e})=>e!==0).map(({name:e})=>e);t.length>0&&e.write(`✅ ${l.green(l.bold(`${t.length} / ${f} ${N(`Command`,t.length)} Succeeded:`))} ${l.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${l.red(l.bold(`${n.length} / ${f} ${N(`Command`,n.length)} Failed:`))} ${l.red(n.join(`, `))}\n`)}return+!d.every(({exitCode:e})=>e===0)}async function R(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.
`),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 k(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 k(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 k(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await k(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await k(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function z(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=M(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){let t=n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`Where to store the configuration.`,type:`string`}):e;return l?I(t):t},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=F(e.skip),i=await L(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return R(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]],void 0,void 0,r);process.exit(i)}}),r!==void 0&&m.command({builder(e){let t=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`});return l?I(t):t},command:r.positionalArgumentMode===`none`?`lint`:r.positionalArgumentMode===`optional`?`lint [files..]`:`lint <files..>`,describe:r.description,async handler(e){let t=e.files??[],n=F(e.skip),i=await L(p,t,[],r.commands,f,l,n);process.exit(i)}}),t!==void 0&&m.command({builder(e){let n=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`});return l?I(n):n},command:t.positionalArgumentMode===`none`?`fix`:t.positionalArgumentMode===`optional`?`fix [files..]`:`fix <files..>`,describe:t.description,async handler(e){let n=e.files??[],r=F(e.skip),i=await L(p,n,[],t.commands,void 0,void 0,r);process.exit(i)}}),i!==void 0&&m.command({builder(e){let t=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`});return l?I(t):t},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=t===void 0?[]:[t],r=F(e.skip),a=await L(p,n,[],i.commands,f,l,r);process.exit(a)}}),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 B={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.`},V=[/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],fe=[`node_modules/**`,`test/**`];function pe(e){let t=e;for(let e of V)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/g,`X`));return t}const me=/(\d{4})\s*-\s*(\d{4})/,he=/(\d{4})/;function ge(e,t){let n=pe(e),r=me,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=he,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 te([`**/license.txt`,`**/license`,...fe.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=ge(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 ${N(`file`,a.length)} with outdated copyright year:\n`);for(let t of a)e.write(` - ${t}\n`);return+!t}return 0}async function U(e){return H(e,!1)}async function W(e){return H(e,!0)}const G=`pnpm-lock.yaml`;function _e(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 ve(e,t,n){let r=`${e}@${t}`;if(r in n)return r;if(t in n)return t}async function K(e){let t=_e(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=ve(e,t,a);if(!o||r.has(o))return;r.add(o);let s=a[o],c=s?.engines?.node;if(c){let e=x(c)?.version;e&&(!n||b(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||b(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?b(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 ye(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function q(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 be(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 J(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function Y(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=ye(o),l=await K(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}"${J(d)}`),n){let e=o.engines??{};e.node=u,o.engines=e}}else{let e=y.minVersion(s),t=y.minVersion(u);e&&t&&y.lt(e,t)&&(m.push(`engines.node is "${s}" but production dependencies require at least "${u}"${J(d)}`),n&&(o.engines.node=u))}let h=(()=>{if(u&&s){let e=y.minVersion(u),t=y.minVersion(s);if(e&&t)return y.gt(e,t)?u:s}return u??s})(),g=h?y.minVersion(h):void 0,_=f?y.minVersion(f):void 0,v=_&&g&&y.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}"${J(p)}`),n&&q(o,f);else{let e=y.minVersion(c);e&&y.lt(e,_)&&(m.push(`devEngines.runtime.version for node is "${c}" but all dependencies require at least "${f}"${J(p)}`),n&&q(o,f))}else if(c!==void 0){let e=y.minVersion(c);e&&g&&y.lte(e,g)&&(m.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),n&&be(o))}if(m.length>0){e.write(`${n?`Fixed`:`Found`} ${m.length} Node.js version ${N(`issue`,m.length)} in ${a}:\n`);for(let t of m)e.write(` - ${t}\n`);return n?(t.writeJsonSync(a,o,{spaces:` `}),await k(a),0):1}return 0}async function X(e,t){let n=T(),r=0;for(let i of n)await Y(e,t,i)!==0&&(r=1);return r}async function Z(e){let t=C(await K(E())).split(`
`);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 z({commands:{fix:{commands:[{execute:W,name:U.name},{execute:$,name:$.name}],description:`Fix common issues like outdated copyright years in license files. ${B.packageRun} ${B.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. ${B.packageRun} ${B.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{};