@kitschpatrol/shared-config 8.4.0 → 8.5.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/package.json +14 -14
- package/readme.md +6 -6
package/bin/cli.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import{availableParallelism as o}from"node:os";import s from"node:path";import{PassThrough as c,Transform as l}from"node:stream";import{packageUp as u,packageUpSync as d}from"package-up";import f from"yargs";import{hideBin as p}from"yargs/helpers";import m from"picocolors";import{stripVTControlCharacters as h}from"node:util";import g from"@pinojs/json-colorizer";import _ from"decircular";import ee from"deepmerge";import v from"json-stringify-pretty-compact";import{findWorkspaces as y,findWorkspacesRoot as te}from"find-workspaces";import b,{access as ne}from"node:fs/promises";import{getDefaultConfigLoader as x,resolveConfigFileImports as re}from"cspell-lib";import{fileURLToPath as S}from"node:url";import{createReaderWriter as ie}from"cspell-config-lib";import{loadFile as ae,writeFile as oe}from"magicast";import{getDefaultExportOptions as se}from"magicast/helpers";import{lint as ce}from"cspell";import"deepmerge-ts";import{loadConfig as le}from"mdat";import{globby as ue}from"globby";import C,{gt as de,minVersion as fe}from"semver";import{readWantedLockfile as pe}from"@pnpm/lockfile.fs";import me from"stylelint";var he=`8.
|
|
2
|
+
import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import{availableParallelism as o}from"node:os";import s from"node:path";import{PassThrough as c,Transform as l}from"node:stream";import{packageUp as u,packageUpSync as d}from"package-up";import f from"yargs";import{hideBin as p}from"yargs/helpers";import m from"picocolors";import{stripVTControlCharacters as h}from"node:util";import g from"@pinojs/json-colorizer";import _ from"decircular";import ee from"deepmerge";import v from"json-stringify-pretty-compact";import{findWorkspaces as y,findWorkspacesRoot as te}from"find-workspaces";import b,{access as ne}from"node:fs/promises";import{getDefaultConfigLoader as x,resolveConfigFileImports as re}from"cspell-lib";import{fileURLToPath as S}from"node:url";import{createReaderWriter as ie}from"cspell-config-lib";import{loadFile as ae,writeFile as oe}from"magicast";import{getDefaultExportOptions as se}from"magicast/helpers";import{lint as ce}from"cspell";import"deepmerge-ts";import{loadConfig as le}from"mdat";import{globby as ue}from"globby";import C,{gt as de,minVersion as fe}from"semver";import{readWantedLockfile as pe}from"@pnpm/lockfile.fs";import me from"stylelint";var he=`8.5.0`;const ge=[`json`,`machine`,`native`],_e=ge;function ve(e){return typeof e==`string`&&ge.includes(e)}function w(){let e=process.env.KSC_FORMAT;return ve(e)?e:`native`}function ye(){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)),ve(r)&&(process.env.KSC_FORMAT=r)}}function be(){let{env:e}=process;if(e.NO_COLOR!==void 0&&e.NO_COLOR!==``)return!1;if(e.FORCE_COLOR!==void 0)return e.FORCE_COLOR!==`0`&&e.FORCE_COLOR!==`false`;if(e.TERM===`dumb`)return!1}function T(e,{ciColor:t=!0}={}){let n=be();return n===void 0?e.isTTY===!0||t&&!!process.env.CI:n}function E(){return w()===`json`?process.stderr:process.stdout}function D(){return w()===`machine`?m.createColors(!1):m.createColors(T(E()))}function xe(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 O(e,t){let n=s.isAbsolute(e)?e:s.resolve(t,e),r=s.relative(process.cwd(),n);return r===``?`.`:r}const Se=/\s*\n\s*/gv,Ce=/\r?\n/v;function we(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 Te(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 Ee(e,t){let n=t.toSorted(Te);return{cwd:process.cwd(),diagnostics:n,success:e.every(e=>e.exitCode===0),summary:{errors:n.filter(e=>e.severity===`error`).length,infos:n.filter(e=>e.severity===`info`).length,warnings:n.filter(e=>e.severity===`warning`).length},tools:e,version:1}}function k(e){return h(e).split(Ce).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function De(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function A(e){return T(process.stdout,{ciColor:!1})?ke(e):Oe(e)}function Oe(e){return v(_(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}})}function ke(e){return g(Oe(e),{colors:{BRACKET:`gray`}})}const Ae=(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]=j(e[i],a,n):e.includes(a)||r.push(a);return r};function j(e,t,n={arrayMerge:Ae}){return ee(e,t,n)}function je(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function Me(e,t){let n=[...je(e)];for(let e of je(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 Ne(e,t){return e.startsWith(t+s.sep)}function M(){let e=N(),t=new Set([e]),n=y();if(n!==null)for(let r of n){let n=s.resolve(r.location);Ne(n,e)&&t.add(n)}return[...t]}function N(){let e=d();if(e===void 0)throw Error(`No package.json found.`);return s.dirname(e)}function Pe(){return te()!==null}function P(){let e=te();return e===null?N():s.resolve(e.location)}function Fe(e){let t=s.join(P(),e);if(r.existsSync(t))return t}function Ie(e){if(e===`workspace-root`)return P();if(e===`package-dir`)return N();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function Le(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await b.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function F(e){try{await Le(e,await b.readFile(e,`utf8`))}catch{}}const Re=/\r?\n/v;function ze(e){let t=``,n=t=>t.filter(t=>{let n=h(t);return n.trim()!==``&&!e(n)}).map(e=>`${e}\n`).join(``);return new l({flush(e){e(void 0,n([t]))},transform(e,r,i){let a=(t+e.toString()).split(Re);t=a.pop()??``,i(void 0,n(a))}})}function I(e,t){let n=w()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:D()[t](n),i=``,a=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new l({flush(e){e(void 0,a([i]))},transform(e,t,n){let r=(i+e.toString()).split(Re);i=r.pop()??``,n(void 0,a(r))}})}async function Be(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>{t.push(e)}),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function Ve(e){return e.replaceAll(/[A-Z\u{C0}-\u{D6}\u{D8}-\u{DE}]/gv,e=>`-`+e.toLowerCase())}function L(e,t){return t===1?e:e+`s`}async function R(e){return typeof e==`function`?e():e}async function He(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(D().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 Ue(e,t,n,r,i){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...i&&e.cache!==void 0?[...e.cache.flags,`--cache-location`,s.join(P(),`node_modules`,`.cache`,`ksc`,e.cache.name)]:[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function We(e,t,r,i,a,o){let s=1,l;if(i.logPrefix===void 0)l=e;else{let t=I(i.logPrefix,i.logColor);t.pipe(e),l=t}let u=Ue(i,t,r,i.optionFlags,a),d=Ie(i.cwdOverride);o&&l.write(`Running: "${i.name} ${u.join(` `)}"\n`);let f=i.prettyJsonOutput?new c:void 0,p=f??l,m=xe(w()===`native`&&i.prettyJsonOutput!==!0&&T(E()));try{let e=n(i.name,u,{cwd:d,env:m,preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let t=ze(i.outputFilter),n=ze(i.outputFilter);e.stdout.pipe(t).pipe(p,{end:!1}),e.stderr.pipe(n).pipe(p,{end:!1})}else e.stdout.pipe(p,{end:!1}),e.stderr.pipe(p,{end:!1});let t=await e;if(f!==void 0){f.end();let e=await Be(f),t=A(JSON.parse(e)).split(`
|
|
4
4
|
`);for(let e of t)l.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),De(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function z(e){return`execute`in e}function B(e){return`kind`in e}async function Ge(e,t,r,i,a){let o=Ue(r,e,t,r.collect?.optionFlags??r.optionFlags,i),s=Ie(r.cwdOverride);try{let e=n(r.name,o,{cwd:s,env:xe(!1),preferLocal:!0,reject:!1,stdin:`inherit`});a!==void 0&&e.stderr.pipe(a,{end:!1});let t=await e;return{cwd:s,exitCode:t.exitCode??1,stderr:t.stderr,stdout:t.stdout}}catch(e){return console.error(`${r.name} failed with error:`),console.error(e),{cwd:s,exitCode:De(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function Ke(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 qe(e,t){return e===0&&t.some(({severity:e})=>e===`error`)?1:e}async function Je(e,t,n,r,i){let a=Date.now(),o=()=>Date.now()-a;if(z(r)){if(r.collect!==void 0)try{let e=await r.collect(t,n),i=qe(e.exitCode,e.diagnostics);return{diagnostics:e.diagnostics,exitCode:i,tools:[{durationMs:o(),exitCode:i,name:r.name,unparsed:e.unparsed}]}}catch(e){return{diagnostics:[],exitCode:1,tools:[{durationMs:o(),exitCode:1,name:r.name,unparsed:[String(e)]}]}}let e=``,i=new c;i.on(`data`,t=>{e+=t.toString()});let a;try{a=await r.execute(i,t,n)}catch(t){e+=`\n${String(t)}`,a=1}return{diagnostics:[],exitCode:a,tools:[{durationMs:o(),exitCode:a,name:r.name,unparsed:k(e)}]}}if(B(r))throw Error(`Command groups must be expanded before collection`);if(r.outputFormatAware){let a=await Ge(t,n,r,i,e);try{let e=JSON.parse(a.stdout);if(!Ke(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:o(),exitCode:a.exitCode,name:r.name,unparsed:k(a.stdout)}]}}}let s=await Ge(t,n,r,i);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(s),n=qe(s.exitCode,e);return{diagnostics:e,exitCode:n,tools:[{durationMs:o(),exitCode:n,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...k(s.stdout),...k(s.stderr),String(e)]}]}}return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...k(s.stdout),...k(s.stderr)]}]}}const Ye=/^ksc-/v;function V(e){return e.replace(Ye,``)}function H(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>V(e.trim()))}function U(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function Xe(e){return e.option(`format`,{choices:_e,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 Ze(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 Qe(e,t){return t===`native`||t===`machine`&&!z(e)&&!B(e)&&e.outputFormatAware===!0}function $e(e,t){for(let n of t.diagnostics)e.write(`${we(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function et(){return Math.min(4,o())}var tt=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 nt(e){let t=e.cache??!1,n=e.concurrency??et();if(!Number.isInteger(n)||n<1)throw Error(`Concurrency must be a positive integer.`);return t&&await r.ensureDir(s.join(P(),`node_modules`,`.cache`,`ksc`)),{cache:t,scheduler:new tt(n)}}function rt(e,t){return e.positionalArgumentMode===`none`?[]:t.length>0?t:e.positionalArgumentDefault===void 0?[]:[e.positionalArgumentDefault]}function it(e,t){if(t.logPrefix===void 0)return e;let n=I(t.logPrefix,t.logColor);return n.pipe(e),n}function at(e){return B(e)?`${e.name} ${e.subcommand}`:!z(e)&&e.subcommands!==void 0?[e.name,...e.subcommands].join(` `):e.name}async function ot(e,t){if(B(e)){let n=it(t.logStream,e);try{let r=await R(e.commands);if(t.nativeVerbose){let n=[e.subcommand,...t.positionalArguments].join(` `),i=e.showResolvedCommands?` (${r.map(e=>at(e)).join(`, `)})`:``;t.logStream.write(`Running: "${e.name} ${n}"${i}\n`)}let i=await st(r,{...t,logStream:n,nativeVerbose:e.verbose,positionalArguments:rt(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(Qe(e,t.format))return{diagnostics:[],exitCode:await(z(e)?He(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 Je(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 st(e,t,n){if(!n||t.scheduler.concurrency===1){let n=[];for(let r of e)n.push(await ot(r,t));return n}await Promise.resolve();let r=new Map;for(let[t,n]of e.entries()){let e=n.stage??0,i=r.get(e)??[];i.push({command:n,index:t}),r.set(e,i)}let i=Array.from({length:e.length}),a=r.keys().toArray().toSorted((e,t)=>e-t);for(let e of a){let n=r.get(e)??[],a=await Promise.all(n.map(async({command:e,index:n})=>({index:n,outcome:await ot(e,t)})));for(let{index:e,outcome:t}of a)i[e]=t}return i.filter(e=>e!==void 0)}function ct(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(V(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>V(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>V(e.name)).join(`, `);e.write(`⚠️ ${D().yellow(`Unrecognized --skip ${L(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}async function W(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}=ct(e,r,o??[]),f=l===`native`&&i,{cache:p,scheduler:m}=await nt(c),h=await st(u,{cache:p,format:l,logStream:e,nativeVerbose:f,optionFlags:n,positionalArguments:t,scheduler:m},c.parallel===!0),g=h.map(({exitCode:e,name:t})=>({exitCode:e,name:t})),_=h.flatMap(({tools:e})=>e),ee=h.flatMap(({diagnostics:e})=>e);if(l===`machine`)for(let t of h)for(let n of t.machineOutcomes)$e(e,n);let v=r.length,y=D();if(l===`native`&&d.length>0){let t=d.map(({name:e})=>e),n=y.bold(`${t.length} / ${v} ${L(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${y.dim(n)} ${y.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=y.bold(`${t.length} / ${v} ${L(`Command`,t.length)} Succeeded:`);e.write(`✅ ${y.green(n)} ${y.green(t.join(`, `))}\n`)}if(n.length>0){let t=y.bold(`${n.length} / ${v} ${L(`Command`,n.length)} Failed:`);e.write(`❌ ${y.red(t)} ${y.red(n.join(`, `))}\n`)}}return{exitCode:+!g.every(({exitCode:e})=>e===0),report:l===`json`?Ee(_,ee):void 0}}async function lt(e){let t=await u({cwd:e});return t===void 0?void 0:s.join(s.dirname(t),`init`)}async function ut(e,t,n,a){let o=await u();if(o===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let c=await lt(import.meta.dirname);if(c===void 0)return e.write(`Error: Could not locate the package containing this CLI.
|
|
5
5
|
`),1;let l=s.dirname(o),d=(t===`file`||t===`package`)&&n!==void 0&&a!==void 0;try{if(d){let n=Object.keys(a)[0],i=r.readJsonSync(o);if(t===`package`){e.write(`Merging: \nPackage config key "${n}" → "${l}" (Because --location is set to "package")\n`);let t=j(i,a);r.writeJSONSync(o,t,{spaces:` `}),await F(o)}else n!==void 0&&Object.keys(i).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${l}" (Because --location is set to "file")\n`),delete i[n],r.writeJSONSync(o,i,{spaces:` `}),await F(o))}if(!await r.pathExists(c))return 0;if((await r.readdir(c)).length===0)return e.write(`Source directory "${c}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${c}" → "${l}"\n`),await r.copy(c,l,{async filter(a,o){let c=i.statSync(a).isFile(),l=i.existsSync(o);if(c){if(d&&t===`package`&&a.includes(n))return l?(e.write(`Deleting: \n"${a}" → "${o}" (Because --location is set to "package")\n`),r.removeSync(o)):e.write(`Skipping: \n"${a}" → "${o}" (Because --location is set to "package")\n`),!1;if(l&&(o.includes(`.vscode/`)||o.includes(`package.json`))&&s.extname(o)===`.json`){e.write(`Merging: \n"${a}" → "${o}"\n`);let t=r.readJSONSync(a),n=r.readJSONSync(o),i=o.endsWith(`.vscode/tasks.json`)?Me(n,t):j(n,t);return r.writeJSONSync(o,i,{spaces:` `}),await F(o),!1}return l?(e.write(`Overwriting: \n"${a}" → "${o}"\n`),await F(o),!0):(e.write(`Copying: \n"${a}" → "${o}"\n`),await F(o),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function dt(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:u}=e;ye();let d=I(s,o);d.pipe(E());let m=f(p(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?U(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=H(e.skip),{exitCode:i}=await W(d,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return ut(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=Ze(Xe(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?U(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=H(e.skip),i=w(),{exitCode:a,report:o}=await W(d,t,[],await R(r.commands),u,l,n,{cache:e.cache,format:i,parallel:r.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=Ze(Xe(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?U(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=H(e.skip),i=w(),{exitCode:a,report:o}=await W(d,n,[],await R(t.commands),void 0,void 0,r,{cache:e.cache,format:i,parallel:t.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),i!==void 0&&m.command({builder(e){let t=i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault!==void 0&&{default:i.positionalArgumentDefault},describe:`File or glob pattern to print configuration for.`,type:`string`});return l?U(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=H(e.skip),{exitCode:a}=await W(d,n,[],await R(i.commands),u,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(he),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}function G(e){return{async execute(t){let n=await K(e);if(n===void 0)return 1;let{config:r,filepath:i,isEmpty:a}=n;if(t.write(`Found ${e} configuration at "${i}"\n`),a)return t.write(`Configuration is empty.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/shared-config",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.5.0",
|
|
4
4
|
"description": "A collection of shared configurations, linters, and formatting tools for TypeScript projects. All managed as a single dependency. All invoked via a single CLI command.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
],
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"@pinojs/json-colorizer": "^4.0.0",
|
|
57
|
-
"@pnpm/lockfile.fs": "1100.1.
|
|
57
|
+
"@pnpm/lockfile.fs": "^1100.1.14",
|
|
58
58
|
"cosmiconfig": "^9.0.2",
|
|
59
59
|
"cosmiconfig-typescript-loader": "^6.3.0",
|
|
60
60
|
"cspell": "^10.0.1",
|
|
@@ -65,26 +65,26 @@
|
|
|
65
65
|
"deepmerge-ts": "^7.1.5",
|
|
66
66
|
"execa": "^10.0.0",
|
|
67
67
|
"find-workspaces": "^0.3.1",
|
|
68
|
-
"fs-extra": "^11.
|
|
69
|
-
"globby": "^16.2.
|
|
68
|
+
"fs-extra": "^11.4.0",
|
|
69
|
+
"globby": "^16.2.2",
|
|
70
70
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
71
71
|
"magicast": "^0.5.3",
|
|
72
|
-
"mdat": "^
|
|
72
|
+
"mdat": "^3.0.0",
|
|
73
73
|
"package-up": "^5.0.0",
|
|
74
74
|
"picocolors": "^1.1.1",
|
|
75
75
|
"prettier": "^3.9.6",
|
|
76
76
|
"semver": "^7.8.5",
|
|
77
77
|
"stylelint": "^17.14.1",
|
|
78
78
|
"yargs": "^18.0.0",
|
|
79
|
-
"@kitschpatrol/cspell-config": "8.
|
|
80
|
-
"@kitschpatrol/
|
|
81
|
-
"@kitschpatrol/
|
|
82
|
-
"@kitschpatrol/knip-config": "8.
|
|
83
|
-
"@kitschpatrol/
|
|
84
|
-
"@kitschpatrol/
|
|
85
|
-
"@kitschpatrol/repo-config": "8.
|
|
86
|
-
"@kitschpatrol/
|
|
87
|
-
"@kitschpatrol/
|
|
79
|
+
"@kitschpatrol/cspell-config": "8.5.0",
|
|
80
|
+
"@kitschpatrol/prettier-config": "8.5.0",
|
|
81
|
+
"@kitschpatrol/eslint-config": "8.5.0",
|
|
82
|
+
"@kitschpatrol/knip-config": "8.5.0",
|
|
83
|
+
"@kitschpatrol/mdat-config": "8.5.0",
|
|
84
|
+
"@kitschpatrol/typescript-config": "8.5.0",
|
|
85
|
+
"@kitschpatrol/repo-config": "8.5.0",
|
|
86
|
+
"@kitschpatrol/stylelint-config": "8.5.0",
|
|
87
|
+
"@kitschpatrol/remark-config": "8.5.0"
|
|
88
88
|
},
|
|
89
89
|
"engines": {
|
|
90
90
|
"node": "^24.16.0 || >=26.3.0"
|
package/readme.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
<!-- /title -->
|
|
6
6
|
|
|
7
|
-
[](https://npmjs.com/package/@kitschpatrol/shared-config)
|
|
8
|
-
[](https://opensource.org/
|
|
7
|
+
[](https://www.npmjs.com/package/@kitschpatrol/shared-config)
|
|
8
|
+
[](https://opensource.org/license/mit)
|
|
9
9
|
[](https://github.com/kitschpatrol/shared-config/actions/workflows/ci.yml)
|
|
10
10
|
|
|
11
11
|
<!-- description -->
|
|
@@ -189,7 +189,7 @@ pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init && pnpm i && pnpm add
|
|
|
189
189
|
|
|
190
190
|
5. Set up GitHub action credentials (if desired)
|
|
191
191
|
|
|
192
|
-
The GitHub actions included in @kitschpatrol/repo-config require permissions to create releases and update your repository metadata. You can add these through the GitHub website under the _Settings → Secrets and variables → Actions_ page under the key `PERSONAL_ACCESS_TOKEN`, or with the [GitHub CLI](https://cli.github.com
|
|
192
|
+
The GitHub actions included in @kitschpatrol/repo-config require permissions to create releases and update your repository metadata. You can add these through the GitHub website under the _Settings → Secrets and variables → Actions_ page under the key `PERSONAL_ACCESS_TOKEN`, or with the [GitHub CLI](https://cli.github.com) and a credential manager like [1Password CLI](https://www.1password.dev/cli/get-started):
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
195
|
gh secret set PERSONAL_ACCESS_TOKEN --app actions --body $(op read 'op://Personal/GitHub Mika/PERSONAL_ACCESS_TOKEN')
|
|
@@ -365,7 +365,7 @@ Each tool package's `init` (invoked by `ksc init`) also contributes granular tas
|
|
|
365
365
|
|
|
366
366
|
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
367
367
|
|
|
368
|
-
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/
|
|
368
|
+
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/editing/editingevolved#_errors-warnings) with every issue from every tool, pointing to the offending file, line, and column. Unlike the per-tool editor extensions, which only report on open files, this surfaces diagnostics for the entire project in one pass.
|
|
369
369
|
|
|
370
370
|
The tasks share a problem matcher owner, so the panel reflects the most recent run instead of stacking duplicates across tasks. Existing `tasks.json` files are merged by task label: your own tasks are left alone, and same-label `ksc` tasks are updated in place.
|
|
371
371
|
|
|
@@ -417,7 +417,7 @@ To tell git to ignore changes to the placeholders, run `pnpm run bin-ignore`.
|
|
|
417
417
|
|
|
418
418
|
For local development via `pnpm`, use `file:` dependency protocol instead of `link:`
|
|
419
419
|
|
|
420
|
-
Something to investigate: An [approach](https://github.com/antfu/eslint-config#
|
|
420
|
+
Something to investigate: An [approach](https://github.com/antfu/eslint-config#ide-support-auto-fix-on-save) to ignoring style rules in VS Code, and possibly migrate all style handling to ESLint instead of Prettier.
|
|
421
421
|
|
|
422
422
|
## Background
|
|
423
423
|
|
|
@@ -448,7 +448,7 @@ More recently, the [Vite+ project / `vp` cli tool](https://viteplus.dev/) seems
|
|
|
448
448
|
- [neostandard](https://github.com/neostandard/neostandard)
|
|
449
449
|
- [NullVoxPopuli/eslint-configs](https://github.com/NullVoxPopuli/eslint-configs)
|
|
450
450
|
- [qlty](https://github.com/qltysh/qlty) (Multi-language.)
|
|
451
|
-
- [routine-npm-packages](https://github.com/kachkaev/
|
|
451
|
+
- [routine-npm-packages](https://github.com/kachkaev/reusable-stuff) and [example](https://github.com/kachkaev/website)
|
|
452
452
|
- [sheriff](https://www.eslint-config-sheriff.dev)
|
|
453
453
|
- [standard](https://standardjs.com)
|
|
454
454
|
- [sxzz/eslint-config](https://github.com/sxzz/eslint-config)
|