@kitschpatrol/repo-config 8.11.0 → 8.12.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 +1 -1
- package/init/.github/workflows/update-dependencies.yml +109 -0
- package/package.json +1 -1
- package/readme.md +35 -2
package/bin/cli.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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{availableParallelism as r}from"node:os";import i from"node:path";import{PassThrough as a,Transform as o}from"node:stream";import{packageUp as s,packageUpSync as c}from"package-up";import l from"yargs";import{hideBin as u}from"yargs/helpers";import d from"picocolors";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 v}from"find-workspaces";import y from"node:fs/promises";import{globby as b}from"globby";import x,{gt as S,minVersion as ee}from"semver";import{readWantedLockfile as te}from"@pnpm/lockfile.fs";var ne=`8.
|
|
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{packageUp as s,packageUpSync as c}from"package-up";import l from"yargs";import{hideBin as u}from"yargs/helpers";import d from"picocolors";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 v}from"find-workspaces";import y from"node:fs/promises";import{globby as b}from"globby";import x,{gt as S,minVersion as ee}from"semver";import{readWantedLockfile as te}from"@pnpm/lockfile.fs";var ne=`8.12.0`;const C=[`json`,`machine`,`native`],re=C;function w(e){return typeof e==`string`&&C.includes(e)}function T(){let e=process.env.KSC_FORMAT;return w(e)?e:`native`}function ie(){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)),w(r)&&(process.env.KSC_FORMAT=r)}}function ae(){let{env:e}=process;return e.NO_COLOR!==void 0&&e.NO_COLOR!==``?!1:e.FORCE_COLOR===void 0?e.TERM!==`dumb`&&void 0:e.FORCE_COLOR!==`0`&&e.FORCE_COLOR!==`false`}function E(e,{ciColor:t=!0}={}){return ae()??(e.isTTY===!0||t&&!!process.env.CI)}function D(){return T()===`json`?process.stderr:process.stdout}function O(){return T()===`machine`?d.createColors(!1):d.createColors(E(D()))}function k(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 oe(e,t){let n=i.isAbsolute(e)?e:i.resolve(t,e),r=i.relative(process.cwd(),n);return r===``?`.`:r}const se=/\s*\n\s*/gv,ce=/\r?\n/v;function le(e){let t=e.message.replaceAll(se,` `),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 ue(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 de(e,t){let n=t.toSorted(ue);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 A(e){return f(e).split(ce).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function fe(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function j(e){return E(process.stdout,{ciColor:!1})?me(e):pe(e)}function pe(e){return g(m(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}})}function me(e){return p(pe(e),{colors:{BRACKET:`gray`}})}const he=(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:he}){return h(e,t,n)}function N(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function ge(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 _e(e,t){return e.startsWith(t+i.sep)}function P(){let e=F(),t=/* @__PURE__ */ new Set([e]),n=_();if(n!==null)for(let r of n){let n=i.resolve(r.location);_e(n,e)&&t.add(n)}return[...t]}function F(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return i.dirname(e)}function I(){let e=v();return e===null?F():i.resolve(e.location)}function ve(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 y.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function L(e){try{await ye(e,await y.readFile(e,`utf8`))}catch{}}const be=/\r?\n/v;function xe(e){let t=``,n=t=>t.filter(t=>{let n=f(t);return n.trim()!==``&&!e(n)}).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(be);t=a.pop()??``,i(void 0,n(a))}})}function R(e,t){let n=T()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:O()[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(be);i=r.pop()??``,n(void 0,a(r))}})}async function Se(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>{t.push(e)}),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function z(e,t){return t===1?e:e+`s`}async function B(e){return typeof e==`function`?e():e}async function Ce(e,t,n,r,i){let a;if(r.logPrefix===void 0)a=e;else{let t=R(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(O().bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`)+`
|
|
3
3
|
`);try{return await r.execute(a,t,n)}catch(e){return console.error(String(e)),1}}function V(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 we(t,n,r,i,o,s){let c=1,l;if(i.logPrefix===void 0)l=t;else{let e=R(i.logPrefix,i.logColor);e.pipe(t),l=e}let u=V(i,n,r,i.optionFlags,o),d=ve(i.cwdOverride);s&&l.write(`Running: "${i.name} ${u.join(` `)}"\n`);let f=i.prettyJsonOutput?new a:void 0,p=f??l,m=k(T()===`native`&&i.prettyJsonOutput!==!0&&E(D()));try{let t=e(i.name,u,{cwd:d,env:m,preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let e=xe(i.outputFilter),n=xe(i.outputFilter);t.stdout.pipe(e).pipe(p,{end:!1}),t.stderr.pipe(n).pipe(p,{end:!1})}else t.stdout.pipe(p,{end:!1}),t.stderr.pipe(p,{end:!1});let n=await t;if(f!==void 0){f.end();let e=await Se(f),t=j(JSON.parse(e)).split(`
|
|
4
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),fe(e)&&(c=typeof e.exitCode==`number`?e.exitCode:1)}return c}function H(e){return`execute`in e}function U(e){return`kind`in e}async function W(t,n,r,i,a){let o=V(r,t,n,r.collect?.optionFlags??r.optionFlags,i),s=ve(r.cwdOverride);try{let t=e(r.name,o,{cwd:s,env:k(!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:fe(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function Te(e){return typeof e==`object`&&!!e&&`version`in e&&e.version===1&&`diagnostics`in e&&Array.isArray(e.diagnostics)&&`success`in e&&typeof e.success==`boolean`&&`tools`in e&&Array.isArray(e.tools)}function G(e,t){return e===0&&t.some(({severity:e})=>e===`error`)?1:e}async function Ee(e,t,n,r,i){let o=Date.now(),s=()=>Date.now()-o;if(H(r)){if(r.collect!==void 0)try{let e=await r.collect(t,n),i=G(e.exitCode,e.diagnostics);return{diagnostics:e.diagnostics,exitCode:i,tools:[{durationMs:s(),exitCode:i,name:r.name,unparsed:e.unparsed}]}}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:A(e)}]}}if(U(r))throw Error(`Command groups must be expanded before collection`);if(r.outputFormatAware){let a=await W(t,n,r,i,e);try{let e=JSON.parse(a.stdout);if(!Te(e))throw Error(`Child output is not a lint report`);return{diagnostics:e.diagnostics,exitCode:a.exitCode===0&&e.success&&e.diagnostics.every(({severity:e})=>e!==`error`)?0:1,tools:e.tools}}catch{return{diagnostics:[],exitCode:a.exitCode,tools:[{durationMs:s(),exitCode:a.exitCode,name:r.name,unparsed:A(a.stdout)}]}}}let c=await W(t,n,r,i);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(c),n=G(c.exitCode,e);return{diagnostics:e,exitCode:n,tools:[{durationMs:s(),exitCode:n,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:s(),exitCode:c.exitCode,name:r.name,unparsed:[...A(c.stdout),...A(c.stderr),String(e)]}]}}return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:s(),exitCode:c.exitCode,name:r.name,unparsed:[...A(c.stdout),...A(c.stderr)]}]}}const De=/^ksc-/v;function K(e){return e.replace(De,``)}function q(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>K(e.trim()))}function J(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function Oe(e){return e.option(`format`,{choices:re,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 ke(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 Ae(e,t){return t===`native`||t===`machine`&&!H(e)&&!U(e)&&e.outputFormatAware===!0}function je(e,t){for(let n of t.diagnostics)e.write(`${le(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function Me(){return Math.min(4,r())}var Ne=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 Pe(e){let n=e.cache??!1,r=e.concurrency??Me();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 Ne(r)}}const Fe=/[*?\[\]\{\}]/v;function Y(e,t){return t===void 0?e:e.filter(e=>Fe.test(e)||n.statSync(e,{throwIfNoEntry:!1})?.isDirectory()===!0||t.includes(i.extname(e).slice(1).toLowerCase()))}function Ie(e,t){return e.length===0||Y(e,t).length>0}function Le(e,t){return e.positionalArgumentMode===`none`?[]:t.length>0?Y(t,e.positionalArgumentExtensions):e.positionalArgumentDefault===void 0?[]:[e.positionalArgumentDefault]}function Re(e,t){if(t.logPrefix===void 0)return e;let n=R(t.logPrefix,t.logColor);return n.pipe(e),n}function ze(e){return U(e)?`${e.name} ${e.subcommand}`:!H(e)&&e.subcommands!==void 0?[e.name,...e.subcommands].join(` `):e.name}async function Be(e,t){if(U(e)){let n=Re(t.logStream,e);try{let r=await B(e.commands);if(t.nativeVerbose){let n=[e.subcommand,...t.positionalArguments].join(` `),i=e.showResolvedCommands?` (${r.map(e=>ze(e)).join(`, `)})`:``;t.logStream.write(`Running: "${e.name} ${n}"${i}\n`)}let i=await Ve(r,{...t,logStream:n,nativeVerbose:e.verbose,positionalArguments:Le(e,t.positionalArguments)},e.parallel===!0);return{diagnostics:i.flatMap(({diagnostics:e})=>e),exitCode:+!i.every(({exitCode:e})=>e===0),machineOutcomes:i.flatMap(({machineOutcomes:e})=>e),name:e.name,tools:i.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(Ae(e,t.format))return{diagnostics:[],exitCode:await(H(e)?Ce(t.logStream,t.positionalArguments,t.optionFlags,e,t.nativeVerbose):we(t.logStream,t.positionalArguments,t.optionFlags,e,t.cache,t.nativeVerbose)),machineOutcomes:[],name:e.name,tools:[]};let n=await Ee(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 Ve(e,t,n){if(!n||t.scheduler.concurrency===1){let n=[];for(let r of e)n.push(await Be(r,t));return n}await Promise.resolve();let r=/* @__PURE__ */ 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 Be(e,t)})));for(let{index:e,outcome:t}of a)i[e]=t}return i.filter(e=>e!==void 0)}function He(e,t,n,r,i){let a=[],o=[],s=Ie(r,i);for(let e of t){let t=!U(e)||Ie(r,e.positionalArgumentExtensions);!s||!t||n.includes(K(e.name))?o.push(e):a.push(e)}if(n.length>0){let r=new Set(o.map(e=>K(e.name))),i=n.filter(e=>!r.has(e));if(i.length>0){let n=t.map(e=>K(e.name)).join(`, `);e.write(`⚠️ ${O().yellow(`Unrecognized --skip ${z(`value`,i.length)}: ${i.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:a,skippedCommands:o}}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}=He(e,r,o??[],t,c.positionalArgumentExtensions),f=l===`native`&&i,{cache:p,scheduler:m}=await Pe(c),h=await Ve(u,{cache:p,format:l,logStream:e,nativeVerbose:f,optionFlags:n,positionalArguments:Y(t,c.positionalArgumentExtensions),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)je(e,n);let y=r.length,b=O();if(l===`native`&&d.length>0){let t=d.map(({name:e})=>e),n=b.bold(`${t.length} / ${y} ${z(`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} ${z(`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} ${z(`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`?de(_,v):void 0}}async function Ue(e){let t=await s({cwd:e});return t===void 0?void 0:i.join(i.dirname(t),`init`)}async function We(e,r,a,o){let c=await s();if(c===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let l=await Ue(import.meta.dirname);if(l===void 0)return e.write(`Error: Could not locate the package containing this CLI.
|
|
5
5
|
`),1;let u=i.dirname(c),d=(r===`file`||r===`package`)&&a!==void 0&&o!==void 0;try{if(d){let n=Object.keys(o)[0],i=t.readJsonSync(c);if(r===`package`){e.write(`Merging: \nPackage config key "${n}" → "${u}" (Because --location is set to "package")\n`);let r=M(i,o);t.writeJSONSync(c,r,{spaces:` `}),await L(c)}else n!==void 0&&Object.keys(i).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${u}" (Because --location is set to "file")\n`),delete i[n],t.writeJSONSync(c,i,{spaces:` `}),await L(c))}if(!await t.pathExists(l))return 0;if((await t.readdir(l)).length===0)return e.write(`Source directory "${l}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${l}" → "${u}"\n`),await t.copy(l,u,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(d&&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`)?ge(r,n):M(r,n);return t.writeJSONSync(s,i,{spaces:` `}),await L(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await L(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await L(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Ge(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:d,verbose:f}=e;ie();let p=R(s,o);p.pipe(D());let m=l(u(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 d?J(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=q(e.skip),{exitCode:i}=await X(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return We(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=ke(Oe(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 d?J(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=q(e.skip),i=T(),{exitCode:a,report:o}=await X(p,t,[],await B(r.commands),f,d,n,{cache:e.cache,format:i,parallel:r.parallel,positionalArgumentExtensions:r.positionalArgumentExtensions});o!==void 0&&process.stdout.write(`${j(o)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=ke(Oe(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 d?J(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=q(e.skip),i=T(),{exitCode:a,report:o}=await X(p,n,[],await B(t.commands),void 0,void 0,r,{cache:e.cache,format:i,parallel:t.parallel,positionalArgumentExtensions:t.positionalArgumentExtensions});o!==void 0&&process.stdout.write(`${j(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 d?J(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=q(e.skip),{exitCode:a}=await X(p,n,[],await B(i.commands),f,d,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 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.`},Ke=[/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],qe=[`node_modules/**`,`test/**`];function Je(e){let t=e;for(let e of Ke)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/gv,`X`));return t}const Ye=/(\d{4})\s*-\s*(\d{4})/v,Xe=/(\d{4})/v;function Ze(e,t){let n=Je(e),r=Ye,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=Xe,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=(/* @__PURE__ */ new Date()).getFullYear(),n=[`**/license.txt`,`**/license`,...qe.map(e=>`!${e}`)],r=await b(n,{caseSensitiveMatch:!1,cwd:F(),followSymbolicLinks:!1,gitignore:!0}),i=[];for(let n of r)try{let r=await y.readFile(n,`utf8`),a=Ze(r,t);a!==r&&(i.push(n),e&&await y.writeFile(n,a,`utf8`))}catch(e){console.error(`Failed to process ${n}:`,e)}return i}async function $e(e,t=!1){let n=await Qe(t);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} license ${z(`file`,n.length)} with outdated copyright year:\n`);for(let t of n)e.write(` - ${t}\n`);return+!t}return 0}async function et(e){return $e(e,!1)}async function tt(){let e=await Qe(!1);return{diagnostics:e.map(e=>({file:oe(e,F()),message:`License file has an outdated copyright year`,severity:`error`,tool:`copyright-year`})),exitCode:+(e.length>0),unparsed:[]}}async function nt(e){return $e(e,!0)}const Q=`pnpm-lock.yaml`;function rt(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 it(e,t,n){let r=`${e}@${t}`;return Object.hasOwn(n,r)?r:Object.hasOwn(n,t)?t:void 0}function at(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 ot(e){let t=rt(e);if(t===void 0||t===``)throw Error(`${Q} not found at or above "${e}".`);let n=i.join(t,Q),r=await te(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=/* @__PURE__ */ new Set;function i(e,t){if(t.startsWith(`link:`))return;let o=it(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=ee(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===``)continue;let i=t?l:c;i[e]??=/* @__PURE__ */ new Set,i[e].add(n);let a=t?s:o;(a===void 0||a===``||S(e,a))&&(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=at(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 st(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function ct(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 lt(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 ut(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=st(a),c=await ot(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&&ct(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&&ct(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&<(a))}return e&&p.length>0&&(t.writeJsonSync(r,a,{spaces:` `}),await L(r)),{issues:p,packageJsonPath:r}}async function dt(e,t){let n=P(),r=0;for(let i of n){let{issues:n,packageJsonPath:a}=await ut(t,i);if(n.length!==0){e.write(`${t?`Fixed`:`Found`} ${n.length} Node.js version ${z(`issue`,n.length)} in ${a}:\n`);for(let t of n)e.write(` - ${t}\n`);t||(r=1)}}return r}async function ft(){let e=P(),t=[];for(let n of e){let{issues:e,packageJsonPath:r}=await ut(!1,n);for(let n of e)t.push({file:oe(r,process.cwd()),message:n,severity:`error`,tool:`node-version`})}return{diagnostics:t,exitCode:+(t.length>0),unparsed:[]}}async function pt(e){let t=j(await ot(F())).split(`
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
name: Update Dependencies
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch: {}
|
|
5
|
+
schedule:
|
|
6
|
+
# Sunday night in the Americas (Monday 03:00 UTC)
|
|
7
|
+
- cron: '0 3 * * 1'
|
|
8
|
+
|
|
9
|
+
# Claude runs with the read-only GITHUB_TOKEN and can't push or open pull
|
|
10
|
+
# requests. The pull request step uses PERSONAL_ACCESS_TOKEN instead.
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
concurrency:
|
|
15
|
+
group: ${{ github.workflow }}
|
|
16
|
+
cancel-in-progress: false
|
|
17
|
+
|
|
18
|
+
jobs:
|
|
19
|
+
update:
|
|
20
|
+
name: Update Dependencies
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
timeout-minutes: 120
|
|
23
|
+
|
|
24
|
+
steps:
|
|
25
|
+
- name: Check secrets
|
|
26
|
+
env:
|
|
27
|
+
HAS_CLAUDE_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN != '' }}
|
|
28
|
+
HAS_PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN != '' }}
|
|
29
|
+
run: |
|
|
30
|
+
[[ $HAS_CLAUDE_TOKEN == 'true' ]] || echo '::error::Missing CLAUDE_CODE_OAUTH_TOKEN secret, generate one with claude setup-token'
|
|
31
|
+
[[ $HAS_PERSONAL_ACCESS_TOKEN == 'true' ]] || echo '::error::Missing PERSONAL_ACCESS_TOKEN secret, it needs contents and pull requests write access'
|
|
32
|
+
[[ $HAS_CLAUDE_TOKEN == 'true' && $HAS_PERSONAL_ACCESS_TOKEN == 'true' ]]
|
|
33
|
+
|
|
34
|
+
- name: Checkout
|
|
35
|
+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
36
|
+
with:
|
|
37
|
+
persist-credentials: false
|
|
38
|
+
|
|
39
|
+
- name: Install pnpm
|
|
40
|
+
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
|
|
41
|
+
|
|
42
|
+
- name: Setup Node.js
|
|
43
|
+
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
|
44
|
+
with:
|
|
45
|
+
node-version: 24
|
|
46
|
+
cache: 'pnpm'
|
|
47
|
+
|
|
48
|
+
- name: Install dependencies
|
|
49
|
+
run: pnpm ci
|
|
50
|
+
|
|
51
|
+
- name: Sync skills
|
|
52
|
+
run: |
|
|
53
|
+
# Keep the synced skills out of the pull request
|
|
54
|
+
mkdir -p .git/info
|
|
55
|
+
printf '%s\n' .agents/ .claude/ skills-lock.json >> .git/info/exclude
|
|
56
|
+
pnpm dlx skills@1.7.0 experimental_sync --yes --agent claude-code
|
|
57
|
+
|
|
58
|
+
- name: Check for ksc-update skill
|
|
59
|
+
run: |
|
|
60
|
+
if [[ ! -f .claude/skills/ksc-update/SKILL.md ]]; then
|
|
61
|
+
echo '::error::No ksc-update skill found, it ships with @kitschpatrol/shared-config'
|
|
62
|
+
exit 1
|
|
63
|
+
fi
|
|
64
|
+
|
|
65
|
+
- name: Run ksc-update
|
|
66
|
+
uses: anthropics/claude-code-action@6c690188da61cf16ee7debb28383ba67f02abb4c # v1.0.242
|
|
67
|
+
with:
|
|
68
|
+
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
69
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
70
|
+
prompt: |
|
|
71
|
+
Run the `ksc-update` skill in this repository and follow it through to the end, including its final report.
|
|
72
|
+
|
|
73
|
+
This is an unattended CI run: never ask questions or wait for answers. Apply what the skill's policy allows without approval, defer the rest, and list deferred decisions in the report.
|
|
74
|
+
|
|
75
|
+
Do not commit, push, or use the GitHub API. Leave all changes in the working tree; a later workflow step commits them and opens a pull request.
|
|
76
|
+
|
|
77
|
+
When you are done, write the skill's final report as Markdown to `${{ runner.temp }}/ksc-update-report.md` with the Write tool. It becomes the pull request description, so start with a short summary of what changed and the release recommendation, then the full report. If nothing could be updated, say so.
|
|
78
|
+
claude_args: >-
|
|
79
|
+
--add-dir ${{ runner.temp }}
|
|
80
|
+
--allowedTools "Bash,Read,Edit,Write,Glob,Grep,Skill,Agent,TodoWrite,WebFetch,WebSearch"
|
|
81
|
+
|
|
82
|
+
- name: Build pull request body
|
|
83
|
+
env:
|
|
84
|
+
REPORT: ${{ runner.temp }}/ksc-update-report.md
|
|
85
|
+
BODY: ${{ runner.temp }}/pull-request-body.md
|
|
86
|
+
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
|
87
|
+
run: |
|
|
88
|
+
if [[ -s "$REPORT" ]]; then
|
|
89
|
+
cat "$REPORT" >> "$GITHUB_STEP_SUMMARY"
|
|
90
|
+
# Pull request bodies are limited to 65536 characters
|
|
91
|
+
head -c 60000 "$REPORT" > "$BODY"
|
|
92
|
+
if [[ $(wc -c < "$REPORT") -gt 60000 ]]; then
|
|
93
|
+
printf '\n\n_Report truncated, the full report is in the workflow run summary._\n' >> "$BODY"
|
|
94
|
+
fi
|
|
95
|
+
else
|
|
96
|
+
echo "::warning::No report found at $REPORT"
|
|
97
|
+
echo 'The ksc-update skill did not write a report. Check the workflow run for details.' > "$BODY"
|
|
98
|
+
fi
|
|
99
|
+
printf '\n\n---\n\nOpened by the [Update Dependencies workflow](%s) using the ksc-update skill.\n' "$RUN_URL" >> "$BODY"
|
|
100
|
+
|
|
101
|
+
- name: Open pull request
|
|
102
|
+
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
|
|
103
|
+
with:
|
|
104
|
+
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
|
105
|
+
branch: update-dependencies
|
|
106
|
+
delete-branch: true
|
|
107
|
+
commit-message: Update dependencies.
|
|
108
|
+
title: Update dependencies
|
|
109
|
+
body-path: ${{ runner.temp }}/pull-request-body.md
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -33,9 +33,11 @@ This includes the following:
|
|
|
33
33
|
- `.vscode` extension recommendations (additional settings and recommendations come from other `@kitschpatrol/shared-config` packages)
|
|
34
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.
|
|
35
35
|
- `.github` folder with workflows:
|
|
36
|
-
- `github-release.yml` Automates turning
|
|
36
|
+
- `github-release.yml` Automates turning vX.X.X tags on main into GitHub releases with changelogs
|
|
37
37
|
- `set-github-metadata.yml` Populates GitHub repo metadata from package.json
|
|
38
38
|
- `ci.yml` Basic cross-platform CI action
|
|
39
|
+
- `check-links.yml` Checks links in Markdown files and on the project's homepage weekly
|
|
40
|
+
- `update-dependencies.yml` Runs the `ksc-update` skill with Claude Code weekly or on demand, then opens a pull request with the changes and the skill's report (see [Dependency updates](#dependency-updates))
|
|
39
41
|
|
|
40
42
|
In order to work around some hoisting issues related to plugin resolution in the other `@kitschpatrol/shared-config` packages, it's critical that it is applied _before_ any other `@kitschpatrol/shared-config` packages are installed.
|
|
41
43
|
|
|
@@ -94,6 +96,9 @@ If you want releases to come from your account instead of `github_actions`, then
|
|
|
94
96
|
| Administration | Read and write |
|
|
95
97
|
| Contents | Read and write |
|
|
96
98
|
| Metadata | Read-only |
|
|
99
|
+
| Pull requests | Read and write |
|
|
100
|
+
|
|
101
|
+
_Pull requests_ access is only needed by the dependency update workflow described below.
|
|
97
102
|
|
|
98
103
|
2. Add the token as a secret to your new GitHub repository.
|
|
99
104
|
|
|
@@ -105,6 +110,34 @@ If you want releases to come from your account instead of `github_actions`, then
|
|
|
105
110
|
gh secret set PERSONAL_ACCESS_TOKEN --app actions --body $(op read 'op://Personal/GitHub Mika/PERSONAL_ACCESS_TOKEN')
|
|
106
111
|
```
|
|
107
112
|
|
|
113
|
+
#### Dependency updates
|
|
114
|
+
|
|
115
|
+
The `update-dependencies.yml` workflow runs the [`ksc-update`](https://github.com/kitschpatrol/shared-config/blob/main/packages/shared-config/skills/ksc-update/SKILL.md) skill through [Claude Code](https://code.claude.com/docs/en/github-actions) every Sunday night, or on demand from the repository's _Actions_ tab, then opens a pull request with the changes and the skill's report. The skill ships with `@kitschpatrol/shared-config` and is synced from `node_modules` before each run with the [skills CLI](https://github.com/vercel-labs/skills). The workflow fails if no `ksc-update` skill is found.
|
|
116
|
+
|
|
117
|
+
Claude runs with the read-only `GITHUB_TOKEN` and can't push, so the workflow needs two secrets:
|
|
118
|
+
|
|
119
|
+
1. `CLAUDE_CODE_OAUTH_TOKEN`, a long-lived token for your Claude subscription. Generate it with the Claude Code CLI, which opens a browser to authorize and then prints the token:
|
|
120
|
+
|
|
121
|
+
```sh
|
|
122
|
+
claude setup-token
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Then add it to the repository. You'll be prompted to paste the token:
|
|
126
|
+
|
|
127
|
+
```sh
|
|
128
|
+
gh secret set CLAUDE_CODE_OAUTH_TOKEN --app actions
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Or, with a credential manager:
|
|
132
|
+
|
|
133
|
+
```sh
|
|
134
|
+
gh secret set CLAUDE_CODE_OAUTH_TOKEN --app actions --body $(op read 'op://Personal/Claude Code OAuth Token/credential')
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
2. `PERSONAL_ACCESS_TOKEN` as described above, including _Pull requests_ access. It's used only to push the branch and open the pull request, which also lets the pull request trigger your CI workflows.
|
|
138
|
+
|
|
139
|
+
GitHub disables scheduled workflows after 60 days without repository activity, and only runs them from the default branch.
|
|
140
|
+
|
|
108
141
|
### GitHub Actions
|
|
109
142
|
|
|
110
143
|
Note: Action dependencies have been forked.
|
|
@@ -119,7 +152,7 @@ Note: Action dependencies have been forked.
|
|
|
119
152
|
|
|
120
153
|
### CLI
|
|
121
154
|
|
|
122
|
-
<!-- cli-help -->
|
|
155
|
+
<!-- cli-help({ heading: false, headingLevel: 3 }) -->
|
|
123
156
|
|
|
124
157
|
#### Command: `ksc-repo`
|
|
125
158
|
|