@kitschpatrol/repo-config 8.0.0 → 8.2.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,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 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
|
|
3
|
-
`)
|
|
4
|
-
`)}})}
|
|
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 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],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;if(Object.hasOwn(i.importers,p)){let e=i.importers[p];e.dependencies&&d(e.dependencies,!1),e.devDependencies&&d(e.devDependencies,!0)}let m=ye(o,s),h=m===void 0?void 0:`>=${m}`;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:h}}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.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 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 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{stripVTControlCharacters as f}from"node:util";import p from"@pinojs/json-colorizer";import m from"decircular";import h from"deepmerge";import g from"json-stringify-pretty-compact";import{findWorkspaces as _,findWorkspacesRoot as ee}from"find-workspaces";import v from"node:fs/promises";import{globby as te}from"globby";import y,{gt as b,minVersion as ne}from"semver";import{readWantedLockfile as re}from"@pnpm/lockfile.fs";var ie=`8.2.0`;function x(e,t){let n=r.isAbsolute(e)?e:r.resolve(t,e),i=r.relative(process.cwd(),n);return i===``?`.`:i}const ae=/\s*\n\s*/gv,oe=/\r?\n/v;function se(e){let t=e.message.replaceAll(ae,` `),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 ce(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 le(e,t){let n=t.toSorted(ce);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 S(e){return f(e).split(oe).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function C(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function w(e){return p(g(m(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const ue=(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]=T(e[i],a,n):e.includes(a)||r.push(a);return r};function T(e,t,n={arrayMerge:ue}){return h(e,t,n)}function de(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function fe(e,t){let n=[...de(e)];for(let e of de(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}}const E=[`json`,`machine`,`native`],pe=E;function D(e){return typeof e==`string`&&E.includes(e)}function O(){let e=process.env.KSC_FORMAT;return D(e)?e:`native`}function me(){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)),D(r)&&(process.env.KSC_FORMAT=r)}}function he(e,t){return e.startsWith(t+r.sep)}function k(){let e=A(),t=new Set([e]),n=_();if(n!==null)for(let i of n){let n=r.resolve(i.location);he(n,e)&&t.add(n)}return[...t]}function A(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return r.dirname(e)}function j(){let e=ee();return e===null?A():r.resolve(e.location)}function M(e){if(e===`workspace-root`)return j();if(e===`package-dir`)return A();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function ge(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 N(e){try{await ge(e,await v.readFile(e,`utf8`))}catch{}}const P=/\r?\n/v;function F(e){let t=``,n=t=>t.filter(t=>t.trim()!==``&&!e(f(t))).map(e=>`${e}\n`).join(``);return new a({flush(e){e(void 0,n([t]))},transform(e,r,i){let a=(t+e.toString()).split(P);t=a.pop()??``,i(void 0,n(a))}})}function I(e,t){let n=O()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:l[t](n),i=``,o=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new a({flush(e){e(void 0,o([i]))},transform(e,t,n){let r=(i+e.toString()).split(P);i=r.pop()??``,n(void 0,o(r))}})}async function _e(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>{t.push(e)}),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function L(e,t){return t===1?e:e+`s`}async function R(e){return typeof e==`function`?e():e}async function ve(e,t,n,r,i){let a;if(r.logPrefix===void 0)a=e;else{let t=I(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(l.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 z(e,t,n,r){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function ye(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=I(a.logPrefix,a.logColor);e.pipe(t),c=e}let l=z(a,n,r,a.optionFlags),u=M(a.cwdOverride);o&&c.write(`Running: "${a.name} ${l.join(` `)}"\n`);let d=a.prettyJsonOutput?new i:c,f=O()===`native`?process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}:{NO_COLOR:`1`};try{let t=e(a.name,l,{cwd:u,env:{...f},preferLocal:!0,reject:!1,stdin:`inherit`});if(a.outputFilter){let e=F(a.outputFilter),n=F(a.outputFilter);t.stdout.pipe(e).pipe(d,{end:!1}),t.stderr.pipe(n).pipe(d,{end:!1})}else t.stdout.pipe(d,{end:!1}),t.stderr.pipe(d,{end:!1});if(await t,a.prettyJsonOutput){d.end();let e=await _e(d),t=w(JSON.parse(e)).split(`
|
|
4
|
+
`);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),C(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function B(e){return`execute`in e}async function V(t,n,r,i){let a=z(r,t,n,r.collect?.optionFlags??r.optionFlags),o=M(r.cwdOverride);try{let t=e(r.name,a,{cwd:o,env:{NO_COLOR:`1`},preferLocal:!0,reject:!1,stdin:`inherit`});i!==void 0&&t.stderr.pipe(i,{end:!1});let n=await t;return{cwd:o,exitCode:n.exitCode??1,stderr:n.stderr,stdout:n.stdout}}catch(e){return console.error(`${r.name} failed with error:`),console.error(e),{cwd:o,exitCode:C(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function be(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 xe(e,t,n,r){let a=Date.now(),o=()=>Date.now()-a;if(B(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:o(),exitCode:i,name:r.name,unparsed:a}]}}catch(e){return{diagnostics:[],exitCode:1,tools:[{durationMs:o(),exitCode:1,name:r.name,unparsed:[String(e)]}]}}let e=``,a=new i;a.on(`data`,t=>{e+=t.toString()});let s;try{s=await r.execute(a,t,n)}catch(t){e+=`\n${String(t)}`,s=1}return{diagnostics:[],exitCode:s,tools:[{durationMs:o(),exitCode:s,name:r.name,unparsed:S(e)}]}}if(r.outputFormatAware){let i=await V(t,n,r,e);try{let e=JSON.parse(i.stdout);if(!be(e))throw Error(`Child output is not a lint report`);return{diagnostics:e.diagnostics,exitCode:i.exitCode,tools:e.tools}}catch{return{diagnostics:[],exitCode:i.exitCode,tools:[{durationMs:o(),exitCode:i.exitCode,name:r.name,unparsed:S(i.stdout)}]}}}let s=await V(t,n,r);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(s);return{diagnostics:e,exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...S(s.stdout),...S(s.stderr),String(e)]}]}}return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...S(s.stdout),...S(s.stderr)]}]}}const Se=/^ksc-/v;function H(e){return e.replace(Se,``)}function U(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>H(e.trim()))}function W(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function G(e){return e.option(`format`,{choices:pe,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 Ce(e,t){return t===`native`||t===`machine`&&!B(e)&&e.outputFormatAware===!0}function we(e,t){for(let n of t.diagnostics)e.write(`${se(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function Te(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(H(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>H(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>H(e.name)).join(`, `);e.write(`⚠️ ${l.yellow(`Unrecognized --skip ${L(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}async function K(e,t,n,r,i,a,o,s=`native`){let{commandsToRun:c,skippedCommands:u}=Te(e,r,o??[]),d=[],f=[],p=[],m=s===`native`&&i;for(let r of c){if(Ce(r,s)){let i=await(B(r)?ve(e,t,n,r,m):ye(e,t,n,r,m));d.push({exitCode:i,name:r.name});continue}let i=await xe(e,t,n,r);d.push({exitCode:i.exitCode,name:r.name}),f.push(...i.tools),p.push(...i.diagnostics),s===`machine`&&we(e,i)}let h=r.length;if(s===`native`&&u.length>0){let t=u.map(({name:e})=>e),n=l.bold(`${t.length} / ${h} ${L(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${l.dim(n)} ${l.dim(t.join(`, `))}\n`)}if(s===`native`&&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} / ${h} ${L(`Command`,t.length)} Succeeded:`);e.write(`✅ ${l.green(n)} ${l.green(t.join(`, `))}\n`)}if(n.length>0){let t=l.bold(`${n.length} / ${h} ${L(`Command`,n.length)} Failed:`);e.write(`❌ ${l.red(t)} ${l.red(n.join(`, `))}\n`)}}return{exitCode:+!d.every(({exitCode:e})=>e===0),report:s===`json`?le(f,p):void 0}}async function Ee(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.
|
|
5
|
+
`),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=T(r,c);t.writeJSONSync(l,i,{spaces:` `}),await N(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 N(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=t.readJSONSync(s),i=s.endsWith(`.vscode/tasks.json`)?fe(r,n):T(r,n);return t.writeJSONSync(s,i,{spaces:` `}),await N(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await N(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await N(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function De(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e;me();let p=I(s,o);p.pipe(O()===`json`?process.stderr: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?W(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=U(e.skip),{exitCode:i}=await K(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return Ee(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=G(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?W(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=U(e.skip),i=O(),{exitCode:a,report:o}=await K(p,t,[],await R(r.commands),f,l,n,i);o!==void 0&&process.stdout.write(`${JSON.stringify(o,void 0,` `)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=G(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?W(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=U(e.skip),i=O(),{exitCode:a,report:o}=await K(p,n,[],await R(t.commands),void 0,void 0,r,i);o!==void 0&&process.stdout.write(`${JSON.stringify(o,void 0,` `)}\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?W(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=U(e.skip),{exitCode:a}=await K(p,n,[],await R(i.commands),f,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(ie),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const q={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.`},Oe=[/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],ke=[`node_modules/**`,`test/**`];function Ae(e){let t=e;for(let e of Oe)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/gv,`X`));return t}const je=/(\d{4})\s*-\s*(\d{4})/v,Me=/(\d{4})/v;function Ne(e,t){let n=Ae(e),r=je,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=Me,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 J(e){let t=new Date().getFullYear(),n=await te([`**/license.txt`,`**/license`,...ke.map(e=>`!${e}`)],{caseSensitiveMatch:!1,cwd:A(),followSymbolicLinks:!1,gitignore:!0}),r=[];for(let i of n)try{let n=await v.readFile(i,`utf8`),a=Ne(n,t);a!==n&&(r.push(i),e&&await v.writeFile(i,a,`utf8`))}catch(e){console.error(`Failed to process ${i}:`,e)}return r}async function Y(e,t=!1){let n=await J(t);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} license ${L(`file`,n.length)} with outdated copyright year:\n`);for(let t of n)e.write(` - ${t}\n`);return+!t}return 0}async function Pe(e){return Y(e,!1)}async function Fe(){let e=await J(!1);return{diagnostics:e.map(e=>({file:x(e,A()),message:`License file has an outdated copyright year`,severity:`error`,tool:`copyright-year`})),exitCode:+(e.length>0),unparsed:[]}}async function Ie(e){return Y(e,!0)}const X=`pnpm-lock.yaml`;function Le(e){let n=j(),i=r.resolve(e);for(;;){if(t.existsSync(r.join(i,X)))return i;if(i===n)break;let e=r.dirname(i);if(e===i)break;i=e}}function Re(e,t,n){let r=`${e}@${t}`;if(Object.hasOwn(n,r))return r;if(Object.hasOwn(n,t))return t}function ze(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 Z(e){let t=Le(e);if(t===void 0||t===``)throw Error(`${X} not found at or above "${e}".`);let n=r.join(t,X),i=await re(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=Re(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=ne(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=ze(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 Be(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function Ve(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 He(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 Q(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function Ue(e,n){let i=r.join(n,`package.json`);if(!t.existsSync(i))return{issues:[],packageJsonPath:i};let a=t.readJsonSync(i),o=a.engines?.node,s=Be(a),c=await Z(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}"${Q(u)}`),e){let e=a.engines??{};e.node=l,a.engines=e}}else{let t=y.minVersion(o),n=y.minVersion(l);t&&n&&y.lt(t,n)&&(p.push(`engines.node is "${o}" but production dependencies require at least "${l}"${Q(u)}`),e&&(a.engines.node=l))}let m=(()=>{if(l!==void 0&&l!==``&&o!==void 0&&o!==``){let e=y.minVersion(l),t=y.minVersion(o);if(e&&t)return y.gt(e,t)?l:o}return l??o})(),h=m!==void 0&&m!==``?y.minVersion(m):void 0,g=d!==void 0&&d!==``?y.minVersion(d):void 0,_=g&&h&&y.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}"${Q(f)}`),e&&Ve(a,d);else{let t=y.minVersion(s);t&&y.lt(t,g)&&(p.push(`devEngines.runtime.version for node is "${s}" but all dependencies require at least "${d}"${Q(f)}`),e&&Ve(a,d))}else if(s!==void 0){let t=y.minVersion(s);t&&h&&y.lte(t,h)&&(p.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),e&&He(a))}return e&&p.length>0&&(t.writeJsonSync(i,a,{spaces:` `}),await N(i)),{issues:p,packageJsonPath:i}}async function $(e,t){let n=k(),r=0;for(let i of n){let{issues:n,packageJsonPath:a}=await Ue(t,i);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} Node.js version ${L(`issue`,n.length)} in ${a}:\n`);for(let t of n)e.write(` - ${t}\n`);t||(r=1)}}return r}async function We(){let e=k(),t=[];for(let n of e){let{issues:e,packageJsonPath:r}=await Ue(!1,n);for(let n of e)t.push({file:x(r,process.cwd()),message:n,severity:`error`,tool:`node-version`})}return{diagnostics:t,exitCode:+(t.length>0),unparsed:[]}}async function Ge(e){let t=w(await Z(A())).split(`
|
|
6
|
+
`);for(let n of t)e.write(`${n}\n`);return 0}async function Ke(e){return $(e,!1)}async function qe(e){return $(e,!0)}await De({commands:{fix:{commands:[{execute:Ie,name:`copyright-year`},{execute:qe,name:`node-version`}],description:`Fix common issues like outdated copyright years in license files. ${q.packageRun} ${q.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{collect:Fe,execute:Pe,name:`copyright-year`},{collect:We,execute:Ke,name:`node-version`}],description:`Check the repo for common issues. ${q.packageRun} ${q.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:Ge,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{};
|
|
@@ -25,12 +25,12 @@ jobs:
|
|
|
25
25
|
|
|
26
26
|
steps:
|
|
27
27
|
- name: Checkout
|
|
28
|
-
uses: actions/checkout@
|
|
28
|
+
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
|
29
29
|
with:
|
|
30
30
|
persist-credentials: false
|
|
31
31
|
|
|
32
32
|
- name: Install pnpm
|
|
33
|
-
uses: pnpm/action-setup@
|
|
33
|
+
uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
|
|
34
34
|
|
|
35
35
|
- name: Setup Node.js
|
|
36
36
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
|
@@ -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.2.0",
|
|
4
4
|
"description": "Repository configuration and GitHub workflows for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@pinojs/json-colorizer": "^4.0.0",
|
|
36
|
-
"@pnpm/lockfile.fs": "^1100.1.
|
|
36
|
+
"@pnpm/lockfile.fs": "^1100.1.8",
|
|
37
37
|
"cosmiconfig": "^9.0.2",
|
|
38
38
|
"cosmiconfig-typescript-loader": "^6.3.0",
|
|
39
39
|
"decircular": "^1.0.0",
|
|
@@ -41,11 +41,11 @@
|
|
|
41
41
|
"execa": "^9.6.1",
|
|
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",
|
|
48
|
-
"prettier": "^3.9.
|
|
48
|
+
"prettier": "^3.9.5",
|
|
49
49
|
"semver": "^7.8.5",
|
|
50
50
|
"yargs": "^18.0.0"
|
|
51
51
|
},
|
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,11 @@ 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
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
179
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
178
180
|
|
|
179
181
|
#### Subcommand: `ksc-repo fix`
|
|
180
182
|
|
|
@@ -186,10 +188,11 @@ Usage:
|
|
|
186
188
|
ksc-repo fix
|
|
187
189
|
```
|
|
188
190
|
|
|
189
|
-
| Option | Description
|
|
190
|
-
| ------------------- |
|
|
191
|
-
| `--
|
|
192
|
-
| `--
|
|
191
|
+
| Option | Description | Type | Default |
|
|
192
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
193
|
+
| `--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"` |
|
|
194
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
195
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
193
196
|
|
|
194
197
|
#### Subcommand: `ksc-repo print-config`
|
|
195
198
|
|
|
@@ -208,6 +211,26 @@ ksc-repo print-config
|
|
|
208
211
|
|
|
209
212
|
<!-- /cli-help -->
|
|
210
213
|
|
|
214
|
+
### VS Code tasks
|
|
215
|
+
|
|
216
|
+
`ksc-repo init` adds a `.vscode/tasks.json` with two tasks:
|
|
217
|
+
|
|
218
|
+
- **`ksc-repo lint`** runs `ksc-repo lint --format machine` across the whole project
|
|
219
|
+
- **`ksc-repo fix`** runs `ksc-repo fix --format machine`, applying auto-fixes and reporting whatever couldn't be fixed
|
|
220
|
+
|
|
221
|
+
If you're using the complete [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) package, you'd more likely want to run:
|
|
222
|
+
|
|
223
|
+
- **`ksc lint`** runs `ksc lint --format machine`, which runs all `ksc lint` tools across the whole project
|
|
224
|
+
- **`ksc fix`** runs `ksc fix --format machine`, which applies all `ksc fix` auto-fixes and reports anything unfixable
|
|
225
|
+
|
|
226
|
+
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
227
|
+
|
|
228
|
+
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.
|
|
229
|
+
|
|
230
|
+
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.
|
|
231
|
+
|
|
232
|
+
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.
|
|
233
|
+
|
|
211
234
|
<!-- license -->
|
|
212
235
|
|
|
213
236
|
## License
|