@kitschpatrol/repo-config 8.1.0 → 8.3.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 +5 -6
- package/init/.github/workflows/ci.yml +1 -1
- package/init/.vscode/tasks.json +73 -0
- package/package.json +4 -4
- package/readme.md +33 -8
package/bin/cli.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
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
|
|
3
|
-
`)
|
|
4
|
-
`)}})}function
|
|
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 ue(e){return`execute`in e}const de=/^ksc-/v;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),n=l.bold(`${t.length} / ${f} ${N(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${l.dim(n)} ${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);if(t.length>0){let n=l.bold(`${t.length} / ${f} ${N(`Command`,t.length)} Succeeded:`);e.write(`✅ ${l.green(n)} ${l.green(t.join(`, `))}\n`)}if(n.length>0){let t=l.bold(`${n.length} / ${f} ${N(`Command`,n.length)} Failed:`);e.write(`❌ ${l.red(t)} ${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.
|
|
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],r=t.readJsonSync(l);if(i===`package`){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 n!==void 0&&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.exitCode=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.exitCode=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.exitCode=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.exitCode=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/gv,/Version 1,?\s*February 1989/gv,/Version 2,?\s*June 1991/gv,/Version 3,?\s*29 June 2007/gv,/Version 2\.1,?\s*February 1999/gv,/Version 3,?\s*19 November 2007/gv,/Version 1\.0\s*-\s*August 17th,?\s*2003/gv,/Version 1\.1,?\s*March 2000/gv,/Version 1\.2,?\s*November 2002/gv,/Version 1\.3,?\s*3 November 2008/gv,/Version 1\.0\s*-\s*22 November 2005/gv,/Version 1\.1\s*-\s*26 February 2007/gv,/Version 2,?\s*December 2004/gv,/20 December 1996/gv,/December 20,?\s*1996/gv,/11 March 1996/gv,/28 March 2007/gv,/November 1,?\s*2008/gv,/August 1,?\s*2009/gv,/1 April 19\d{2}/gv,/Copyright \(c\) 2000-2006,?\s*The Perl Foundation/giv,/Copyright \(C\) (?:\d{4},?\s*)+Free Software Foundation/gv],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/gv,`X`));return t}const me=/(\d{4})\s*-\s*(\d{4})/v,he=/(\d{4})/v;function ge(e,t){let n=pe(e),r=me,i=r.exec(n);if(i){let[,n,a]=i;if(Number(a)!==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(n)!==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(Object.hasOwn(n,r))return r;if(Object.hasOwn(n,t))return t}function ye(e,t){return e===void 0||e===``?t===void 0||t===``?void 0:t:t===void 0||t===``||b(e,t)?e:t}async function K(e){let t=_e(e);if(t===void 0||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===void 0||o===``||r.has(o))return;r.add(o);let s=a[o];if(s===void 0)return;let c=s.engines?.node;if(c!==void 0&&c!==``){let e=x(c)?.version;e!==void 0&&e!==``&&(n===void 0||n===``||b(e,n))&&(n=e)}if(s.dependencies)for(let[e,t]of Object.entries(s.dependencies))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!==void 0&&e!==``){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:o;(i===void 0||i===``||b(e,i))&&(t?s=e:o=e)}}}let f=r.relative(t,e),p=f===``?`.`:f,m=i.importers[p];m!==void 0&&(m.dependencies&&d(m.dependencies,!1),m.devDependencies&&d(m.devDependencies,!0));let h=ye(o,s),g=h===void 0?void 0:`>=${h}`;return{dependencies:o!==void 0&&o!==``?{topLevelCauses:[...c[o]??[]],version:`>=${o}`}:void 0,devDependencies:s!==void 0&&s!==``?{topLevelCauses:[...l[s]??[]],version:`>=${s}`}:void 0,lockfile:n,version:g}}function q(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.find(e=>e.name===`node`);e===void 0?n.runtime.push({name:`node`,version:t}):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;if(t?.runtime){if(Array.isArray(t.runtime)){t.runtime=t.runtime.filter(e=>e.name!==`node`);let[e]=t.runtime;e===void 0?delete t.runtime:t.runtime.length===1&&(t.runtime=e)}else 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 xe(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=q(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}"${Y(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}"${Y(d)}`),n&&(o.engines.node=u))}let h=(()=>{if(u!==void 0&&u!==``&&s!==void 0&&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!==void 0&&h!==``?y.minVersion(h):void 0,_=f!==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}"${Y(p)}`),n&&J(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}"${Y(p)}`),n&&J(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 xe(e,t,i)!==0&&(r=1);return r}async function Z(e){let t=C(await K(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 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{};
|
|
2
|
+
import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import{availableParallelism as r}from"node:os";import i from"node:path";import{PassThrough as a,Transform as o}from"node:stream";import{fileURLToPath as s}from"node:url";import{packageUp as c,packageUpSync as l}from"package-up";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"picocolors";import{stripVTControlCharacters as p}from"node:util";import m from"@pinojs/json-colorizer";import h from"decircular";import g from"deepmerge";import _ from"json-stringify-pretty-compact";import{findWorkspaces as v,findWorkspacesRoot as y}from"find-workspaces";import b from"node:fs/promises";import{globby as ee}from"globby";import x,{gt as S,minVersion as te}from"semver";import{readWantedLockfile as ne}from"@pnpm/lockfile.fs";var re=`8.3.0`;const ie=[`json`,`machine`,`native`],ae=ie;function C(e){return typeof e==`string`&&ie.includes(e)}function w(){let e=process.env.KSC_FORMAT;return C(e)?e:`native`}function oe(){let{argv:e}=process;for(let[t,n]of e.entries()){let r;n===`--format`?r=e[t+1]:n.startsWith(`--format=`)&&(r=n.slice(9)),C(r)&&(process.env.KSC_FORMAT=r)}}function se(){let{env:e}=process;if(e.NO_COLOR!==void 0&&e.NO_COLOR!==``)return!1;if(e.FORCE_COLOR!==void 0)return e.FORCE_COLOR!==`0`&&e.FORCE_COLOR!==`false`;if(e.TERM===`dumb`)return!1}function T(e,{ciColor:t=!0}={}){let n=se();return n===void 0?e.isTTY===!0||t&&!!process.env.CI:n}function E(){return w()===`json`?process.stderr:process.stdout}function D(){return w()===`machine`?f.createColors(!1):f.createColors(T(E()))}function O(e){if(!e)return{FORCE_COLOR:`0`,NO_COLOR:`1`};let t=process.env.FORCE_COLOR;return t===void 0||t===``?{FORCE_COLOR:`1`}:{}}function ce(e,t){let n=i.isAbsolute(e)?e:i.resolve(t,e),r=i.relative(process.cwd(),n);return r===``?`.`:r}const le=/\s*\n\s*/gv,ue=/\r?\n/v;function de(e){let t=e.message.replaceAll(le,` `),n=e.rule===void 0?e.tool:`${e.tool}/${e.rule}`;return e.file===void 0?`${e.severity}: ${t} [${n}]`:`${e.file}:${e.line??1}:${e.column??1}: ${e.severity}: ${t} [${n}]`}function fe(e,t){let n=(e.file??``).localeCompare(t.file??``);if(n!==0)return n;let r=(e.line??0)-(t.line??0);return r===0?(e.column??0)-(t.column??0):r}function pe(e,t){let n=t.toSorted(fe);return{cwd:process.cwd(),diagnostics:n,success:e.every(e=>e.exitCode===0),summary:{errors:n.filter(e=>e.severity===`error`).length,infos:n.filter(e=>e.severity===`info`).length,warnings:n.filter(e=>e.severity===`warning`).length},tools:e,version:1}}function k(e){return p(e).split(ue).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function me(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function A(e){return T(process.stdout,{ciColor:!1})?he(e):j(e)}function j(e){return _(h(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}})}function he(e){return m(j(e),{colors:{BRACKET:`gray`}})}const ge=(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]=M(e[i],a,n):e.includes(a)||r.push(a);return r};function M(e,t,n={arrayMerge:ge}){return g(e,t,n)}function N(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function _e(e,t){let n=[...N(e)];for(let e of N(t)){let t=n.findIndex(t=>t.label!==void 0&&t.label===e.label);t===-1?n.push(e):n[t]=e}return{...e,...t,tasks:n}}function ve(e,t){return e.startsWith(t+i.sep)}function P(){let e=F(),t=new Set([e]),n=v();if(n!==null)for(let r of n){let n=i.resolve(r.location);ve(n,e)&&t.add(n)}return[...t]}function F(){let e=l();if(e===void 0)throw Error(`No package.json found.`);return i.dirname(e)}function I(){let e=y();return e===null?F():i.resolve(e.location)}function L(e){if(e===`workspace-root`)return I();if(e===`package-dir`)return F();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function ye(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await b.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function R(e){try{await ye(e,await b.readFile(e,`utf8`))}catch{}}const z=/\r?\n/v;function B(e){let t=``,n=t=>t.filter(t=>t.trim()!==``&&!e(p(t))).map(e=>`${e}\n`).join(``);return new o({flush(e){e(void 0,n([t]))},transform(e,r,i){let a=(t+e.toString()).split(z);t=a.pop()??``,i(void 0,n(a))}})}function V(e,t){let n=w()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:D()[t](n),i=``,a=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new o({flush(e){e(void 0,a([i]))},transform(e,t,n){let r=(i+e.toString()).split(z);i=r.pop()??``,n(void 0,a(r))}})}async function be(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 H(e,t){return t===1?e:e+`s`}async function U(e){return typeof e==`function`?e():e}async function xe(e,t,n,r,i){let a;if(r.logPrefix===void 0)a=e;else{let t=V(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(D().bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`)+`
|
|
3
|
+
`);try{return await r.execute(a,t,n)}catch(e){return console.error(String(e)),1}}function W(e,t,n,r,a){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...a&&e.cache!==void 0?[...e.cache.flags,`--cache-location`,i.join(I(),`node_modules`,`.cache`,`ksc`,e.cache.name)]:[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function Se(t,n,r,i,o,s){let c=1,l;if(i.logPrefix===void 0)l=t;else{let e=V(i.logPrefix,i.logColor);e.pipe(t),l=e}let u=W(i,n,r,i.optionFlags,o),d=L(i.cwdOverride);s&&l.write(`Running: "${i.name} ${u.join(` `)}"\n`);let f=i.prettyJsonOutput?new a:l,p=O(w()===`native`&&i.prettyJsonOutput!==!0&&T(E()));try{let t=e(i.name,u,{cwd:d,env:{...p},preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let e=B(i.outputFilter),n=B(i.outputFilter);t.stdout.pipe(e).pipe(f,{end:!1}),t.stderr.pipe(n).pipe(f,{end:!1})}else t.stdout.pipe(f,{end:!1}),t.stderr.pipe(f,{end:!1});let n=await t;if(i.prettyJsonOutput){f.end();let e=await be(f),t=A(JSON.parse(e)).split(`
|
|
4
|
+
`);for(let e of t)l.write(`${e}\n`)}c=n.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),me(e)&&(c=typeof e.exitCode==`number`?e.exitCode:1)}return c}function G(e){return`execute`in e}function K(e){return`kind`in e}async function Ce(t,n,r,i,a){let o=W(r,t,n,r.collect?.optionFlags??r.optionFlags,i),s=L(r.cwdOverride);try{let t=e(r.name,o,{cwd:s,env:O(!1),preferLocal:!0,reject:!1,stdin:`inherit`});a!==void 0&&t.stderr.pipe(a,{end:!1});let n=await t;return{cwd:s,exitCode:n.exitCode??1,stderr:n.stderr,stdout:n.stdout}}catch(e){return console.error(`${r.name} failed with error:`),console.error(e),{cwd:s,exitCode:me(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function we(e){return typeof e==`object`&&!!e&&`version`in e&&e.version===1&&`diagnostics`in e&&Array.isArray(e.diagnostics)&&`tools`in e&&Array.isArray(e.tools)}async function Te(e,t,n,r,i){let o=Date.now(),s=()=>Date.now()-o;if(G(r)){if(r.collect!==void 0)try{let{diagnostics:e,exitCode:i,unparsed:a}=await r.collect(t,n);return{diagnostics:e,exitCode:i,tools:[{durationMs:s(),exitCode:i,name:r.name,unparsed:a}]}}catch(e){return{diagnostics:[],exitCode:1,tools:[{durationMs:s(),exitCode:1,name:r.name,unparsed:[String(e)]}]}}let e=``,i=new a;i.on(`data`,t=>{e+=t.toString()});let o;try{o=await r.execute(i,t,n)}catch(t){e+=`\n${String(t)}`,o=1}return{diagnostics:[],exitCode:o,tools:[{durationMs:s(),exitCode:o,name:r.name,unparsed:k(e)}]}}if(K(r))throw Error(`Command groups must be expanded before collection`);if(r.outputFormatAware){let a=await Ce(t,n,r,i,e);try{let e=JSON.parse(a.stdout);if(!we(e))throw Error(`Child output is not a lint report`);return{diagnostics:e.diagnostics,exitCode:a.exitCode,tools:e.tools}}catch{return{diagnostics:[],exitCode:a.exitCode,tools:[{durationMs:s(),exitCode:a.exitCode,name:r.name,unparsed:k(a.stdout)}]}}}let c=await Ce(t,n,r,i);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(c);return{diagnostics:e,exitCode:c.exitCode,tools:[{durationMs:s(),exitCode:c.exitCode,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:s(),exitCode:c.exitCode,name:r.name,unparsed:[...k(c.stdout),...k(c.stderr),String(e)]}]}}return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:s(),exitCode:c.exitCode,name:r.name,unparsed:[...k(c.stdout),...k(c.stderr)]}]}}const Ee=/^ksc-/v;function q(e){return e.replace(Ee,``)}function J(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>q(e.trim()))}function Y(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function De(e){return e.option(`format`,{choices:ae,default:`native`,describe:`Output format: "native" streams each tool's own output, "machine" prints one parseable line per issue for editor problem matchers, "json" prints an aggregate report.`})}function Oe(e){return e.option(`cache`,{boolean:!0,default:!0,describe:`Use tool-native caches stored below node_modules/.cache/ksc at the workspace root. Disable with --no-cache.`})}function ke(e,t){return t===`native`||t===`machine`&&!G(e)&&!K(e)&&e.outputFormatAware===!0}function Ae(e,t){for(let n of t.diagnostics)e.write(`${de(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function je(){return Math.min(4,r())}var Me=class{concurrency;active=0;queue=[];constructor(e){this.concurrency=e}async run(e){this.active>=this.concurrency&&await new Promise(e=>{this.queue.push(e)}),this.active+=1;try{return await e()}finally{--this.active,this.queue.shift()?.()}}};async function Ne(e){let n=e.cache??!1,r=e.concurrency??je();if(!Number.isInteger(r)||r<1)throw Error(`Concurrency must be a positive integer.`);return n&&await t.ensureDir(i.join(I(),`node_modules`,`.cache`,`ksc`)),{cache:n,scheduler:new Me(r)}}function Pe(e,t){return e.positionalArgumentMode===`none`?[]:t.length>0?t:e.positionalArgumentDefault===void 0?[]:[e.positionalArgumentDefault]}function Fe(e,t){if(t.logPrefix===void 0)return e;let n=V(t.logPrefix,t.logColor);return n.pipe(e),n}async function Ie(e,t){if(K(e)){if(t.nativeVerbose){let n=[e.subcommand,...t.positionalArguments].join(` `);t.logStream.write(`Running: "${e.name} ${n}"\n`)}let n=Fe(t.logStream,e);try{let r=await Le(await U(e.commands),{...t,logStream:n,nativeVerbose:e.verbose,positionalArguments:Pe(e,t.positionalArguments)},e.parallel===!0);return{diagnostics:r.flatMap(({diagnostics:e})=>e),exitCode:+!r.every(({exitCode:e})=>e===0),machineOutcomes:r.flatMap(({machineOutcomes:e})=>e),name:e.name,tools:r.flatMap(({tools:e})=>e)}}catch(r){let i=String(r),a={durationMs:0,exitCode:1,name:e.name,unparsed:[i]};return t.format===`native`&&n.write(`${i}\n`),{diagnostics:[],exitCode:1,machineOutcomes:[{diagnostics:[],exitCode:1,tools:[a]}],name:e.name,tools:[a]}}}return t.scheduler.run(async()=>{if(ke(e,t.format))return{diagnostics:[],exitCode:await(G(e)?xe(t.logStream,t.positionalArguments,t.optionFlags,e,t.nativeVerbose):Se(t.logStream,t.positionalArguments,t.optionFlags,e,t.cache,t.nativeVerbose)),machineOutcomes:[],name:e.name,tools:[]};let n=await Te(t.logStream,t.positionalArguments,t.optionFlags,e,t.cache);return{diagnostics:n.diagnostics,exitCode:n.exitCode,machineOutcomes:[n],name:e.name,tools:n.tools}})}async function Le(e,t,n){if(!n||t.scheduler.concurrency===1){let n=[];for(let r of e)n.push(await Ie(r,t));return n}await Promise.resolve();let r=new Map;for(let[t,n]of e.entries()){let e=n.stage??0,i=r.get(e)??[];i.push({command:n,index:t}),r.set(e,i)}let i=Array.from({length:e.length}),a=r.keys().toArray().toSorted((e,t)=>e-t);for(let e of a){let n=r.get(e)??[],a=await Promise.all(n.map(async({command:e,index:n})=>({index:n,outcome:await Ie(e,t)})));for(let{index:e,outcome:t}of a)i[e]=t}return i.filter(e=>e!==void 0)}function Re(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(q(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>q(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>q(e.name)).join(`, `);e.write(`⚠️ ${D().yellow(`Unrecognized --skip ${H(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}async function X(e,t,n,r,i,a,o,s=`native`){let c=typeof s==`string`?{}:s,l=typeof s==`string`?s:c.format??`native`,{commandsToRun:u,skippedCommands:d}=Re(e,r,o??[]),f=l===`native`&&i,{cache:p,scheduler:m}=await Ne(c),h=await Le(u,{cache:p,format:l,logStream:e,nativeVerbose:f,optionFlags:n,positionalArguments:t,scheduler:m},c.parallel===!0),g=h.map(({exitCode:e,name:t})=>({exitCode:e,name:t})),_=h.flatMap(({tools:e})=>e),v=h.flatMap(({diagnostics:e})=>e);if(l===`machine`)for(let t of h)for(let n of t.machineOutcomes)Ae(e,n);let y=r.length,b=D();if(l===`native`&&d.length>0){let t=d.map(({name:e})=>e),n=b.bold(`${t.length} / ${y} ${H(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${b.dim(n)} ${b.dim(t.join(`, `))}\n`)}if(l===`native`&&a){let t=g.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=g.filter(({exitCode:e})=>e!==0).map(({name:e})=>e);if(t.length>0){let n=b.bold(`${t.length} / ${y} ${H(`Command`,t.length)} Succeeded:`);e.write(`✅ ${b.green(n)} ${b.green(t.join(`, `))}\n`)}if(n.length>0){let t=b.bold(`${n.length} / ${y} ${H(`Command`,n.length)} Failed:`);e.write(`❌ ${b.red(t)} ${b.red(n.join(`, `))}\n`)}}return{exitCode:+!g.every(({exitCode:e})=>e===0),report:l===`json`?pe(_,v):void 0}}async function ze(e,r,a,o){let l=await c();if(l===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let u=await c({cwd:s(import.meta.url)});if(u===void 0)return e.write(`Error: The script being called was not in a package, weird.
|
|
5
|
+
`),1;let d=i.join(i.dirname(u),`init`),f=i.dirname(l),p=(r===`file`||r===`package`)&&a!==void 0&&o!==void 0;try{if(p){let n=Object.keys(o)[0],i=t.readJsonSync(l);if(r===`package`){e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let r=M(i,o);t.writeJSONSync(l,r,{spaces:` `}),await R(l)}else n!==void 0&&Object.keys(i).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete i[n],t.writeJSONSync(l,i,{spaces:` `}),await R(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&&r===`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`))&&i.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=t.readJSONSync(s),i=s.endsWith(`.vscode/tasks.json`)?_e(r,n):M(r,n);return t.writeJSONSync(s,i,{spaces:` `}),await R(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await R(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await R(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Be(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e;oe();let p=V(s,o);p.pipe(E());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?Y(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=J(e.skip),{exitCode:i}=await X(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return ze(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]],void 0,void 0,r);process.exitCode=i}}),r!==void 0&&m.command({builder(e){let t=Oe(De(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?Y(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=J(e.skip),i=w(),{exitCode:a,report:o}=await X(p,t,[],await U(r.commands),f,l,n,{cache:e.cache,format:i,parallel:r.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=Oe(De(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?Y(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=J(e.skip),i=w(),{exitCode:a,report:o}=await X(p,n,[],await U(t.commands),void 0,void 0,r,{cache:e.cache,format:i,parallel:t.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),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?Y(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=J(e.skip),{exitCode:a}=await X(p,n,[],await U(i.commands),f,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(re),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const Z={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.`},Ve=[/Version 2\.0,?\s*January 2004/gv,/Version 1,?\s*February 1989/gv,/Version 2,?\s*June 1991/gv,/Version 3,?\s*29 June 2007/gv,/Version 2\.1,?\s*February 1999/gv,/Version 3,?\s*19 November 2007/gv,/Version 1\.0\s*-\s*August 17th,?\s*2003/gv,/Version 1\.1,?\s*March 2000/gv,/Version 1\.2,?\s*November 2002/gv,/Version 1\.3,?\s*3 November 2008/gv,/Version 1\.0\s*-\s*22 November 2005/gv,/Version 1\.1\s*-\s*26 February 2007/gv,/Version 2,?\s*December 2004/gv,/20 December 1996/gv,/December 20,?\s*1996/gv,/11 March 1996/gv,/28 March 2007/gv,/November 1,?\s*2008/gv,/August 1,?\s*2009/gv,/1 April 19\d{2}/gv,/Copyright \(c\) 2000-2006,?\s*The Perl Foundation/giv,/Copyright \(C\) (?:\d{4},?\s*)+Free Software Foundation/gv],He=[`node_modules/**`,`test/**`];function Ue(e){let t=e;for(let e of Ve)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/gv,`X`));return t}const We=/(\d{4})\s*-\s*(\d{4})/v,Ge=/(\d{4})/v;function Ke(e,t){let n=Ue(e),r=We,i=r.exec(n);if(i){let[,n,a]=i;if(Number(a)!==t){let a=`${n}-${t}`;return e.slice(0,i.index)+e.slice(i.index).replace(r,()=>a)}return e}let a=Ge,o=a.exec(n);if(o){let[,n]=o;if(Number(n)!==t){let r=`${n}-${t}`;return e.slice(0,o.index)+e.slice(o.index).replace(a,()=>r)}return e}return e}async function qe(e){let t=new Date().getFullYear(),n=await ee([`**/license.txt`,`**/license`,...He.map(e=>`!${e}`)],{caseSensitiveMatch:!1,cwd:F(),followSymbolicLinks:!1,gitignore:!0}),r=[];for(let i of n)try{let n=await b.readFile(i,`utf8`),a=Ke(n,t);a!==n&&(r.push(i),e&&await b.writeFile(i,a,`utf8`))}catch(e){console.error(`Failed to process ${i}:`,e)}return r}async function Je(e,t=!1){let n=await qe(t);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} license ${H(`file`,n.length)} with outdated copyright year:\n`);for(let t of n)e.write(` - ${t}\n`);return+!t}return 0}async function Ye(e){return Je(e,!1)}async function Xe(){let e=await qe(!1);return{diagnostics:e.map(e=>({file:ce(e,F()),message:`License file has an outdated copyright year`,severity:`error`,tool:`copyright-year`})),exitCode:+(e.length>0),unparsed:[]}}async function Ze(e){return Je(e,!0)}const Q=`pnpm-lock.yaml`;function Qe(e){let n=I(),r=i.resolve(e);for(;;){if(t.existsSync(i.join(r,Q)))return r;if(r===n)break;let e=i.dirname(r);if(e===r)break;r=e}}function $e(e,t,n){let r=`${e}@${t}`;if(Object.hasOwn(n,r))return r;if(Object.hasOwn(n,t))return t}function et(e,t){return e===void 0||e===``?t===void 0||t===``?void 0:t:t===void 0||t===``||S(e,t)?e:t}async function tt(e){let t=Qe(e);if(t===void 0||t===``)throw Error(`${Q} not found at or above "${e}".`);let n=i.join(t,Q),r=await ne(t,{ignoreIncompatible:!1});if(!r?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let a=r.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=$e(e,t,a);if(o===void 0||o===``||r.has(o))return;r.add(o);let s=a[o];if(s===void 0)return;let c=s.engines?.node;if(c!==void 0&&c!==``){let e=te(c)?.version;e!==void 0&&e!==``&&(n===void 0||n===``||S(e,n))&&(n=e)}if(s.dependencies)for(let[e,t]of Object.entries(s.dependencies))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!==void 0&&e!==``){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:o;(i===void 0||i===``||S(e,i))&&(t?s=e:o=e)}}}let f=i.relative(t,e),p=f===``?`.`:f,m=r.importers[p];m!==void 0&&(m.dependencies&&d(m.dependencies,!1),m.devDependencies&&d(m.devDependencies,!0));let h=et(o,s),g=h===void 0?void 0:`>=${h}`;return{dependencies:o!==void 0&&o!==``?{topLevelCauses:[...c[o]??[]],version:`>=${o}`}:void 0,devDependencies:s!==void 0&&s!==``?{topLevelCauses:[...l[s]??[]],version:`>=${s}`}:void 0,lockfile:n,version:g}}function nt(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function rt(e,t){let n=e.devEngines??{};if(n.runtime)if(Array.isArray(n.runtime)){let e=n.runtime.find(e=>e.name===`node`);e===void 0?n.runtime.push({name:`node`,version:t}):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 it(e){let t=e.devEngines;if(t?.runtime){if(Array.isArray(t.runtime)){t.runtime=t.runtime.filter(e=>e.name!==`node`);let[e]=t.runtime;e===void 0?delete t.runtime:t.runtime.length===1&&(t.runtime=e)}else t.runtime.name===`node`&&delete t.runtime;Object.keys(t).length===0&&delete e.devEngines}}function $(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function at(e,n){let r=i.join(n,`package.json`);if(!t.existsSync(r))return{issues:[],packageJsonPath:r};let a=t.readJsonSync(r),o=a.engines?.node,s=nt(a),c=await tt(n),l=c.dependencies?.version,u=c.dependencies?.topLevelCauses??[],d=c.version,f=c.devDependencies?.topLevelCauses??[],p=[];if(l!==void 0)if(o===void 0){if(p.push(`Missing engines.node — suggest setting to "${l}"${$(u)}`),e){let e=a.engines??{};e.node=l,a.engines=e}}else{let t=x.minVersion(o),n=x.minVersion(l);t&&n&&x.lt(t,n)&&(p.push(`engines.node is "${o}" but production dependencies require at least "${l}"${$(u)}`),e&&(a.engines.node=l))}let m=(()=>{if(l!==void 0&&l!==``&&o!==void 0&&o!==``){let e=x.minVersion(l),t=x.minVersion(o);if(e&&t)return x.gt(e,t)?l:o}return l??o})(),h=m!==void 0&&m!==``?x.minVersion(m):void 0,g=d!==void 0&&d!==``?x.minVersion(d):void 0,_=g&&h&&x.gt(g,h);if(d!==void 0&&_)if(s===void 0)p.push(`devDependencies require a higher Node.js minimum (${d}) than engines.node (${m??`none`}) — suggest adding devEngines.runtime for node with version "${d}"${$(f)}`),e&&rt(a,d);else{let t=x.minVersion(s);t&&x.lt(t,g)&&(p.push(`devEngines.runtime.version for node is "${s}" but all dependencies require at least "${d}"${$(f)}`),e&&rt(a,d))}else if(s!==void 0){let t=x.minVersion(s);t&&h&&x.lte(t,h)&&(p.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),e&&it(a))}return e&&p.length>0&&(t.writeJsonSync(r,a,{spaces:` `}),await R(r)),{issues:p,packageJsonPath:r}}async function ot(e,t){let n=P(),r=0;for(let i of n){let{issues:n,packageJsonPath:a}=await at(t,i);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} Node.js version ${H(`issue`,n.length)} in ${a}:\n`);for(let t of n)e.write(` - ${t}\n`);t||(r=1)}}return r}async function st(){let e=P(),t=[];for(let n of e){let{issues:e,packageJsonPath:r}=await at(!1,n);for(let n of e)t.push({file:ce(r,process.cwd()),message:n,severity:`error`,tool:`node-version`})}return{diagnostics:t,exitCode:+(t.length>0),unparsed:[]}}async function ct(e){let t=A(await tt(F())).split(`
|
|
6
|
+
`);for(let n of t)e.write(`${n}\n`);return 0}async function lt(e){return ot(e,!1)}async function ut(e){return ot(e,!0)}await Be({commands:{fix:{commands:[{execute:Ze,name:`copyright-year`},{execute:ut,name:`node-version`}],description:`Fix common issues like outdated copyright years in license files. ${Z.packageRun} ${Z.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{collect:Xe,execute:Ye,name:`copyright-year`},{collect:st,execute:lt,name:`node-version`}],description:`Check the repo for common issues. ${Z.packageRun} ${Z.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:ct,name:`node-version`}],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{};
|
|
@@ -33,7 +33,7 @@ jobs:
|
|
|
33
33
|
uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
|
|
34
34
|
|
|
35
35
|
- name: Setup Node.js
|
|
36
|
-
uses: actions/setup-node@
|
|
36
|
+
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
|
37
37
|
with:
|
|
38
38
|
node-version: 24
|
|
39
39
|
cache: 'pnpm'
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "2.0.0",
|
|
3
|
+
"tasks": [
|
|
4
|
+
{
|
|
5
|
+
"label": "ksc-repo lint",
|
|
6
|
+
"detail": "Check the repo for common issues.",
|
|
7
|
+
"type": "shell",
|
|
8
|
+
"command": "pnpm exec ksc-repo lint --format machine",
|
|
9
|
+
"options": {
|
|
10
|
+
"cwd": "${workspaceFolder}"
|
|
11
|
+
},
|
|
12
|
+
"presentation": {
|
|
13
|
+
"clear": true,
|
|
14
|
+
"echo": true,
|
|
15
|
+
"focus": false,
|
|
16
|
+
"panel": "dedicated",
|
|
17
|
+
"reveal": "silent",
|
|
18
|
+
"revealProblems": "onProblem",
|
|
19
|
+
"showReuseMessage": false
|
|
20
|
+
},
|
|
21
|
+
"problemMatcher": [
|
|
22
|
+
{
|
|
23
|
+
"owner": "ksc",
|
|
24
|
+
"source": "ksc",
|
|
25
|
+
"fileLocation": ["relative", "${workspaceFolder}"],
|
|
26
|
+
"pattern": {
|
|
27
|
+
"regexp": "^(.+?):(\\d+):(\\d+): (error|warning|info): (.+) \\[([^\\]]+)\\]$",
|
|
28
|
+
"file": 1,
|
|
29
|
+
"line": 2,
|
|
30
|
+
"column": 3,
|
|
31
|
+
"severity": 4,
|
|
32
|
+
"message": 5,
|
|
33
|
+
"code": 6
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"label": "ksc-repo fix",
|
|
40
|
+
"detail": "Fix common issues like outdated copyright years in license files.",
|
|
41
|
+
"type": "shell",
|
|
42
|
+
"command": "pnpm exec ksc-repo fix --format machine",
|
|
43
|
+
"options": {
|
|
44
|
+
"cwd": "${workspaceFolder}"
|
|
45
|
+
},
|
|
46
|
+
"presentation": {
|
|
47
|
+
"clear": true,
|
|
48
|
+
"echo": true,
|
|
49
|
+
"focus": false,
|
|
50
|
+
"panel": "dedicated",
|
|
51
|
+
"reveal": "silent",
|
|
52
|
+
"revealProblems": "onProblem",
|
|
53
|
+
"showReuseMessage": false
|
|
54
|
+
},
|
|
55
|
+
"problemMatcher": [
|
|
56
|
+
{
|
|
57
|
+
"owner": "ksc",
|
|
58
|
+
"source": "ksc",
|
|
59
|
+
"fileLocation": ["relative", "${workspaceFolder}"],
|
|
60
|
+
"pattern": {
|
|
61
|
+
"regexp": "^(.+?):(\\d+):(\\d+): (error|warning|info): (.+) \\[([^\\]]+)\\]$",
|
|
62
|
+
"file": 1,
|
|
63
|
+
"line": 2,
|
|
64
|
+
"column": 3,
|
|
65
|
+
"severity": 4,
|
|
66
|
+
"message": 5,
|
|
67
|
+
"code": 6
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
]
|
|
73
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/repo-config",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.3.0",
|
|
4
4
|
"description": "Repository configuration and GitHub workflows for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -33,15 +33,15 @@
|
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@pinojs/json-colorizer": "^4.0.0",
|
|
36
|
-
"@pnpm/lockfile.fs": "
|
|
36
|
+
"@pnpm/lockfile.fs": "1100.1.11",
|
|
37
37
|
"cosmiconfig": "^9.0.2",
|
|
38
38
|
"cosmiconfig-typescript-loader": "^6.3.0",
|
|
39
39
|
"decircular": "^1.0.0",
|
|
40
40
|
"deepmerge": "^4.3.1",
|
|
41
|
-
"execa": "^
|
|
41
|
+
"execa": "^10.0.0",
|
|
42
42
|
"find-workspaces": "^0.3.1",
|
|
43
43
|
"fs-extra": "^11.3.6",
|
|
44
|
-
"globby": "^16.2.
|
|
44
|
+
"globby": "^16.2.1",
|
|
45
45
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
46
46
|
"package-up": "^5.0.0",
|
|
47
47
|
"picocolors": "^1.1.1",
|
package/readme.md
CHANGED
|
@@ -31,6 +31,7 @@ This includes the following:
|
|
|
31
31
|
- [`pnpm-workspace.yaml`](https://pnpm.io/pnpm-workspace_yaml) with hoisting patterns for `ksc` tool access and trusted dependency installation scripts.
|
|
32
32
|
- `.gitignore` with typical patterns
|
|
33
33
|
- `.vscode` extension recommendations (additional settings and recommendations come from other `@kitschpatrol/shared-config` packages)
|
|
34
|
+
- `.vscode/tasks.json` with `ksc-repo lint` and `ksc-repo fix` [tasks](https://code.visualstudio.com/docs/debugtest/tasks) that run the checks above in `--format machine` mode and feed reported issues into VS Code's Problems panel via a problem matcher. (The other `@kitschpatrol/shared-config` packages contribute tasks for their own tools the same way.) If a `tasks.json` already exists, `init` merges by task label, leaving your own tasks untouched.
|
|
34
35
|
- `.github` folder with workflows:
|
|
35
36
|
- `github-release.yml` Automates turning turning vX.X.X tags on main into GitHub releases with changelogs
|
|
36
37
|
- `set-github-metadata.yml` Populates GitHub repo metadata from package.json
|
|
@@ -171,10 +172,12 @@ Usage:
|
|
|
171
172
|
ksc-repo lint
|
|
172
173
|
```
|
|
173
174
|
|
|
174
|
-
| Option | Description
|
|
175
|
-
| ------------------- |
|
|
176
|
-
| `--
|
|
177
|
-
| `--
|
|
175
|
+
| Option | Description | Type | Default |
|
|
176
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
177
|
+
| `--format` | Output format: "native" streams each tool's own output, "machine" prints one parseable line per issue for editor problem matchers, "json" prints an aggregate report. | `"json"` `"machine"` `"native"` | `"native"` |
|
|
178
|
+
| `--cache` | Use tool-native caches stored below node\_modules/.cache/ksc at the workspace root. Disable with --no-cache. | `boolean` | `true` |
|
|
179
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
180
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
178
181
|
|
|
179
182
|
#### Subcommand: `ksc-repo fix`
|
|
180
183
|
|
|
@@ -186,10 +189,12 @@ Usage:
|
|
|
186
189
|
ksc-repo fix
|
|
187
190
|
```
|
|
188
191
|
|
|
189
|
-
| Option | Description
|
|
190
|
-
| ------------------- |
|
|
191
|
-
| `--
|
|
192
|
-
| `--
|
|
192
|
+
| Option | Description | Type | Default |
|
|
193
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
194
|
+
| `--format` | Output format: "native" streams each tool's own output, "machine" prints one parseable line per issue for editor problem matchers, "json" prints an aggregate report. | `"json"` `"machine"` `"native"` | `"native"` |
|
|
195
|
+
| `--cache` | Use tool-native caches stored below node\_modules/.cache/ksc at the workspace root. Disable with --no-cache. | `boolean` | `true` |
|
|
196
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
197
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
193
198
|
|
|
194
199
|
#### Subcommand: `ksc-repo print-config`
|
|
195
200
|
|
|
@@ -208,6 +213,26 @@ ksc-repo print-config
|
|
|
208
213
|
|
|
209
214
|
<!-- /cli-help -->
|
|
210
215
|
|
|
216
|
+
### VS Code tasks
|
|
217
|
+
|
|
218
|
+
`ksc-repo init` adds a `.vscode/tasks.json` with two tasks:
|
|
219
|
+
|
|
220
|
+
- **`ksc-repo lint`** runs `ksc-repo lint --format machine` across the whole project
|
|
221
|
+
- **`ksc-repo fix`** runs `ksc-repo fix --format machine`, applying auto-fixes and reporting whatever couldn't be fixed
|
|
222
|
+
|
|
223
|
+
If you're using the complete [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) package, you'd more likely want to run:
|
|
224
|
+
|
|
225
|
+
- **`ksc lint`** runs `ksc lint --format machine`, which runs all `ksc lint` tools across the whole project
|
|
226
|
+
- **`ksc fix`** runs `ksc fix --format machine`, which applies all `ksc fix` auto-fixes and reports anything unfixable
|
|
227
|
+
|
|
228
|
+
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
229
|
+
|
|
230
|
+
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/debugtest/debugging#_errors-and-warnings) with every reported issue, pointing to the offending file, line, and column.
|
|
231
|
+
|
|
232
|
+
The tasks share a problem matcher owner with the other `@kitschpatrol/shared-config` tasks, so the panel reflects the most recent run rather than stacking duplicates.
|
|
233
|
+
|
|
234
|
+
If your project already has a `.vscode/tasks.json`, `init` merges by task label: your own tasks are left alone, and same-label tasks are replaced with the latest definitions.
|
|
235
|
+
|
|
211
236
|
<!-- license -->
|
|
212
237
|
|
|
213
238
|
## License
|