@kitschpatrol/repo-config 6.0.0 → 6.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bin/cli.js
CHANGED
|
@@ -1,5 +1,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 r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"@pinojs/json-colorizer";import p from"decircular";import m from"deepmerge";import h from"json-stringify-pretty-compact";import{findWorkspacesRoot as
|
|
3
|
-
`);for(let e of t)c.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${a.name} failed with error:`),console.error(e),
|
|
4
|
-
`),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0];if(i===`package`){let r=t.readJsonSync(l);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=
|
|
5
|
-
`);for(let n of t)e.write(`${n}\n`);return 0}async function Q(e){return X(e,!1)}async function $(e){return X(e,!0)}await
|
|
2
|
+
import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"@pinojs/json-colorizer";import p from"decircular";import m from"deepmerge";import h from"json-stringify-pretty-compact";import{findWorkspaces as g,findWorkspacesRoot as _}from"find-workspaces";import v from"node:fs/promises";import{globby as y}from"globby";import b,{gt as x,minVersion as S}from"semver";import{readWantedLockfile as C}from"@pnpm/lockfile.fs";var ee=`6.0.2`;function w(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function T(e){return f(h(p(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const E=(e,t,n)=>{let r=[...e];for(let[i,a]of t.entries())r[i]===void 0?r[i]=n.cloneUnlessOtherwiseSpecified(a,n):n.isMergeableObject(a)?r[i]=D(e[i],a,n):e.includes(a)||r.push(a);return r};function D(e,t,n={arrayMerge:E}){return m(e,t,n)}function te(e,t){return e.startsWith(t+r.sep)}function ne(){let e=O(),t=new Set([e]),n=g();if(n!==null)for(let r of n)te(r.location,e)&&t.add(r.location);return[...t]}function O(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return r.dirname(e)}function k(){let e=_();return e===null?O():e.location}function A(e){if(e===`workspace-root`)return k();if(e===`package-dir`)return O();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function j(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await v.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function M(e){try{await j(e,await v.readFile(e,`utf8`))}catch{}}function N(e,t){return new a({transform(n,r,i){let a=n.toString().split(/\r?\n/).filter(e=>e.trim().length>0).map(n=>`${e?t===void 0?e:l[t](e):``} ${n}\n`).join(``);this.push(a),i()}})}async function re(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>t.push(e)),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function P(e,t){return t===1?e:e+`s`}async function ie(e,t,n,r,i){let a=1,o;if(r.logPrefix===void 0)o=e;else{let t=N(r.logPrefix,r.logColor);t.pipe(e),o=t}i&&o.write(l.bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`));try{a=await r.execute(o,t,n)}catch(e){console.error(String(e)),a=1}return a}async function ae(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=N(a.logPrefix,a.logColor);e.pipe(t),c=e}let l=a.subcommands??[],u=[...a.receivePositionalArguments?n:[],...a.positionalArguments??[]],d=[...a.receiveOptionFlags?r:[],...a.optionFlags??[]],f=[...l,...d,...u],p=A(a.cwdOverride);o&&c.write(`Running: "${a.name} ${f.join(` `)}"`);let m=a.prettyJsonOutput?new i:c;try{let t=e(a.name,f,{cwd:p,env:{...process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}},preferLocal:!0,reject:!1,stdin:`inherit`});if(t.stdout.pipe(m,{end:!1}),t.stderr.pipe(m,{end:!1}),await t,a.prettyJsonOutput){m.end();let e=await re(m),t=T(JSON.parse(e)).split(`
|
|
3
|
+
`);for(let e of t)c.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${a.name} failed with error:`),console.error(e),w(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function F(e){return`execute`in e}async function I(e,t,n,r,i,a){let o=[];for(let a of r){let r=await(F(a)?ie(e,t,n,a,i):ae(e,t,n,a,i));o.push({exitCode:r,name:a.name})}if(a){let t=o.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=o.filter(({exitCode:e})=>e!==0).map(({name:e})=>e),r=o.length;t.length>0&&e.write(`✅ ${l.green(l.bold(`${t.length} / ${r} ${P(`Command`,t.length)} Succeeded:`))} ${l.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${l.red(l.bold(`${n.length} / ${r} ${P(`Command`,n.length)} Failed:`))} ${l.red(n.join(`, `))}\n`)}return o.every(({exitCode:e})=>e===0)?0:1}async function L(e,i,a,c){let l=await s();if(l===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let u=await s({cwd:o(import.meta.url)});if(u===void 0)return e.write(`Error: The script being called was not in a package, weird.
|
|
4
|
+
`),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0];if(i===`package`){let r=t.readJsonSync(l);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=D(r,c);t.writeJSONSync(l,i,{spaces:` `}),await M(l)}else{let r=t.readJsonSync(l);Object.keys(r).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete r[n],t.writeJSONSync(l,r,{spaces:` `}),await M(l))}}if(!await t.pathExists(d))return 0;if((await t.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await t.copy(d,f,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(p&&i===`package`&&o.includes(a))return l?(e.write(`Deleting: \n"${o}" → "${s}" (Because --location is set to "package")\n`),t.removeSync(s)):e.write(`Skipping: \n"${o}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&r.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=D(t.readJSONSync(s),n);return t.writeJSONSync(s,r,{spaces:` `}),await M(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await M(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await M(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function R(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e,p=N(s,o);p.pipe(process.stdout);let m=u(d(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&m.command({builder(e){return n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`TK`,type:`string`}):e},command:`init`,describe:n.description??`Initialize by copying starter config files to your project root${n.locationOptionFlag?` or to your package.json file.`:`.`}`,async handler(e){let t=n.locationOptionFlag?e.location:void 0,r=await I(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return L(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]]);process.exit(r)}}),r!==void 0&&m.command({builder(e){return r.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...r.positionalArgumentDefault===void 0?{}:{default:r.positionalArgumentDefault},describe:`Files or glob pattern to lint.`,type:`string`})},command:r.positionalArgumentMode===`none`?`lint`:r.positionalArgumentMode===`optional`?`lint [files..]`:`lint <files..>`,describe:r.description,async handler(e){let t=await I(p,e.files??[],[],r.commands,f,l);process.exit(t)}}),t!==void 0&&m.command({builder(e){return t.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...t.positionalArgumentDefault===void 0?{}:{default:t.positionalArgumentDefault},describe:`Files or glob pattern to fix.`,type:`string`})},command:t.positionalArgumentMode===`none`?`fix`:t.positionalArgumentMode===`optional`?`fix [files..]`:`fix <files..>`,describe:t.description,async handler(e){let n=await I(p,e.files??[],[],t.commands);process.exit(n)}}),i!==void 0&&m.command({builder(e){return i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault===void 0?{}:{default:i.positionalArgumentDefault},describe:`File or glob pattern to TK.`,type:`string`})},command:i.positionalArgumentMode===`none`?`print-config`:i.positionalArgumentMode===`optional`?`print-config [file]`:`print-config <file>`,describe:i.description,async handler(e){let t=e.file??void 0,n=await I(p,t===void 0?[]:[t],[],i.commands,f,l);process.exit(n)}}),m.alias(`h`,`help`),m.version(ee),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.`};function B(e,t){let n=/(\d{4})\s*-\s*(\d{4})/,r=n.exec(e);if(r){let[,i,a]=r;if(Number.parseInt(a,10)!==t){let r=`${i}-${t}`;return e.replace(n,r)}return e}let i=/(\d{4})/,a=i.exec(e);if(a){let[,n]=a;if(Number.parseInt(n,10)!==t){let r=`${n}-${t}`;return e.replace(i,r)}return e}return e}async function V(e,t=!1){let n=new Date().getFullYear(),r=[],i=await y([`**/license.txt`,`**/license`,`!node_modules/**`],{caseSensitiveMatch:!1,cwd:O(),followSymbolicLinks:!1,gitignore:!0});for(let e of i)r.push(e);let a=[];for(let e of r)try{let r=await v.readFile(e,`utf8`),i=B(r,n);i!==r&&(a.push(e),t&&await v.writeFile(e,i,`utf8`))}catch(t){console.error(`Failed to process ${e}:`,t)}if(a.length>0){e.write(`${t?`Fixed`:`Found`} ${a.length} license ${P(`file`,a.length)} with outdated copyright year:\n`);for(let t of a)e.write(` - ${t}\n`);return t?0:1}return 0}async function H(e){return V(e,!1)}async function U(e){return V(e,!0)}const W=`pnpm-lock.yaml`;function G(e){let n=k(),i=r.resolve(e);for(;;){if(t.existsSync(r.join(i,W)))return i;if(i===n)break;let e=r.dirname(i);if(e===i)break;i=e}}function K(e,t,n){let r=`${e}@${t}`;if(r in n)return r;if(t in n)return t}async function q(e){let t=G(e);if(!t)throw Error(`${W} not found at or above "${e}".`);let n=r.join(t,W),i=await C(t,{ignoreIncompatible:!1});if(!i?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let a=i.packages??{},o,s,c={},l={};function u(e,t){let n,r=new Set;function i(e,t){if(t.startsWith(`link:`))return;let o=K(e,t,a);if(!o||r.has(o))return;r.add(o);let s=a[o],c=s?.engines?.node;if(c){let e=S(c)?.version;e&&(!n||x(e,n))&&(n=e)}if(s?.dependencies)for(let[e,t]of Object.entries(s.dependencies))typeof t==`string`&&i(e,t)}return i(e,t),n}function d(e,t){for(let[n,r]of Object.entries(e)){let e=u(n,typeof r==`string`?r:r.version);if(e){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:o;(!i||x(e,i))&&(t?s=e:o=e)}}}let f=r.relative(t,e)||`.`,p=i.importers[f];p&&(p.dependencies&&d(p.dependencies,!1),p.devDependencies&&d(p.devDependencies,!0));let m=o&&s?x(o,s)?`>=${o}`:`>=${s}`:o?`>=${o}`:s?`>=${s}`:void 0;return{dependencies:o?{topLevelCauses:[...c[o]],version:`>=${o}`}:void 0,devDependencies:s?{topLevelCauses:[...l[s]],version:`>=${s}`}:void 0,lockfile:n,version:m}}function oe(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 se(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 ce(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=oe(o),l=await q(i),u=l.dependencies?.version,d=l.version,f=l.dependencies?.topLevelCauses??[],p=l.devDependencies?.topLevelCauses??[],m=u??d,h=u?f:p,g=[];if(m!==void 0)if(s===void 0){if(g.push(`Missing engines.node — suggest setting to "${m}"${Y(h)}`),n){let e=o.engines??{};e.node=m,o.engines=e}}else{let e=b.minVersion(s),t=b.minVersion(m);e&&t&&b.lt(e,t)&&(g.push(`engines.node is "${s}" but dependencies require at least "${m}"${Y(h)}`),n&&(o.engines.node=m))}if(m!==void 0&&d!==void 0)if(m!==d)if(c===void 0)g.push(`devDependencies require a different Node.js minimum (${d}) than production (${m}) — suggest adding devEngines.runtime for node with version "${d}"${Y(p)}`),n&&J(o,d);else{let e=b.minVersion(c),t=b.minVersion(d);e&&t&&b.lt(e,t)&&(g.push(`devEngines.runtime.version for node is "${c}" but all dependencies require at least "${d}"${Y(p)}`),n&&J(o,d))}else c!==void 0&&(g.push(`devEngines.runtime.version for node is redundant (same minimum as engines.node) — suggest removing`),n&&se(o));if(g.length>0){e.write(`${n?`Fixed`:`Found`} ${g.length} Node.js version ${P(`issue`,g.length)} in ${a}:\n`);for(let t of g)e.write(` - ${t}\n`);return n?(t.writeJsonSync(a,o,{spaces:` `}),await M(a),0):1}return 0}async function X(e,t){let n=ne(),r=0;for(let i of n)await ce(e,t,i)!==0&&(r=1);return r}async function Z(e){let t=T(await q(O())).split(`
|
|
5
|
+
`);for(let n of t)e.write(`${n}\n`);return 0}async function Q(e){return X(e,!1)}async function $(e){return X(e,!0)}await R({commands:{fix:{commands:[{execute:U,name:H.name},{execute:$,name:$.name}],description:`Fix common issues like outdated copyright years in license files. ${z.packageRun} ${z.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{execute:H,name:U.name},{execute:Q,name:Q.name}],description:`Check the repo for common issues. ${z.packageRun} ${z.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{};
|
|
@@ -11,11 +11,11 @@ jobs:
|
|
|
11
11
|
|
|
12
12
|
steps:
|
|
13
13
|
- name: Checkout
|
|
14
|
-
uses: actions/checkout@
|
|
14
|
+
uses: actions/checkout@v6
|
|
15
15
|
with:
|
|
16
16
|
fetch-depth: 0
|
|
17
17
|
|
|
18
18
|
- name: Sync Package info to GitHub
|
|
19
|
-
uses: kitschpatrol/github-action-repo-sync@
|
|
19
|
+
uses: kitschpatrol/github-action-repo-sync@v4
|
|
20
20
|
with:
|
|
21
21
|
TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/repo-config",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.2",
|
|
4
4
|
"description": "Repository configuration and GitHub workflows for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
"email": "eric@ericmika.com",
|
|
23
23
|
"url": "https://ericmika.com"
|
|
24
24
|
},
|
|
25
|
+
"sideEffects": false,
|
|
25
26
|
"type": "module",
|
|
26
27
|
"bin": {
|
|
27
28
|
"ksc-repo": "bin/cli.js"
|
|
@@ -32,7 +33,7 @@
|
|
|
32
33
|
],
|
|
33
34
|
"dependencies": {
|
|
34
35
|
"@pinojs/json-colorizer": "^4.0.0",
|
|
35
|
-
"@pnpm/lockfile.fs": "^1001.1.
|
|
36
|
+
"@pnpm/lockfile.fs": "^1001.1.31",
|
|
36
37
|
"cosmiconfig": "^9.0.0",
|
|
37
38
|
"cosmiconfig-typescript-loader": "^6.2.0",
|
|
38
39
|
"decircular": "^1.0.0",
|
|
@@ -49,7 +50,7 @@
|
|
|
49
50
|
"yargs": "^18.0.0"
|
|
50
51
|
},
|
|
51
52
|
"engines": {
|
|
52
|
-
"node": ">=
|
|
53
|
+
"node": ">=20.19.0"
|
|
53
54
|
},
|
|
54
55
|
"publishConfig": {
|
|
55
56
|
"access": "public"
|