@kitschpatrol/knip-config 8.12.1 → 8.13.1
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 +5 -4
- package/readme.md +21 -0
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 from"node:fs";import{availableParallelism as a}from"node:os";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{packageUp as l,packageUpSync as u}from"package-up";import d from"yargs";import{hideBin as f}from"yargs/helpers";import p from"picocolors";import{stripVTControlCharacters as m}from"node:util";import h from"@pinojs/json-colorizer";import g from"decircular";import _ from"deepmerge";import v from"json-stringify-pretty-compact";import{findWorkspacesRoot as y}from"find-workspaces";import b from"node:fs/promises";import"deepmerge-ts";var ee=`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 from"node:fs";import{availableParallelism as a}from"node:os";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{packageUp as l,packageUpSync as u}from"package-up";import d from"yargs";import{hideBin as f}from"yargs/helpers";import p from"picocolors";import{stripVTControlCharacters as m}from"node:util";import h from"@pinojs/json-colorizer";import g from"decircular";import _ from"deepmerge";import v from"json-stringify-pretty-compact";import{findWorkspacesRoot as y}from"find-workspaces";import b from"node:fs/promises";import"deepmerge-ts";var ee=`8.13.1`;const x=[`json`,`machine`,`native`],te=x;function S(e){return typeof e==`string`&&x.includes(e)}function C(){let e=process.env.KSC_FORMAT;return S(e)?e:`native`}function ne(){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)),S(r)&&(process.env.KSC_FORMAT=r)}}function re(){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 w(e,{ciColor:t=!0}={}){return re()??(e.isTTY===!0||t&&!!process.env.CI)}function T(){return C()===`json`?process.stderr:process.stdout}function E(){return C()===`machine`?p.createColors(!1):p.createColors(w(T()))}function D(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 ie(e,t){let n=o.isAbsolute(e)?e:o.resolve(t,e),r=o.relative(process.cwd(),n);return r===``?`.`:r}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 O(e){return m(e).split(oe).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function ue(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function k(e){return w(process.stdout,{ciColor:!1})?de(e):A(e)}function A(e){return v(g(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}})}function de(e){return h(A(e),{colors:{BRACKET:`gray`}})}const fe=(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:fe}){return _(e,t,n)}function M(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function pe(e,t){let n=[...M(e)];for(let e of M(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 N(){let e=u();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function me(){return y()!==null}function P(){let e=y();return e===null?N():o.resolve(e.location)}function F(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 he(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 I(e){try{await he(e,await b.readFile(e,`utf8`))}catch{}}const L=/\r?\n/v;function ge(e){let t=``,n=t=>t.filter(t=>{let n=m(t);return n.trim()!==``&&!e(n)}).map(e=>`${e}\n`).join(``);return new c({flush(e){e(void 0,n([t]))},transform(e,r,i){let a=(t+e.toString()).split(L);t=a.pop()??``,i(void 0,n(a))}})}function R(e,t){let n=C()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:E()[t](n),i=``,a=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new c({flush(e){e(void 0,a([i]))},transform(e,t,n){let r=(i+e.toString()).split(L);i=r.pop()??``,n(void 0,a(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 z(e,t){return t===1?e:e+`s`}async function B(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=R(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(E().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,i){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...i&&e.cache!==void 0?[...e.cache.flags,`--cache-location`,o.join(P(),`node_modules`,`.cache`,`ksc`,e.cache.name)]:[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function ye(e,t,r,i,a,o){let c=1,l;if(i.logPrefix===void 0)l=e;else{let t=R(i.logPrefix,i.logColor);t.pipe(e),l=t}let u=V(i,t,r,i.optionFlags,a),d=F(i.cwdOverride);o&&l.write(`Running: "${i.name} ${u.join(` `)}"\n`);let f=i.prettyJsonOutput?new s:void 0,p=f??l,m=D(C()===`native`&&i.prettyJsonOutput!==!0&&w(T()));try{let e=n(i.name,u,{cwd:d,env:m,preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let t=ge(i.outputFilter),n=ge(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 _e(f),t=k(JSON.parse(e)).split(`
|
|
4
4
|
`);for(let e of t)l.write(`${e}\n`)}c=t.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),ue(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(e,t,r,i,a){let o=V(r,e,t,r.collect?.optionFlags??r.optionFlags,i),s=F(r.cwdOverride);try{let e=n(r.name,o,{cwd:s,env:D(!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:ue(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)&&`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 xe(e,t,n,r,i){let a=Date.now(),o=()=>Date.now()-a;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: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 s;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:O(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(!be(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:O(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:o(),exitCode:n,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:o(),exitCode:c.exitCode,name:r.name,unparsed:[...O(c.stdout),...O(c.stderr),String(e)]}]}}return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:o(),exitCode:c.exitCode,name:r.name,unparsed:[...O(c.stdout),...O(c.stderr)]}]}}const Se=/^ksc-/v;function K(e){return e.replace(Se,``)}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 Y(e){return e.option(`format`,{choices:te,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 X(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 Ce(e,t){return t===`native`||t===`machine`&&!H(e)&&!U(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(){return Math.min(4,a())}var Ee=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 De(e){let t=e.cache??!1,n=e.concurrency??Te();if(!Number.isInteger(n)||n<1)throw Error(`Concurrency must be a positive integer.`);return t&&await r.ensureDir(o.join(P(),`node_modules`,`.cache`,`ksc`)),{cache:t,scheduler:new Ee(n)}}const Oe=/[*?\[\]\{\}]/v;function Z(e,t){return t===void 0?e:e.filter(e=>Oe.test(e)||i.statSync(e,{throwIfNoEntry:!1})?.isDirectory()===!0||t.includes(o.extname(e).slice(1).toLowerCase()))}function ke(e,t){return e.length===0||Z(e,t).length>0}function Ae(e,t){return e.positionalArgumentMode===`none`?[]:t.length>0?Z(t,e.positionalArgumentExtensions):e.positionalArgumentDefault===void 0?[]:[e.positionalArgumentDefault]}function je(e,t){if(t.logPrefix===void 0)return e;let n=R(t.logPrefix,t.logColor);return n.pipe(e),n}function Me(e){return U(e)?`${e.name} ${e.subcommand}`:!H(e)&&e.subcommands!==void 0?[e.name,...e.subcommands].join(` `):e.name}async function Ne(e,t){if(U(e)){let n=je(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=>Me(e)).join(`, `)})`:``;t.logStream.write(`Running: "${e.name} ${n}"${i}\n`)}let i=await Pe(r,{...t,logStream:n,nativeVerbose:e.verbose,positionalArguments:Ae(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(Ce(e,t.format))return{diagnostics:[],exitCode:await(H(e)?ve(t.logStream,t.positionalArguments,t.optionFlags,e,t.nativeVerbose):ye(t.logStream,t.positionalArguments,t.optionFlags,e,t.cache,t.nativeVerbose)),machineOutcomes:[],name:e.name,tools:[]};let n=await xe(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 Pe(e,t,n){if(!n||t.scheduler.concurrency===1){let n=[];for(let r of e)n.push(await Ne(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 Ne(e,t)})));for(let{index:e,outcome:t}of a)i[e]=t}return i.filter(e=>e!==void 0)}function Fe(e,t,n,r,i){let a=[],o=[],s=ke(r,i);for(let e of t){let t=!U(e)||ke(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(`⚠️ ${E().yellow(`Unrecognized --skip ${z(`value`,i.length)}: ${i.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:a,skippedCommands:o}}async function Q(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}=Fe(e,r,o??[],t,c.positionalArgumentExtensions),f=l===`native`&&i,{cache:p,scheduler:m}=await De(c),h=await Pe(u,{cache:p,format:l,logStream:e,nativeVerbose:f,optionFlags:n,positionalArguments:Z(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)we(e,n);let y=r.length,b=E();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`?le(_,v):void 0}}async function Ie(e){let t=await l({cwd:e});return t===void 0?void 0:o.join(o.dirname(t),`init`)}async function Le(e,t,n,a){let s=await l();if(s===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let c=await Ie(import.meta.dirname);if(c===void 0)return e.write(`Error: Could not locate the package containing this CLI.
|
|
5
5
|
`),1;let u=o.dirname(s),d=(t===`file`||t===`package`)&&n!==void 0&&a!==void 0;try{if(d){let n=Object.keys(a)[0],i=r.readJsonSync(s);if(t===`package`){e.write(`Merging: \nPackage config key "${n}" → "${u}" (Because --location is set to "package")\n`);let t=j(i,a);r.writeJSONSync(s,t,{spaces:` `}),await I(s)}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],r.writeJSONSync(s,i,{spaces:` `}),await I(s))}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}" → "${u}"\n`),await r.copy(c,u,{async filter(a,s){let c=i.statSync(a).isFile(),l=i.existsSync(s);if(c){if(d&&t===`package`&&a.includes(n))return l?(e.write(`Deleting: \n"${a}" → "${s}" (Because --location is set to "package")\n`),r.removeSync(s)):e.write(`Skipping: \n"${a}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&o.extname(s)===`.json`){e.write(`Merging: \n"${a}" → "${s}"\n`);let t=r.readJSONSync(a),n=r.readJSONSync(s),i=s.endsWith(`.vscode/tasks.json`)?pe(n,t):j(n,t);return r.writeJSONSync(s,i,{spaces:` `}),await I(s),!1}return l?(e.write(`Overwriting: \n"${a}" → "${s}"\n`),await I(s),!0):(e.write(`Copying: \n"${a}" → "${s}"\n`),await I(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Re(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:u}=e;ne();let p=R(s,o);p.pipe(T());let m=d(f(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?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 Q(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return Le(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=X(Y(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?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=C(),{exitCode:a,report:o}=await Q(p,t,[],await B(r.commands),u,l,n,{cache:e.cache,format:i,parallel:r.parallel,positionalArgumentExtensions:r.positionalArgumentExtensions});o!==void 0&&process.stdout.write(`${k(o)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=X(Y(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?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=C(),{exitCode:a,report:o}=await Q(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(`${k(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?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 Q(p,n,[],await B(i.commands),u,l,r);process.exitCode=a}}),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()}function ze(e){return{async execute(t){let n=await Be(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/knip-config",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.13.1",
|
|
4
4
|
"description": "Knip configuration for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
"knip",
|
|
9
9
|
"cli",
|
|
10
10
|
"ksc",
|
|
11
|
-
"ksc-knip"
|
|
11
|
+
"ksc-knip",
|
|
12
|
+
"npm-package"
|
|
12
13
|
],
|
|
13
14
|
"homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/knip-config",
|
|
14
15
|
"bugs": "https://github.com/kitschpatrol/shared-config/issues",
|
|
@@ -48,11 +49,11 @@
|
|
|
48
49
|
"decircular": "^1.0.0",
|
|
49
50
|
"deepmerge": "^4.3.1",
|
|
50
51
|
"deepmerge-ts": "^8.0.2",
|
|
51
|
-
"execa": "^10.0
|
|
52
|
+
"execa": "^10.1.0",
|
|
52
53
|
"find-workspaces": "^0.3.1",
|
|
53
54
|
"fs-extra": "^11.4.1",
|
|
54
55
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
55
|
-
"knip": "^6.
|
|
56
|
+
"knip": "^6.40.0",
|
|
56
57
|
"package-up": "^5.0.0",
|
|
57
58
|
"picocolors": "^1.1.1",
|
|
58
59
|
"prettier": "^3.9.9",
|
package/readme.md
CHANGED
|
@@ -85,6 +85,27 @@ pnpm exec ksc-knip init --location package
|
|
|
85
85
|
|
|
86
86
|
(Note that this will delete the `knip.config.ts` file in your project root!)
|
|
87
87
|
|
|
88
|
+
#### Monorepos
|
|
89
|
+
|
|
90
|
+
`knipConfig()` merges the shared configuration with your customizations, but does not copy shared entry patterns into each workspace. In a monorepo, Knip ignores root-level `entry` and `project` options; configure the root workspace explicitly as `"."`. See [Knip's workspace documentation](https://knip.dev/features/monorepos-and-workspaces#configuration).
|
|
91
|
+
|
|
92
|
+
To apply the shared entry patterns, including scripts and bundled skill scripts, to the root and each package:
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import { knipConfig, sharedKnipConfig } from '@kitschpatrol/knip-config'
|
|
96
|
+
|
|
97
|
+
const sharedEntry = typeof sharedKnipConfig === 'function' ? [] : (sharedKnipConfig.entry ?? [])
|
|
98
|
+
|
|
99
|
+
export default knipConfig({
|
|
100
|
+
workspaces: {
|
|
101
|
+
'.': { entry: sharedEntry },
|
|
102
|
+
'packages/*': { entry: sharedEntry },
|
|
103
|
+
},
|
|
104
|
+
})
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Adjust `packages/*` to match your workspace layout, adding patterns such as `apps/*` if needed. Entry patterns are relative to each workspace directory. Without these entries, scripts that are not discovered through imports or plugins can be reported as unused.
|
|
108
|
+
|
|
88
109
|
### CLI
|
|
89
110
|
|
|
90
111
|
<!-- cli-help({ heading: false, headingLevel: 3 }) -->
|