@kitschpatrol/shared-config 8.0.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli.js +12 -13
- package/dist/index.d.ts +0 -1
- package/init/.vscode/tasks.json +73 -0
- package/package.json +15 -14
- package/readme.md +27 -10
package/bin/cli.js
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
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 o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import h from"@pinojs/json-colorizer";import
|
|
3
|
-
`)
|
|
4
|
-
`)}})}function
|
|
5
|
-
`);
|
|
6
|
-
`),
|
|
7
|
-
`),0;let o=
|
|
8
|
-
`)
|
|
9
|
-
`)
|
|
10
|
-
`);for(let t of n)e.write(`${t}\n`);return 0}const Pe={commands:{fix:{commands:[{execute:J,name:J.name}],description:`Remove unused words from the local CSpell configuration's "words" array and sort it alphabetically. ${W.fileRun}`,positionalArgumentDefault:`**/*`,positionalArgumentMode:`optional`},init:{configFile:`cspell.config.ts`,configPackageJson:{cspell:{import:`@kitschpatrol/cspell-config`}},locationOptionFlag:!0},lint:{commands:[{name:`cspell`,optionFlags:[`--quiet`],receivePositionalArguments:!0},{execute:q,name:q.name},{execute:Y,name:Y.name}],description:`Check for spelling mistakes. ${W.fileRun}`,positionalArgumentDefault:`**/*`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:Ne,name:Ne.name}],description:`Print the resolved CSpell configuration. ${W.packageSearch} ${W.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's CSpell shared configuration tools.`,logColor:`cyan`,logPrefix:`[CSpell]`,name:`ksc-cspell`,order:6};async function Fe(e,t){let n;if(t.length>0){let r=o.join(process.cwd(),t[0]);e.write(`Showing configuration for file: ${r}\n`),n={name:`eslint`,optionFlags:[`--print-config`],receivePositionalArguments:!0}}else n=H(`eslint`);return V(e,t,[],[n])}const Ie={commands:{fix:{commands:[{name:`eslint`,optionFlags:[`--fix`],receivePositionalArguments:!0}],description:`Fix your project with ESLint. ${W.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},init:{locationOptionFlag:!1},lint:{commands:[{name:`eslint`,optionFlags:[`--max-warnings`,`0`],receivePositionalArguments:!0}],description:`Lint your project with ESLint. ${W.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:Fe,name:Fe.name}],description:`Print the effective ESLint configuration. ${W.optionalFileRun} Use \`@eslint/config-inspector\` for a more detailed view.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's ESLint shared configuration tools.`,logColor:`magenta`,logPrefix:`[ESLint]`,name:`ksc-eslint`,order:4},Le={entry:[`{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{bin,lib,cli}/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`scripts/**/*.{js,mjs,cjs,ts,mts,cts}`,`.remarkrc.{js,mjs,cjs,ts,mts,cts}`,`cspell.config.{js,mjs,cjs,ts,mts,cts}`,`eslint.config.{js,mjs,cjs,ts,mts,cts}`,`mdat.config.{js,mjs,cjs,ts,mts,cts}`,`prettier.config.{js,mjs,cjs,ts,mts,cts}`,`stylelint.config.{js,mjs,cjs,ts,mts,cts}`],ignoreBinaries:[`ksc-repo`,`ksc-mdat`,`ksc-typescript`,`ksc-eslint`,`ksc-stylelint`,`ksc-cspell`,`ksc-knip`,`ksc-remark`,`ksc-prettier`,`op`,`gh`],ignoreDependencies:[`@kitschpatrol/cspell-config`,`@kitschpatrol/dict-en-wiktionary`,`@kitschpatrol/eslint-config`,`@kitschpatrol/knip-config`,`@kitschpatrol/mdat-config`,`@kitschpatrol/prettier-config`,`@kitschpatrol/remark-config`,`@kitschpatrol/repo-config`,`@kitschpatrol/stylelint-config`,`@kitschpatrol/typescript-config`,`@prettier/plugin-php`,`@prettier/plugin-ruby`,`@prettier/plugin-xml`,`prettier-plugin-packagejson`,`prettier-plugin-sh`,`prettier-plugin-tailwindcss`,`prettier-plugin-toml`,`remark-attribute-list`,`remark-directive`]};function Re(){if(ge()){let e=k(),t=A();if(e!==t){let n=o.relative(t,e);if(n!==``)return[`--workspace`,n.split(o.sep).join(`/`)]}}return[]}function ze(){return{knip:Le}}const Be={commands:{init:{configFile:`knip.config.ts`,configPackageJson:ze(),locationOptionFlag:!0},lint:{commands:[{cwdOverride:`workspace-root`,name:`knip`,optionFlags:[`--no-progress`,`--no-config-hints`,...Re()]}],description:`Check for unused code and dependencies. ${W.packageRun} ${W.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[H(`knip`)],description:`Print the effective Knip configuration. ${W.packageSearch} ${W.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Knip shared configuration tools.`,logColor:`cyan`,logPrefix:`[Knip]`,name:`ksc-knip`,order:7};async function Ve(){return(await U(`mdat`))?.filepath}async function He(e){let t=`mdat`,n=await U(t);n!==void 0&&e.write(`Found ${t} readme configuration at "${n.filepath}"\n`);let r=E(await C({additionalConfig:await C()})).split(`
|
|
11
|
-
`);for(let
|
|
12
|
-
`);
|
|
13
|
-
`)
|
|
14
|
-
`);for(let t of c)e.write(`${t}\n`);return 0}const yt={commands:{fix:{commands:[{name:`stylelint`,optionFlags:[...gt,`--fix`],receivePositionalArguments:!0}],description:`Fix your project with Stylelint. ${W.fileRun}`,positionalArgumentDefault:_t,positionalArgumentMode:`optional`},init:{configFile:`stylelint.config.js`,configPackageJson:{stylelint:{extends:`@kitschpatrol/stylelint-config`}},locationOptionFlag:!0},lint:{commands:[{name:`stylelint`,optionFlags:gt,receivePositionalArguments:!0}],description:`Lint your project with Stylelint. ${W.fileRun}`,positionalArgumentDefault:_t,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:vt,name:vt.name}],description:`Print the effective Stylelint configuration. ${W.optionalFileRun}.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's Stylelint shared configuration tools.`,logColor:`greenBright`,logPrefix:`[Stylelint]`,name:`ksc-stylelint`,order:5};async function bt(){let e=k(),t=[`svelte.config.js`,`svelte.config.mjs`,`svelte.config.cjs`].map(async t=>r.exists(o.join(e,t)));return(await Promise.all(t)).some(Boolean)}async function xt(e){return e.write("Skipping `tsc` since this is a Svelte project. Consider running `svelte-check` instead.\n"),0}async function St(){return await bt()?[{execute:xt,name:xt.name}]:[{cwdOverride:`package-dir`,name:`tsc`,optionFlags:[`--noEmit`]}]}const Q=[Ie,Pe,Be,We,Ke,qe,ht,yt,{commands:{init:{locationOptionFlag:!1},lint:{commands:await St(),description:`Run type checking on your project. ${W.packageRun} ${W.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{name:`tsc`,optionFlags:[`--showConfig`],prettyJsonOutput:!0}],description:`Print the TypeScript configuration for the project. ${W.packageSearch} ${W.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's TypeScript shared configuration tools.`,logColor:`blueBright`,logPrefix:`[TypeScript Config]`,name:`ksc-typescript`,order:3}];function $(e,t){t.sort((e,t)=>e.order-t.order);let n=[];for(let r of t)Object.keys(r.commands).includes(e)&&n.push({name:r.name,...e===`init`?{receiveOptionFlags:r.commands[e]?.locationOptionFlag}:{receivePositionalArguments:r.commands[e]?.positionalArgumentMode!==`none`},subcommands:[ye(e)]});return n}await Te({commands:{fix:{commands:$(`fix`,Q),description:`Fix your project with multiple tools in one go. ${W.multiArgumentCaveat}`,positionalArgumentMode:`optional`},init:{commands:$(`init`,Q),description:`Initialize configuration files for the entire suite of @kitschpatrol/shared-config tools. ${W.multiOptionCaveat}`,locationOptionFlag:!0},lint:{commands:$(`lint`,Q),description:`Lint your project with multiple tools in one go. ${W.multiArgumentCaveat}`,positionalArgumentMode:`optional`},printConfig:{commands:$(`printConfig`,Q),description:`Print aggregated tool configuration data. ${W.multiArgumentCaveat}`,positionalArgumentMode:`optional`}},description:`Run aggregated @kitschpatrol/shared-config commands.`,logColor:`yellow`,logPrefix:`🔬`,name:`ksc`,order:0,showSummary:!0,verbose:!0});export{};
|
|
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 o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import{stripVTControlCharacters as h}from"node:util";import g from"@pinojs/json-colorizer";import ee from"decircular";import te from"deepmerge";import ne from"json-stringify-pretty-compact";import{findWorkspaces as re,findWorkspacesRoot as ie}from"find-workspaces";import _,{access as ae}from"node:fs/promises";import{getDefaultConfigLoader as v,resolveConfigFileImports as y}from"cspell-lib";import{createReaderWriter as oe}from"cspell-config-lib";import{loadFile as se,writeFile as ce}from"magicast";import{getDefaultExportOptions as le}from"magicast/helpers";import{lint as ue}from"cspell";import"deepmerge-ts";import{loadConfig as de}from"mdat";import{globby as fe}from"globby";import b,{gt as x,minVersion as pe}from"semver";import{readWantedLockfile as me}from"@pnpm/lockfile.fs";import he from"stylelint";var ge=`8.2.0`;function S(e,t){let n=o.isAbsolute(e)?e:o.resolve(t,e),r=o.relative(process.cwd(),n);return r===``?`.`:r}const _e=/\s*\n\s*/gv,ve=/\r?\n/v;function ye(e){let t=e.message.replaceAll(_e,` `),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 be(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 xe(e,t){let n=t.toSorted(be);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 C(e){return h(e).split(ve).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function Se(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function w(e){return g(ne(ee(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const Ce=(e,t,n)=>{let r=[...e];for(let[i,a]of t.entries())r[i]===void 0?r[i]=n.cloneUnlessOtherwiseSpecified(a,n):n.isMergeableObject(a)?r[i]=T(e[i],a,n):e.includes(a)||r.push(a);return r};function T(e,t,n={arrayMerge:Ce}){return te(e,t,n)}function we(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function Te(e,t){let n=[...we(e)];for(let e of we(t)){let t=n.findIndex(t=>t.label!==void 0&&t.label===e.label);t===-1?n.push(e):n[t]=e}return{...e,...t,tasks:n}}const E=[`json`,`machine`,`native`],Ee=E;function D(e){return typeof e==`string`&&E.includes(e)}function O(){let e=process.env.KSC_FORMAT;return D(e)?e:`native`}function De(){let{argv:e}=process;for(let[t,n]of e.entries()){let r;n===`--format`?r=e[t+1]:n.startsWith(`--format=`)&&(r=n.slice(9)),D(r)&&(process.env.KSC_FORMAT=r)}}function Oe(e,t){return e.startsWith(t+o.sep)}function k(){let e=A(),t=new Set([e]),n=re();if(n!==null)for(let r of n){let n=o.resolve(r.location);Oe(n,e)&&t.add(n)}return[...t]}function A(){let e=d();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function ke(){return ie()!==null}function j(){let e=ie();return e===null?A():o.resolve(e.location)}function M(e){let t=o.join(j(),e);if(r.existsSync(t))return t}function N(e){if(e===`workspace-root`)return j();if(e===`package-dir`)return A();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function Ae(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await _.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function P(e){try{await Ae(e,await _.readFile(e,`utf8`))}catch{}}const je=/\r?\n/v;function Me(e){let t=``,n=t=>t.filter(t=>t.trim()!==``&&!e(h(t))).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(je);t=a.pop()??``,i(void 0,n(a))}})}function F(e,t){let n=O()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:f[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(je);i=r.pop()??``,n(void 0,a(r))}})}async function Ne(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 Pe(e){return e.replaceAll(/[A-Z\u{C0}-\u{D6}\u{D8}-\u{DE}]/gv,e=>`-`+e.toLowerCase())}function I(e,t){return t===1?e:e+`s`}async function L(e){return typeof e==`function`?e():e}async function Fe(e,t,n,r,i){let a;if(r.logPrefix===void 0)a=e;else{let t=F(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(f.bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`)+`
|
|
3
|
+
`);try{return await r.execute(a,t,n)}catch(e){return console.error(String(e)),1}}function Ie(e,t,n,r){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function Le(e,t,r,i,a){let o=1,c;if(i.logPrefix===void 0)c=e;else{let t=F(i.logPrefix,i.logColor);t.pipe(e),c=t}let l=Ie(i,t,r,i.optionFlags),u=N(i.cwdOverride);a&&c.write(`Running: "${i.name} ${l.join(` `)}"\n`);let d=i.prettyJsonOutput?new s:c,f=O()===`native`?process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}:{NO_COLOR:`1`};try{let e=n(i.name,l,{cwd:u,env:{...f},preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let t=Me(i.outputFilter),n=Me(i.outputFilter);e.stdout.pipe(t).pipe(d,{end:!1}),e.stderr.pipe(n).pipe(d,{end:!1})}else e.stdout.pipe(d,{end:!1}),e.stderr.pipe(d,{end:!1});if(await e,i.prettyJsonOutput){d.end();let e=await Ne(d),t=w(JSON.parse(e)).split(`
|
|
4
|
+
`);for(let e of t)c.write(`${e}\n`)}o=e.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),Se(e)&&(o=typeof e.exitCode==`number`?e.exitCode:1)}return o}function R(e){return`execute`in e}async function Re(e,t,r,i){let a=Ie(r,e,t,r.collect?.optionFlags??r.optionFlags),o=N(r.cwdOverride);try{let e=n(r.name,a,{cwd:o,env:{NO_COLOR:`1`},preferLocal:!0,reject:!1,stdin:`inherit`});i!==void 0&&e.stderr.pipe(i,{end:!1});let t=await e;return{cwd:o,exitCode:t.exitCode??1,stderr:t.stderr,stdout:t.stdout}}catch(e){return console.error(`${r.name} failed with error:`),console.error(e),{cwd:o,exitCode:Se(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function ze(e){return typeof e==`object`&&!!e&&`version`in e&&e.version===1&&`diagnostics`in e&&Array.isArray(e.diagnostics)&&`tools`in e&&Array.isArray(e.tools)}async function Be(e,t,n,r){let i=Date.now(),a=()=>Date.now()-i;if(R(r)){if(r.collect!==void 0)try{let{diagnostics:e,exitCode:i,unparsed:o}=await r.collect(t,n);return{diagnostics:e,exitCode:i,tools:[{durationMs:a(),exitCode:i,name:r.name,unparsed:o}]}}catch(e){return{diagnostics:[],exitCode:1,tools:[{durationMs:a(),exitCode:1,name:r.name,unparsed:[String(e)]}]}}let e=``,i=new s;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:a(),exitCode:o,name:r.name,unparsed:C(e)}]}}if(r.outputFormatAware){let i=await Re(t,n,r,e);try{let e=JSON.parse(i.stdout);if(!ze(e))throw Error(`Child output is not a lint report`);return{diagnostics:e.diagnostics,exitCode:i.exitCode,tools:e.tools}}catch{return{diagnostics:[],exitCode:i.exitCode,tools:[{durationMs:a(),exitCode:i.exitCode,name:r.name,unparsed:C(i.stdout)}]}}}let o=await Re(t,n,r);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(o);return{diagnostics:e,exitCode:o.exitCode,tools:[{durationMs:a(),exitCode:o.exitCode,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:o.exitCode,tools:[{durationMs:a(),exitCode:o.exitCode,name:r.name,unparsed:[...C(o.stdout),...C(o.stderr),String(e)]}]}}return{diagnostics:[],exitCode:o.exitCode,tools:[{durationMs:a(),exitCode:o.exitCode,name:r.name,unparsed:[...C(o.stdout),...C(o.stderr)]}]}}const Ve=/^ksc-/v;function z(e){return e.replace(Ve,``)}function B(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>z(e.trim()))}function V(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function He(e){return e.option(`format`,{choices:Ee,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 Ue(e,t){return t===`native`||t===`machine`&&!R(e)&&e.outputFormatAware===!0}function We(e,t){for(let n of t.diagnostics)e.write(`${ye(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function Ge(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(z(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>z(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>z(e.name)).join(`, `);e.write(`⚠️ ${f.yellow(`Unrecognized --skip ${I(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}async function H(e,t,n,r,i,a,o,s=`native`){let{commandsToRun:c,skippedCommands:l}=Ge(e,r,o??[]),u=[],d=[],p=[],m=s===`native`&&i;for(let r of c){if(Ue(r,s)){let i=await(R(r)?Fe(e,t,n,r,m):Le(e,t,n,r,m));u.push({exitCode:i,name:r.name});continue}let i=await Be(e,t,n,r);u.push({exitCode:i.exitCode,name:r.name}),d.push(...i.tools),p.push(...i.diagnostics),s===`machine`&&We(e,i)}let h=r.length;if(s===`native`&&l.length>0){let t=l.map(({name:e})=>e),n=f.bold(`${t.length} / ${h} ${I(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${f.dim(n)} ${f.dim(t.join(`, `))}\n`)}if(s===`native`&&a){let t=u.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=u.filter(({exitCode:e})=>e!==0).map(({name:e})=>e);if(t.length>0){let n=f.bold(`${t.length} / ${h} ${I(`Command`,t.length)} Succeeded:`);e.write(`✅ ${f.green(n)} ${f.green(t.join(`, `))}\n`)}if(n.length>0){let t=f.bold(`${n.length} / ${h} ${I(`Command`,n.length)} Failed:`);e.write(`❌ ${f.red(t)} ${f.red(n.join(`, `))}\n`)}}return{exitCode:+!u.every(({exitCode:e})=>e===0),report:s===`json`?xe(d,p):void 0}}async function Ke(e,t,n,a){let s=await u();if(s===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let c=await u({cwd:l(import.meta.url)});if(c===void 0)return e.write(`Error: The script being called was not in a package, weird.
|
|
5
|
+
`),1;let d=o.join(o.dirname(c),`init`),f=o.dirname(s),p=(t===`file`||t===`package`)&&n!==void 0&&a!==void 0;try{if(p){let n=Object.keys(a)[0],i=r.readJsonSync(s);if(t===`package`){e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let t=T(i,a);r.writeJSONSync(s,t,{spaces:` `}),await P(s)}else n!==void 0&&Object.keys(i).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete i[n],r.writeJSONSync(s,i,{spaces:` `}),await P(s))}if(!await r.pathExists(d))return 0;if((await r.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 r.copy(d,f,{async filter(a,s){let c=i.statSync(a).isFile(),l=i.existsSync(s);if(c){if(p&&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`)?Te(n,t):T(n,t);return r.writeJSONSync(s,i,{spaces:` `}),await P(s),!1}return l?(e.write(`Overwriting: \n"${a}" → "${s}"\n`),await P(s),!0):(e.write(`Copying: \n"${a}" → "${s}"\n`),await P(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function qe(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:u}=e;De();let d=F(s,o);d.pipe(O()===`json`?process.stderr:process.stdout);let f=p(m(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&f.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?V(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=B(e.skip),{exitCode:i}=await H(d,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return Ke(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]],void 0,void 0,r);process.exitCode=i}}),r!==void 0&&f.command({builder(e){let t=He(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?V(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=B(e.skip),i=O(),{exitCode:a,report:o}=await H(d,t,[],await L(r.commands),u,l,n,i);o!==void 0&&process.stdout.write(`${JSON.stringify(o,void 0,` `)}\n`),process.exitCode=a}}),t!==void 0&&f.command({builder(e){let n=He(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?V(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=B(e.skip),i=O(),{exitCode:a,report:o}=await H(d,n,[],await L(t.commands),void 0,void 0,r,i);o!==void 0&&process.stdout.write(`${JSON.stringify(o,void 0,` `)}\n`),process.exitCode=a}}),i!==void 0&&f.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?V(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=B(e.skip),{exitCode:a}=await H(d,n,[],await L(i.commands),u,l,r);process.exitCode=a}}),f.alias(`h`,`help`),f.version(ge),f.alias(`v`,`version`),f.help(),f.wrap(process.stdout.isTTY?Math.min(120,f.terminalWidth()):0),await f.parseAsync()}function U(e){return{async execute(t){let n=await W(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.
|
|
6
|
+
`),0;let o=w(r).split(`
|
|
7
|
+
`);for(let e of o)t.write(`${e}\n`);return 0},name:`Cosmiconfig ${e}`}}async function W(n){let r=e(n,{loaders:{".ts":t()},searchStrategy:`project`});try{let e=await r.search();if(e===null){console.error(`No ${n} configuration found.`);return}return e}catch(e){console.error(`Error while searching for ${n} configuration:`,e);return}}const G={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.`},Je=/['\u{2019}\u{2018}]s$/v;async function K(e=[`.`]){let t=await v().searchForConfigFile(void 0);if(t===void 0)throw Error(`No CSpell configuration found.`);let{settings:n,url:r}=t;if(n.words===void 0||n.words.length===0)return{errors:0,filesChecked:0,unusedWords:[]};let i=[...n.words];delete n.words;let a=await ue(e,{config:{settings:n,url:r},progress:!1,unique:!0,wordsOnly:!0},{issue({text:e,uri:t}){i=i.filter(n=>n.toLowerCase()!==e.toLowerCase().replace(Je,``)||t===r.href)}});return{errors:a.errors,filesChecked:a.files,unusedWords:i}}const Ye=new Set([`.cjs`,`.cts`,`.js`,`.mjs`,`.mts`,`.ts`]);async function Xe(e=[`**/*`]){let t=await v().searchForConfigFile(void 0);if(t===void 0)throw Error(`No CSpell configuration found.`);let n=l(t.url),r=[...t.settings.words??[]];if(r.length===0)return;let{errors:i,filesChecked:a,unusedWords:o}=await K(e);if(a===0||i>0)throw Error(`Refusing to modify "${n}": CSpell checked ${a} files with ${i} errors, so word usage can't be determined. Check your file globs and configuration.`);let s=new Set(o),c=r.filter(e=>!s.has(e)),u=Ze([...new Set(c)]);return Qe(u,r)?{configFilePath:n,removedWords:[],reordered:!1}:(await $e(t.url,u),{configFilePath:n,removedWords:[...s],reordered:!Qe(u,c)})}function Ze(e){return e.toSorted((e,t)=>{let n=e.toLowerCase().localeCompare(t.toLowerCase());return n===0?e.localeCompare(t):n})}function Qe(e,t){return e.length===t.length&&e.every((e,n)=>e===t[n])}async function $e(e,t){let n=l(e),r=o.extname(n).toLowerCase();if(Ye.has(r)){let e=await se(n),r=le(e);r.words=t,await ce(e,n),await P(n);return}let i=oe(),a=await i.readConfig(e);if(a.readonly)throw Error(`CSpell configuration file "${n}" can't be modified automatically. Please update the words list manually.`);a.setValue(`words`,t),await i.writeConfig(a)}async function et(){let e=await v().searchForConfigFile(void 0);return e===void 0?void 0:l(e.url)}async function tt(){let e=await v().searchForConfigFile(void 0);if(e===void 0)throw Error(`No CSpell configuration found.`);let t=await y(e);return t.ignorePaths===void 0?``:Array.from(t.ignorePaths,e=>typeof e==`string`?e:e.glob).join(`,`)}const nt=/^(?<file>.+?):(?<line>\d+):(?<column>\d+) - (?<message>.+)$/v,rt=/ fix: \((?<suggestion>[^\)]+)\)$/v;function it(e){let t=[],n=[];for(let r of C(`${e.stdout}\n${e.stderr}`)){let i=nt.exec(r);if(i?.groups===void 0){n.push(r);continue}let{column:a,file:o,line:s,message:c}=i.groups,l=rt.exec(c??``),u=l?.groups?.suggestion;t.push({column:Number(a),file:S(o??``,e.cwd),line:Number(s),message:l===null?c??``:(c??``).slice(0,-l[0].length),...u!==void 0&&{suggestion:u},severity:`warning`,tool:`cspell`})}return{diagnostics:t,unparsed:n}}async function at(e,t){let{errors:n,filesChecked:r,unusedWords:i}=await K(t);if(n>0||r===0&&i.length>0){let t=F(`[Unused Words]`,`cyanBright`);return t.pipe(e),t.write(`Could not check for unused words: CSpell checked ${r} files with ${n} errors.\n`),1}if(i.length>0){let t=F(`[Unused Words]`,`cyanBright`);t.pipe(e);for(let e of i)t.write(`${e}\n`);return 1}return 0}async function ot(e){let{errors:t,filesChecked:n,unusedWords:r}=await K(e);if(t>0||n===0&&r.length>0)return{diagnostics:[{message:`Could not check for unused words: CSpell checked ${n} files with ${t} errors`,severity:`error`,tool:`unused-words`}],exitCode:1,unparsed:[]};let i=await et(),a=i===void 0?{}:{file:S(i,process.cwd())};return{diagnostics:r.map(e=>({...a,message:`Unused word in CSpell config "words" array: ${e}`,severity:`warning`,tool:`unused-words`})),exitCode:+(r.length>0),unparsed:[]}}async function st(e,t){let n=F(`[Words]`,`cyanBright`);n.pipe(e);let r=await Xe(t);if(r===void 0)return 0;for(let e of r.removedWords)n.write(`Removed unused word: ${e}\n`);return r.reordered&&n.write(`Sorted the "words" array alphabetically.
|
|
8
|
+
`),0}async function ct(){let e=import.meta.resolve(`@kitschpatrol/cspell-config`),t=await u({cwd:o.dirname(l(e))});if(t===void 0)throw Error(`Could not find Case Police dictionary parent package.`);let n=o.join(o.dirname(t),`dictionaries`,`case-police.json`);try{await ae(n,a.F_OK)}catch{throw Error(`Case Police dictionary file "${n}" does not exist.`)}return n}const lt=/^(?<from>\S+) → (?<to>\S+)\s+(?<file>\S+):(?<line>\d+):(?<column>\d+)$/v;function ut(e){let t=[],n=[];for(let r of C(`${e.stdout}\n${e.stderr}`)){if(!r.includes(`→`))continue;let i=lt.exec(r);if(i?.groups===void 0){n.push(r);continue}let{column:a,file:o,from:s,line:c,to:l}=i.groups;t.push({column:Number(a),file:S(o??``,e.cwd),line:Number(c),message:`Case error: "${s}" should be "${l}"`,severity:`warning`,...l!==void 0&&{suggestion:l},tool:`case-police`})}return{diagnostics:t,unparsed:n}}async function dt(e){let t=await v().searchForConfigFile(void 0);if(t===void 0)throw Error(`No CSpell configuration found.`);e.write(`Found cspell readme configuration at "${l(t.url)}"\n`);let n=w(await y(t)).split(`
|
|
9
|
+
`);for(let t of n)e.write(`${t}\n`);return 0}const ft={commands:{fix:{commands:[{execute:st,name:`words`}],description:`Remove unused words from the local CSpell configuration's "words" array and sort it alphabetically. ${G.fileRun}`,positionalArgumentDefault:`**/*`,positionalArgumentMode:`optional`},init:{configFile:`cspell.config.ts`,configPackageJson:{cspell:{import:`@kitschpatrol/cspell-config`}},locationOptionFlag:!0},lint:{async commands(){return[{collect:{parse:it},name:`cspell`,optionFlags:[`--quiet`],receivePositionalArguments:!0},{collect:ot,execute:at,name:`unused-words`},{collect:{parse:ut},logColor:`cyanBright`,logPrefix:`[Case Police]`,name:`case-police`,optionFlags:[`--dict`,await ct(),`--ignore`,await tt()],outputFilter:e=>!e.includes(`→`),receivePositionalArguments:!0}]},description:`Check for spelling mistakes. ${G.fileRun}`,positionalArgumentDefault:`**/*`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:dt,name:`cspell-config`}],description:`Print the resolved CSpell configuration. ${G.packageSearch} ${G.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's CSpell shared configuration tools.`,logColor:`cyan`,logPrefix:`[CSpell]`,name:`ksc-cspell`,order:6};async function pt(e,t){let n,[r]=t;if(r===void 0)n=U(`eslint`);else{let t=o.join(process.cwd(),r);e.write(`Showing configuration for file: ${t}\n`),n={name:`eslint`,optionFlags:[`--print-config`],receivePositionalArguments:!0}}let{exitCode:i}=await H(e,t,[],[n]);return i}function mt(e){let t;try{t=JSON.parse(e.stdout)}catch{return{diagnostics:[],unparsed:[...C(e.stdout),...C(e.stderr)]}}let n=[];for(let r of t)for(let t of r.messages)n.push({column:t.column,endColumn:t.endColumn,endLine:t.endLine,file:S(r.filePath,e.cwd),line:t.line,message:t.message,rule:t.ruleId??void 0,severity:t.fatal===!0||t.severity===2?`error`:`warning`,tool:`eslint`});return{diagnostics:n,unparsed:C(e.stderr)}}const ht={commands:{fix:{commands:[{collect:{optionFlags:[`--fix`,`--format`,`json`],parse:mt},name:`eslint`,optionFlags:[`--fix`],receivePositionalArguments:!0}],description:`Fix your project with ESLint. ${G.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},init:{locationOptionFlag:!1},lint:{commands:[{collect:{optionFlags:[`--max-warnings`,`0`,`--format`,`json`],parse:mt},name:`eslint`,optionFlags:[`--max-warnings`,`0`],receivePositionalArguments:!0}],description:`Lint your project with ESLint. ${G.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:pt,name:`eslint-config`}],description:`Print the effective ESLint configuration. ${G.optionalFileRun} Use \`@eslint/config-inspector\` for a more detailed view.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's ESLint shared configuration tools.`,logColor:`magenta`,logPrefix:`[ESLint]`,name:`ksc-eslint`,order:4},gt={entry:[`{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{bin,lib,cli}/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`scripts/**/*.{js,mjs,cjs,ts,mts,cts}`,`.remarkrc.{js,mjs,cjs,ts,mts,cts}`,`cspell.config.{js,mjs,cjs,ts,mts,cts}`,`eslint.config.{js,mjs,cjs,ts,mts,cts}`,`mdat.config.{js,mjs,cjs,ts,mts,cts}`,`prettier.config.{js,mjs,cjs,ts,mts,cts}`,`stylelint.config.{js,mjs,cjs,ts,mts,cts}`],ignoreBinaries:[`ksc-repo`,`ksc-mdat`,`ksc-typescript`,`ksc-eslint`,`ksc-stylelint`,`ksc-cspell`,`ksc-knip`,`ksc-remark`,`ksc-prettier`,`op`,`gh`],ignoreDependencies:[`@kitschpatrol/cspell-config`,`@kitschpatrol/dict-en-wiktionary`,`@kitschpatrol/eslint-config`,`@kitschpatrol/knip-config`,`@kitschpatrol/mdat-config`,`@kitschpatrol/prettier-config`,`@kitschpatrol/remark-config`,`@kitschpatrol/repo-config`,`@kitschpatrol/stylelint-config`,`@kitschpatrol/typescript-config`,`@prettier/plugin-php`,`@prettier/plugin-ruby`,`@prettier/plugin-xml`,`prettier-plugin-packagejson`,`prettier-plugin-sh`,`prettier-plugin-tailwindcss`,`prettier-plugin-toml`,`remark-attribute-list`,`remark-directive`]},_t={binaries:`Unlisted binary`,catalog:`Unused catalog entry`,classMembers:`Unused class member`,dependencies:`Unused dependency`,devDependencies:`Unused devDependency`,duplicates:`Duplicate export`,enumMembers:`Unused enum member`,exports:`Unused export`,files:`Unused file`,namespaceMembers:`Unused namespace member`,nsExports:`Unused namespace export`,nsTypes:`Unused namespace type`,optionalPeerDependencies:`Unused optional peer dependency`,types:`Unused exported type`,unlisted:`Unlisted dependency`,unresolved:`Unresolved import`};function vt(e){return Array.isArray(e)?e.flatMap(e=>Array.isArray(e)?e:[e]):[]}function yt(e){let t;try{t=JSON.parse(e.stdout)}catch{return{diagnostics:[],unparsed:[...C(e.stdout),...C(e.stderr)]}}let n=[],r=t.issues??[];for(let t of r){let r=S(t.file,e.cwd);for(let[e,i]of Object.entries(t)){let t=_t[e];if(t!==void 0)for(let a of vt(i)){let i=typeof a==`string`?a:a.name,o=typeof a==`string`?{}:{column:a.col,line:a.line};n.push({...o,file:r,message:e===`files`?t:`${t}: ${i}`,rule:e,severity:`warning`,tool:`knip`})}}}return{diagnostics:n,unparsed:C(e.stderr)}}function bt(){if(ke()){let e=A(),t=j();if(e!==t){let n=o.relative(t,e);if(n!==``)return[`--workspace`,n.split(o.sep).join(`/`)]}}return[]}function xt(){return{knip:gt}}const St={commands:{init:{configFile:`knip.config.ts`,configPackageJson:xt(),locationOptionFlag:!0},lint:{commands:[{collect:{optionFlags:[`--no-progress`,`--no-config-hints`,...bt(),`--reporter`,`json`],parse:yt},cwdOverride:`workspace-root`,name:`knip`,optionFlags:[`--no-progress`,`--no-config-hints`,...bt()]}],description:`Check for unused code and dependencies. ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[U(`knip`)],description:`Print the effective Knip configuration. ${G.packageSearch} ${G.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Knip shared configuration tools.`,logColor:`cyan`,logPrefix:`[Knip]`,name:`ksc-knip`,order:7};async function Ct(){return(await W(`mdat`))?.filepath}async function wt(e){let t=`mdat`,n=await W(t);n!==void 0&&e.write(`Found ${t} readme configuration at "${n.filepath}"\n`);let r=w(await de({additionalConfig:await de()})).split(`
|
|
10
|
+
`);for(let t of r)e.write(`${t}\n`);return 0}async function Tt(e){let t=k(),n=await Ct(),r=[];for(let i of t)r.push({cwdOverride:i,name:`mdat`,optionFlags:n===void 0||n===``?[`--format`]:[`--config`,n,`--format`],subcommands:[e]});return r}const Et={commands:{fix:{commands:await Tt(`expand`),description:`Expand all Mdat content placeholders in your readme.md file(s). ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},init:{configFile:`mdat.config.ts`,configPackageJson:{mdat:{$import:`node_modules/@kitschpatrol/mdat-config/dist/index.js`}},locationOptionFlag:!0},lint:{commands:await Tt(`check`),description:`Validate that all Mdat content placeholders in your readme.md file(s) have been expanded and are up to date. ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:wt,name:`mdat-config`}],description:`Print the effective Mdat configuration. ${G.packageSearch}. ${G.monorepoSearch}.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Mdat shared configuration tools.`,logColor:`green`,logPrefix:`[Mdat Config]`,name:`ksc-mdat`,order:2},Dt=/^\[warn\] (?<file>\S+)$/v,Ot=/^\[error\] (?<message>.+)$/v;function kt(e){let t=[],n=[];for(let r of C(`${e.stdout}\n${e.stderr}`)){let i=Dt.exec(r);if(i?.groups?.file!==void 0){t.push({file:S(i.groups.file,e.cwd),message:`File is not formatted with Prettier`,severity:`warning`,tool:`prettier`});continue}if(r.startsWith(`[warn] Code style issues found`))continue;let a=Ot.exec(r);if(a?.groups?.message!==void 0){t.push({message:a.groups.message,severity:`error`,tool:`prettier`});continue}n.push(r)}return{diagnostics:t,unparsed:n}}const At=[`--log-level=warn`,`--plugin=@kitschpatrol/prettier-plugin-astro`,`--plugin=@prettier/plugin-php`,`--plugin=@prettier/plugin-ruby`,`--plugin=@prettier/plugin-xml`,`--plugin=prettier-plugin-jsdoc`,`--plugin=prettier-plugin-packagejson`,`--plugin=prettier-plugin-sh`,`--plugin=prettier-plugin-svelte`,`--plugin=prettier-plugin-toml`,`--ignore-path=${M(`.gitignore`)??`.gitignore`}`,`--ignore-path=${M(`.prettierignore`)??`.prettierignore`}`],jt={commands:{fix:{commands:[{collect:{parse:kt},name:`prettier`,optionFlags:[...At,`--write`],receivePositionalArguments:!0}],description:`Format files according to your Prettier configuration. ${G.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},init:{configFile:`prettier.config.ts`,configPackageJson:{prettier:`@kitschpatrol/prettier-config`},locationOptionFlag:!0},lint:{commands:[{collect:{parse:kt},name:`prettier`,optionFlags:[...At,`--check`],receivePositionalArguments:!0}],description:`Check that files are formatted according to your Prettier configuration. ${G.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},printConfig:{commands:[U(`prettier`)],description:`Print the effective Prettier configuration. ${G.packageSearch}. ${G.monorepoSearch}.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Prettier shared configuration tools.`,logColor:`blue`,logPrefix:`[Prettier]`,name:`ksc-prettier`,order:9},Mt={commands:{init:{configFile:`.remarkrc.js`,configPackageJson:{remarkConfig:{plugins:[`@kitschpatrol/remark-config`]}},locationOptionFlag:!0},printConfig:{commands:[U(`remark`)],description:`Print the effective Remark configuration. ${G.packageSearch} ${G.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Remark and Remark Lint shared configuration tools. (Actual linting and fixing is managed through @kitschpatrol/eslint-config.)`,logColor:`blue`,logPrefix:`[remarklint]`,name:`ksc-remark`,order:8},Nt=[/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],Pt=[`node_modules/**`,`test/**`];function Ft(e){let t=e;for(let e of Nt)e.lastIndex=0,t=t.replace(e,e=>e.replaceAll(/\d/gv,`X`));return t}const It=/(\d{4})\s*-\s*(\d{4})/v,Lt=/(\d{4})/v;function Rt(e,t){let n=Ft(e),r=It,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=Lt,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 zt(e){let t=new Date().getFullYear(),n=await fe([`**/license.txt`,`**/license`,...Pt.map(e=>`!${e}`)],{caseSensitiveMatch:!1,cwd:A(),followSymbolicLinks:!1,gitignore:!0}),r=[];for(let i of n)try{let n=await _.readFile(i,`utf8`),a=Rt(n,t);a!==n&&(r.push(i),e&&await _.writeFile(i,a,`utf8`))}catch(e){console.error(`Failed to process ${i}:`,e)}return r}async function Bt(e,t=!1){let n=await zt(t);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} license ${I(`file`,n.length)} with outdated copyright year:\n`);for(let t of n)e.write(` - ${t}\n`);return+!t}return 0}async function Vt(e){return Bt(e,!1)}async function Ht(){let e=await zt(!1);return{diagnostics:e.map(e=>({file:S(e,A()),message:`License file has an outdated copyright year`,severity:`error`,tool:`copyright-year`})),exitCode:+(e.length>0),unparsed:[]}}async function Ut(e){return Bt(e,!0)}const q=`pnpm-lock.yaml`;function Wt(e){let t=j(),n=o.resolve(e);for(;;){if(r.existsSync(o.join(n,q)))return n;if(n===t)break;let e=o.dirname(n);if(e===n)break;n=e}}function Gt(e,t,n){let r=`${e}@${t}`;if(Object.hasOwn(n,r))return r;if(Object.hasOwn(n,t))return t}function Kt(e,t){return e===void 0||e===``?t===void 0||t===``?void 0:t:t===void 0||t===``||x(e,t)?e:t}async function qt(e){let t=Wt(e);if(t===void 0||t===``)throw Error(`${q} not found at or above "${e}".`);let n=o.join(t,q),r=await me(t,{ignoreIncompatible:!1});if(!r?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let i=r.packages??{},a,s,c={},l={};function u(e,t){let n,r=new Set;function a(e,t){if(t.startsWith(`link:`))return;let o=Gt(e,t,i);if(o===void 0||o===``||r.has(o))return;r.add(o);let s=i[o];if(s===void 0)return;let c=s.engines?.node;if(c!==void 0&&c!==``){let e=pe(c)?.version;e!==void 0&&e!==``&&(n===void 0||n===``||x(e,n))&&(n=e)}if(s.dependencies)for(let[e,t]of Object.entries(s.dependencies))a(e,t)}return a(e,t),n}function d(e,t){for(let[n,r]of Object.entries(e)){let e=u(n,typeof r==`string`?r:r.version);if(e!==void 0&&e!==``){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:a;(i===void 0||i===``||x(e,i))&&(t?s=e:a=e)}}}let f=o.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=Kt(a,s),g=h===void 0?void 0:`>=${h}`;return{dependencies:a!==void 0&&a!==``?{topLevelCauses:[...c[a]??[]],version:`>=${a}`}:void 0,devDependencies:s!==void 0&&s!==``?{topLevelCauses:[...l[s]??[]],version:`>=${s}`}:void 0,lockfile:n,version:g}}function Jt(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function Yt(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 Xt(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 J(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function Zt(e,t){let n=o.join(t,`package.json`);if(!r.existsSync(n))return{issues:[],packageJsonPath:n};let i=r.readJsonSync(n),a=i.engines?.node,s=Jt(i),c=await qt(t),l=c.dependencies?.version,u=c.dependencies?.topLevelCauses??[],d=c.version,f=c.devDependencies?.topLevelCauses??[],p=[];if(l!==void 0)if(a===void 0){if(p.push(`Missing engines.node — suggest setting to "${l}"${J(u)}`),e){let e=i.engines??{};e.node=l,i.engines=e}}else{let t=b.minVersion(a),n=b.minVersion(l);t&&n&&b.lt(t,n)&&(p.push(`engines.node is "${a}" but production dependencies require at least "${l}"${J(u)}`),e&&(i.engines.node=l))}let m=(()=>{if(l!==void 0&&l!==``&&a!==void 0&&a!==``){let e=b.minVersion(l),t=b.minVersion(a);if(e&&t)return b.gt(e,t)?l:a}return l??a})(),h=m!==void 0&&m!==``?b.minVersion(m):void 0,g=d!==void 0&&d!==``?b.minVersion(d):void 0,ee=g&&h&&b.gt(g,h);if(d!==void 0&&ee)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}"${J(f)}`),e&&Yt(i,d);else{let t=b.minVersion(s);t&&b.lt(t,g)&&(p.push(`devEngines.runtime.version for node is "${s}" but all dependencies require at least "${d}"${J(f)}`),e&&Yt(i,d))}else if(s!==void 0){let t=b.minVersion(s);t&&h&&b.lte(t,h)&&(p.push(`devEngines.runtime.version for node is redundant (engines.node already covers the requirement) — suggest removing`),e&&Xt(i))}return e&&p.length>0&&(r.writeJsonSync(n,i,{spaces:` `}),await P(n)),{issues:p,packageJsonPath:n}}async function Y(e,t){let n=k(),r=0;for(let i of n){let{issues:n,packageJsonPath:a}=await Zt(t,i);if(n.length>0){e.write(`${t?`Fixed`:`Found`} ${n.length} Node.js version ${I(`issue`,n.length)} in ${a}:\n`);for(let t of n)e.write(` - ${t}\n`);t||(r=1)}}return r}async function Qt(){let e=k(),t=[];for(let n of e){let{issues:e,packageJsonPath:r}=await Zt(!1,n);for(let n of e)t.push({file:S(r,process.cwd()),message:n,severity:`error`,tool:`node-version`})}return{diagnostics:t,exitCode:+(t.length>0),unparsed:[]}}async function $t(e){let t=w(await qt(A())).split(`
|
|
11
|
+
`);for(let n of t)e.write(`${n}\n`);return 0}async function en(e){return Y(e,!1)}async function tn(e){return Y(e,!0)}const nn={commands:{fix:{commands:[{execute:Ut,name:`copyright-year`},{execute:tn,name:`node-version`}],description:`Fix common issues like outdated copyright years in license files. ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{collect:Ht,execute:Vt,name:`copyright-year`},{collect:Qt,execute:en,name:`node-version`}],description:`Check the repo for common issues. ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:$t,name:`node-version`}],description:`Print minimum Node.js version constraints from the pnpm lockfile.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's repository-related shared configuration tools.`,logColor:`gray`,logPrefix:`[Repo Config]`,name:`ksc-repo`,order:1},X=[`--ignore-path`,M(`.gitignore`)??`.gitignore`,`--allow-empty-input`],rn=`**/*.{${[`css`,`scss`,`sass`,`svelte`,`html`,`astro`,`tsx`,`jsx`,`php`,`vue`].join(`,`)}}`;function Z(e){let t;try{t=JSON.parse(e.stderr)}catch{return{diagnostics:[],unparsed:[...C(e.stdout),...C(e.stderr)]}}let n=[];for(let r of t){let t=S(r.source,e.cwd);for(let e of r.warnings){let r=e.rule===void 0?void 0:` (${e.rule})`,i=r!==void 0&&e.text.endsWith(r)?e.text.slice(0,-r.length):e.text;n.push({column:e.column,endColumn:e.endColumn,endLine:e.endLine,file:t,line:e.line,message:i,rule:e.rule,severity:e.severity===`warning`?`warning`:`error`,tool:`stylelint`})}let i=r.parseErrors??[];for(let e of i)n.push({column:e.column,file:t,line:e.line,message:e.text,rule:`parse-error`,severity:`error`,tool:`stylelint`})}return{diagnostics:n,unparsed:C(e.stdout)}}async function an(e,t){let n=`stylelint`,r=await W(n);if(r===void 0)return 1;let{filepath:i,isEmpty:a}=r;if(a)return e.write(`Configuration is empty.
|
|
12
|
+
`),0;e.write(`Found ${n} configuration at "${i}"\n`);let s,[c]=t;c===void 0?s=N(`package-dir`):(s=o.join(process.cwd(),c),e.write(`Showing config for file at "${s}"\n`));let l=w(await he.resolveConfig(s)).split(`
|
|
13
|
+
`);for(let t of l)e.write(`${t}\n`);return 0}const on={commands:{fix:{commands:[{collect:{optionFlags:[...X,`--fix`,`--formatter`,`json`],parse:Z},name:`stylelint`,optionFlags:[...X,`--fix`],receivePositionalArguments:!0}],description:`Fix your project with Stylelint. ${G.fileRun}`,positionalArgumentDefault:rn,positionalArgumentMode:`optional`},init:{configFile:`stylelint.config.js`,configPackageJson:{stylelint:{extends:`@kitschpatrol/stylelint-config`}},locationOptionFlag:!0},lint:{commands:[{collect:{optionFlags:[...X,`--formatter`,`json`],parse:Z},name:`stylelint`,optionFlags:X,receivePositionalArguments:!0}],description:`Lint your project with Stylelint. ${G.fileRun}`,positionalArgumentDefault:rn,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:an,name:`stylelint-config`}],description:`Print the effective Stylelint configuration. ${G.optionalFileRun}.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's Stylelint shared configuration tools.`,logColor:`greenBright`,logPrefix:`[Stylelint]`,name:`ksc-stylelint`,order:5},sn=/^(?<file>.+?)\((?<line>\d+),(?<column>\d+)\): (?<severity>error|warning) (?<code>TS\d+): (?<message>.*)$/v,cn=/^(?<severity>error|warning) (?<code>TS\d+): (?<message>.*)$/v,ln=/^\s/v;function un(e){let t=[],n=[];for(let r of C(`${e.stdout}\n${e.stderr}`)){let i=sn.exec(r);if(i?.groups!==void 0){let{code:n,column:r,file:a,line:o,message:s,severity:c}=i.groups;t.push({column:Number(r),file:S(a??``,e.cwd),line:Number(o),message:s??``,rule:n,severity:c===`warning`?`warning`:`error`,tool:`tsc`});continue}let a=cn.exec(r);if(a?.groups!==void 0){let{code:e,message:n,severity:r}=a.groups;t.push({message:n??``,rule:e,severity:r===`warning`?`warning`:`error`,tool:`tsc`});continue}let o=t.at(-1);if(o!==void 0&&ln.test(r)){o.message+=`\n${r.trim()}`;continue}n.push(r)}return{diagnostics:t,unparsed:n}}async function dn(){let e=A(),t=await r.readJson(o.join(e,`package.json`));return new Set([...Object.keys(t.dependencies??{}),...Object.keys(t.devDependencies??{})])}async function fn(){let e=await dn(),t=e.has(`@astrojs/check`),n=e.has(`svelte-check`);if(t||n){let e=[];return t&&e.push({cwdOverride:`package-dir`,name:`astro`,subcommands:[`check`]}),n&&e.push({cwdOverride:`package-dir`,name:`svelte-check`,optionFlags:t?[]:[`--tsconfig`,`./tsconfig.json`]}),e}return[{collect:{parse:un},cwdOverride:`package-dir`,name:`tsc`,optionFlags:[`--noEmit`]}]}const Q=[ht,ft,St,Et,jt,Mt,nn,on,{commands:{init:{locationOptionFlag:!1},lint:{commands:fn,description:`Run type checking on your project. ${G.packageRun} ${G.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{name:`tsc`,optionFlags:[`--showConfig`],prettyJsonOutput:!0}],description:`Print the TypeScript configuration for the project. ${G.packageSearch} ${G.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's TypeScript shared configuration tools.`,logColor:`blueBright`,logPrefix:`[TypeScript Config]`,name:`ksc-typescript`,order:3}];function $(e,t){t.sort((e,t)=>e.order-t.order);let n=[];for(let r of t)Object.keys(r.commands).includes(e)&&n.push({name:r.name,...e===`init`?{receiveOptionFlags:r.commands[e]?.locationOptionFlag??!1}:{receivePositionalArguments:r.commands[e]?.positionalArgumentMode!==`none`},...(e===`lint`||e===`fix`)&&{outputFormatAware:!0},subcommands:[Pe(e)]});return n}await qe({commands:{fix:{commands:$(`fix`,Q),description:`Fix your project with multiple tools in one go. ${G.multiArgumentCaveat}`,positionalArgumentMode:`optional`},init:{commands:$(`init`,Q),description:`Initialize configuration files for the entire suite of @kitschpatrol/shared-config tools. ${G.multiOptionCaveat}`,locationOptionFlag:!0},lint:{commands:$(`lint`,Q),description:`Lint your project with multiple tools in one go. ${G.multiArgumentCaveat}`,positionalArgumentMode:`optional`},printConfig:{commands:$(`printConfig`,Q),description:`Print aggregated tool configuration data. ${G.multiArgumentCaveat}`,positionalArgumentMode:`optional`}},description:`Run aggregated @kitschpatrol/shared-config commands.`,logColor:`yellow`,logPrefix:`🔬`,name:`ksc`,order:0,showSummary:!0,verbose:!0});export{};
|
package/dist/index.d.ts
CHANGED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "2.0.0",
|
|
3
|
+
"tasks": [
|
|
4
|
+
{
|
|
5
|
+
"label": "ksc lint",
|
|
6
|
+
"detail": "Lint your project with multiple tools in one go.",
|
|
7
|
+
"type": "shell",
|
|
8
|
+
"command": "pnpm exec ksc lint --format machine",
|
|
9
|
+
"options": {
|
|
10
|
+
"cwd": "${workspaceFolder}"
|
|
11
|
+
},
|
|
12
|
+
"presentation": {
|
|
13
|
+
"clear": true,
|
|
14
|
+
"echo": true,
|
|
15
|
+
"focus": false,
|
|
16
|
+
"panel": "dedicated",
|
|
17
|
+
"reveal": "silent",
|
|
18
|
+
"revealProblems": "onProblem",
|
|
19
|
+
"showReuseMessage": false
|
|
20
|
+
},
|
|
21
|
+
"problemMatcher": [
|
|
22
|
+
{
|
|
23
|
+
"owner": "ksc",
|
|
24
|
+
"source": "ksc",
|
|
25
|
+
"fileLocation": ["relative", "${workspaceFolder}"],
|
|
26
|
+
"pattern": {
|
|
27
|
+
"regexp": "^(.+?):(\\d+):(\\d+): (error|warning|info): (.+) \\[([^\\]]+)\\]$",
|
|
28
|
+
"file": 1,
|
|
29
|
+
"line": 2,
|
|
30
|
+
"column": 3,
|
|
31
|
+
"severity": 4,
|
|
32
|
+
"message": 5,
|
|
33
|
+
"code": 6
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"label": "ksc fix",
|
|
40
|
+
"detail": "Fix your project with multiple tools in one go.",
|
|
41
|
+
"type": "shell",
|
|
42
|
+
"command": "pnpm exec ksc fix --format machine",
|
|
43
|
+
"options": {
|
|
44
|
+
"cwd": "${workspaceFolder}"
|
|
45
|
+
},
|
|
46
|
+
"presentation": {
|
|
47
|
+
"clear": true,
|
|
48
|
+
"echo": true,
|
|
49
|
+
"focus": false,
|
|
50
|
+
"panel": "dedicated",
|
|
51
|
+
"reveal": "silent",
|
|
52
|
+
"revealProblems": "onProblem",
|
|
53
|
+
"showReuseMessage": false
|
|
54
|
+
},
|
|
55
|
+
"problemMatcher": [
|
|
56
|
+
{
|
|
57
|
+
"owner": "ksc",
|
|
58
|
+
"source": "ksc",
|
|
59
|
+
"fileLocation": ["relative", "${workspaceFolder}"],
|
|
60
|
+
"pattern": {
|
|
61
|
+
"regexp": "^(.+?):(\\d+):(\\d+): (error|warning|info): (.+) \\[([^\\]]+)\\]$",
|
|
62
|
+
"file": 1,
|
|
63
|
+
"line": 2,
|
|
64
|
+
"column": 3,
|
|
65
|
+
"severity": 4,
|
|
66
|
+
"message": 5,
|
|
67
|
+
"code": 6
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
]
|
|
73
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/shared-config",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.2.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",
|
|
@@ -49,11 +49,12 @@
|
|
|
49
49
|
},
|
|
50
50
|
"files": [
|
|
51
51
|
"bin/*",
|
|
52
|
-
"dist/*"
|
|
52
|
+
"dist/*",
|
|
53
|
+
"init/*"
|
|
53
54
|
],
|
|
54
55
|
"dependencies": {
|
|
55
56
|
"@pinojs/json-colorizer": "^4.0.0",
|
|
56
|
-
"@pnpm/lockfile.fs": "^1100.1.
|
|
57
|
+
"@pnpm/lockfile.fs": "^1100.1.8",
|
|
57
58
|
"cosmiconfig": "^9.0.2",
|
|
58
59
|
"cosmiconfig-typescript-loader": "^6.3.0",
|
|
59
60
|
"cspell": "^10.0.1",
|
|
@@ -65,25 +66,25 @@
|
|
|
65
66
|
"execa": "^9.6.1",
|
|
66
67
|
"find-workspaces": "^0.3.1",
|
|
67
68
|
"fs-extra": "^11.3.6",
|
|
68
|
-
"globby": "^16.2.
|
|
69
|
+
"globby": "^16.2.1",
|
|
69
70
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
70
71
|
"magicast": "^0.5.3",
|
|
71
72
|
"mdat": "^2.3.6",
|
|
72
73
|
"package-up": "^5.0.0",
|
|
73
74
|
"picocolors": "^1.1.1",
|
|
74
|
-
"prettier": "^3.9.
|
|
75
|
+
"prettier": "^3.9.5",
|
|
75
76
|
"semver": "^7.8.5",
|
|
76
77
|
"stylelint": "^17.14.0",
|
|
77
78
|
"yargs": "^18.0.0",
|
|
78
|
-
"@kitschpatrol/cspell-config": "8.
|
|
79
|
-
"@kitschpatrol/
|
|
80
|
-
"@kitschpatrol/
|
|
81
|
-
"@kitschpatrol/
|
|
82
|
-
"@kitschpatrol/
|
|
83
|
-
"@kitschpatrol/
|
|
84
|
-
"@kitschpatrol/stylelint-config": "8.
|
|
85
|
-
"@kitschpatrol/
|
|
86
|
-
"@kitschpatrol/
|
|
79
|
+
"@kitschpatrol/cspell-config": "8.2.0",
|
|
80
|
+
"@kitschpatrol/knip-config": "8.2.0",
|
|
81
|
+
"@kitschpatrol/mdat-config": "8.2.0",
|
|
82
|
+
"@kitschpatrol/eslint-config": "8.2.0",
|
|
83
|
+
"@kitschpatrol/remark-config": "8.2.0",
|
|
84
|
+
"@kitschpatrol/repo-config": "8.2.0",
|
|
85
|
+
"@kitschpatrol/stylelint-config": "8.2.0",
|
|
86
|
+
"@kitschpatrol/prettier-config": "8.2.0",
|
|
87
|
+
"@kitschpatrol/typescript-config": "8.2.0"
|
|
87
88
|
},
|
|
88
89
|
"engines": {
|
|
89
90
|
"node": "^24.16.0 || >=26.3.0"
|
package/readme.md
CHANGED
|
@@ -274,11 +274,12 @@ ksc lint [files..]
|
|
|
274
274
|
| ------------------- | ------------------------------ | ------- | ------- |
|
|
275
275
|
| `files` | Files or glob pattern to lint. | `array` | `[]` |
|
|
276
276
|
|
|
277
|
-
| Option | Description
|
|
278
|
-
| ------------------- |
|
|
279
|
-
| `--
|
|
280
|
-
| `--
|
|
281
|
-
| `--
|
|
277
|
+
| Option | Description | Type | Default |
|
|
278
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
279
|
+
| `--format` | Output format: "native" streams each tool's own output, "machine" prints one parseable line per issue for editor problem matchers, "json" prints an aggregate report. | `"json"` `"machine"` `"native"` | `"native"` |
|
|
280
|
+
| `--skip` | Tool names to skip (with or without "ksc-" prefix). | `array` | |
|
|
281
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
282
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
282
283
|
|
|
283
284
|
#### Subcommand: `ksc fix`
|
|
284
285
|
|
|
@@ -294,11 +295,12 @@ ksc fix [files..]
|
|
|
294
295
|
| ------------------- | ----------------------------- | ------- | ------- |
|
|
295
296
|
| `files` | Files or glob pattern to fix. | `array` | `[]` |
|
|
296
297
|
|
|
297
|
-
| Option | Description
|
|
298
|
-
| ------------------- |
|
|
299
|
-
| `--
|
|
300
|
-
| `--
|
|
301
|
-
| `--
|
|
298
|
+
| Option | Description | Type | Default |
|
|
299
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
300
|
+
| `--format` | Output format: "native" streams each tool's own output, "machine" prints one parseable line per issue for editor problem matchers, "json" prints an aggregate report. | `"json"` `"machine"` `"native"` | `"native"` |
|
|
301
|
+
| `--skip` | Tool names to skip (with or without "ksc-" prefix). | `array` | |
|
|
302
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
303
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
302
304
|
|
|
303
305
|
#### Subcommand: `ksc print-config`
|
|
304
306
|
|
|
@@ -350,6 +352,21 @@ clearCache()
|
|
|
350
352
|
|
|
351
353
|
Each sub-package with a `fix` command also exports its own `fix`, `fixFile`, and `clearCache` for standalone use. See the individual package readmes for details. (With the exception of, `ksc-repo`, whose `fix` behavior is too file-specific to be generically useful.)
|
|
352
354
|
|
|
355
|
+
### VS Code tasks
|
|
356
|
+
|
|
357
|
+
`ksc init` assembles a `.vscode/tasks.json` for your project. The `ksc` package contributes two aggregate tasks:
|
|
358
|
+
|
|
359
|
+
- **`ksc lint`** runs `ksc lint --format machine` runs all `ksc lint` tools across the whole project
|
|
360
|
+
- **`ksc fix`** runs `ksc fix --format machine`, applies all `ksc fix` auto-fixes, and reports anything unfixable
|
|
361
|
+
|
|
362
|
+
Each tool package's `init` (invoked by `ksc init`) also contributes granular tasks for the commands it supports — `ksc-eslint lint`, `ksc-eslint fix`, `ksc-typescript lint`, and so on — so a single tool can be run without invoking the whole suite.
|
|
363
|
+
|
|
364
|
+
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
365
|
+
|
|
366
|
+
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/debugtest/debugging#_errors-and-warnings) with every 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.
|
|
367
|
+
|
|
368
|
+
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.
|
|
369
|
+
|
|
353
370
|
## Implementation notes
|
|
354
371
|
|
|
355
372
|
### Line endings
|