@kitschpatrol/typescript-config 8.1.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 +4 -5
- package/init/.vscode/tasks.json +39 -0
- package/init/tsconfig.json +3 -2
- package/package.json +1 -1
- package/readme.md +31 -7
- package/tsconfigs/base.json +0 -1
package/bin/cli.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import f from"@pinojs/json-colorizer";import
|
|
3
|
-
`)
|
|
4
|
-
`)}})}
|
|
5
|
-
`);
|
|
6
|
-
`),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0],r=t.readJsonSync(l);if(i===`package`){e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=C(r,c);t.writeJSONSync(l,i,{spaces:` `}),await O(l)}else n!==void 0&&Object.keys(r).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete r[n],t.writeJSONSync(l,r,{spaces:` `}),await O(l))}if(!await t.pathExists(d))return 0;if((await t.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await t.copy(d,f,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(p&&i===`package`&&o.includes(a))return l?(e.write(`Deleting: \n"${o}" → "${s}" (Because --location is set to "package")\n`),t.removeSync(s)):e.write(`Skipping: \n"${o}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&r.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=C(t.readJSONSync(s),n);return t.writeJSONSync(s,r,{spaces:` `}),await O(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await O(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await O(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function U(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e,p=j(s,o);p.pipe(process.stdout);let m=u(d(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&m.command({builder(e){let t=n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`Where to store the configuration.`,type:`string`}):e;return l?B(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=z(e.skip),i=await V(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return H(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=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?B(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=z(e.skip),i=await V(p,t,[],r.commands,f,l,n);process.exitCode=i}}),t!==void 0&&m.command({builder(e){let n=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?B(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=z(e.skip),i=await V(p,n,[],t.commands,void 0,void 0,r);process.exitCode=i}}),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?B(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=z(e.skip),a=await V(p,n,[],i.commands,f,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(y),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const W={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.`};async function G(){let e=w(),n=[`svelte.config.js`,`svelte.config.mjs`,`svelte.config.cjs`].map(async n=>t.exists(r.join(e,n)));return(await Promise.all(n)).some(Boolean)}async function K(e){return e.write("Skipping `tsc` since this is a Svelte project. Consider running `svelte-check` instead.\n"),0}async function q(){return await G()?[{execute:K,name:K.name}]:[{cwdOverride:`package-dir`,name:`tsc`,optionFlags:[`--noEmit`]}]}await U({commands:{init:{locationOptionFlag:!1},lint:{commands:await q(),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});export{};
|
|
2
|
+
import"cosmiconfig";import"cosmiconfig-typescript-loader";import{execa as e}from"execa";import t from"fs-extra";import n from"node:fs";import r from"node:path";import{PassThrough as i,Transform as a}from"node:stream";import{fileURLToPath as o}from"node:url";import{packageUp as s,packageUpSync as c}from"package-up";import l from"picocolors";import u from"yargs";import{hideBin as d}from"yargs/helpers";import{stripVTControlCharacters as f}from"node:util";import p from"@pinojs/json-colorizer";import m from"decircular";import h from"deepmerge";import ee from"json-stringify-pretty-compact";import{findWorkspacesRoot as te}from"find-workspaces";import g from"node:fs/promises";var _=`8.2.0`;function ne(e,t){let n=r.isAbsolute(e)?e:r.resolve(t,e),i=r.relative(process.cwd(),n);return i===``?`.`:i}const v=/\s*\n\s*/gv,y=/\r?\n/v;function b(e){let t=e.message.replaceAll(v,` `),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 x(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 S(e,t){let n=t.toSorted(x);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 f(e).split(y).map(e=>e.trimEnd()).filter(e=>e.trim().length>0)}function w(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function re(e){return p(ee(m(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const ie=(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:ie}){return h(e,t,n)}function E(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function D(e,t){let n=[...E(e)];for(let e of E(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 O=[`json`,`machine`,`native`],ae=O;function k(e){return typeof e==`string`&&O.includes(e)}function A(){let e=process.env.KSC_FORMAT;return k(e)?e:`native`}function j(){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)),k(r)&&(process.env.KSC_FORMAT=r)}}function M(){let e=c();if(e===void 0)throw Error(`No package.json found.`);return r.dirname(e)}function N(){let e=te();return e===null?M():r.resolve(e.location)}function P(e){if(e===`workspace-root`)return N();if(e===`package-dir`)return M();if(typeof e==`string`){if(!t.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function oe(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await g.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function F(e){try{await oe(e,await g.readFile(e,`utf8`))}catch{}}const I=/\r?\n/v;function L(e){let t=``,n=t=>t.filter(t=>t.trim()!==``&&!e(f(t))).map(e=>`${e}\n`).join(``);return new a({flush(e){e(void 0,n([t]))},transform(e,r,i){let a=(t+e.toString()).split(I);t=a.pop()??``,i(void 0,n(a))}})}function R(e,t){let n=A()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:l[t](n),i=``,o=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new a({flush(e){e(void 0,o([i]))},transform(e,t,n){let r=(i+e.toString()).split(I);i=r.pop()??``,n(void 0,o(r))}})}async function z(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 B(e,t){return t===1?e:e+`s`}async function V(e){return typeof e==`function`?e():e}async function H(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(l.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 U(e,t,n,r){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function W(t,n,r,a,o){let s=1,c;if(a.logPrefix===void 0)c=t;else{let e=R(a.logPrefix,a.logColor);e.pipe(t),c=e}let l=U(a,n,r,a.optionFlags),u=P(a.cwdOverride);o&&c.write(`Running: "${a.name} ${l.join(` `)}"\n`);let d=a.prettyJsonOutput?new i:c,f=A()===`native`?process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}:{NO_COLOR:`1`};try{let t=e(a.name,l,{cwd:u,env:{...f},preferLocal:!0,reject:!1,stdin:`inherit`});if(a.outputFilter){let e=L(a.outputFilter),n=L(a.outputFilter);t.stdout.pipe(e).pipe(d,{end:!1}),t.stderr.pipe(n).pipe(d,{end:!1})}else t.stdout.pipe(d,{end:!1}),t.stderr.pipe(d,{end:!1});if(await t,a.prettyJsonOutput){d.end();let e=await z(d),t=re(JSON.parse(e)).split(`
|
|
4
|
+
`);for(let e of t)c.write(`${e}\n`)}s=t.exitCode??1}catch(e){console.error(`${a.name} failed with error:`),console.error(e),w(e)&&(s=typeof e.exitCode==`number`?e.exitCode:1)}return s}function G(e){return`execute`in e}async function K(t,n,r,i){let a=U(r,t,n,r.collect?.optionFlags??r.optionFlags),o=P(r.cwdOverride);try{let t=e(r.name,a,{cwd:o,env:{NO_COLOR:`1`},preferLocal:!0,reject:!1,stdin:`inherit`});i!==void 0&&t.stderr.pipe(i,{end:!1});let n=await t;return{cwd:o,exitCode:n.exitCode??1,stderr:n.stderr,stdout:n.stdout}}catch(e){return console.error(`${r.name} failed with error:`),console.error(e),{cwd:o,exitCode:w(e)&&typeof e.exitCode==`number`?e.exitCode:1,stderr:``,stdout:``}}}function se(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 ce(e,t,n,r){let a=Date.now(),o=()=>Date.now()-a;if(G(r)){if(r.collect!==void 0)try{let{diagnostics:e,exitCode:i,unparsed:a}=await r.collect(t,n);return{diagnostics:e,exitCode:i,tools:[{durationMs:o(),exitCode:i,name:r.name,unparsed:a}]}}catch(e){return{diagnostics:[],exitCode:1,tools:[{durationMs:o(),exitCode:1,name:r.name,unparsed:[String(e)]}]}}let e=``,a=new i;a.on(`data`,t=>{e+=t.toString()});let s;try{s=await r.execute(a,t,n)}catch(t){e+=`\n${String(t)}`,s=1}return{diagnostics:[],exitCode:s,tools:[{durationMs:o(),exitCode:s,name:r.name,unparsed:C(e)}]}}if(r.outputFormatAware){let i=await K(t,n,r,e);try{let e=JSON.parse(i.stdout);if(!se(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:o(),exitCode:i.exitCode,name:r.name,unparsed:C(i.stdout)}]}}}let s=await K(t,n,r);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(s);return{diagnostics:e,exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:t}]}}catch(e){return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...C(s.stdout),...C(s.stderr),String(e)]}]}}return{diagnostics:[],exitCode:s.exitCode,tools:[{durationMs:o(),exitCode:s.exitCode,name:r.name,unparsed:[...C(s.stdout),...C(s.stderr)]}]}}const le=/^ksc-/v;function q(e){return e.replace(le,``)}function J(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>q(e.trim()))}function Y(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function X(e){return e.option(`format`,{choices:ae,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`&&!G(e)&&e.outputFormatAware===!0}function de(e,t){for(let n of t.diagnostics)e.write(`${b(n)}\n`);for(let n of t.tools)for(let t of n.unparsed)e.write(`${t}\n`)}function fe(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(q(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>q(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>q(e.name)).join(`, `);e.write(`⚠️ ${l.yellow(`Unrecognized --skip ${B(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}async function Z(e,t,n,r,i,a,o,s=`native`){let{commandsToRun:c,skippedCommands:u}=fe(e,r,o??[]),d=[],f=[],p=[],m=s===`native`&&i;for(let r of c){if(ue(r,s)){let i=await(G(r)?H(e,t,n,r,m):W(e,t,n,r,m));d.push({exitCode:i,name:r.name});continue}let i=await ce(e,t,n,r);d.push({exitCode:i.exitCode,name:r.name}),f.push(...i.tools),p.push(...i.diagnostics),s===`machine`&&de(e,i)}let h=r.length;if(s===`native`&&u.length>0){let t=u.map(({name:e})=>e),n=l.bold(`${t.length} / ${h} ${B(`Command`,t.length)} Skipped:`);e.write(`⏭️ ${l.dim(n)} ${l.dim(t.join(`, `))}\n`)}if(s===`native`&&a){let t=d.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=d.filter(({exitCode:e})=>e!==0).map(({name:e})=>e);if(t.length>0){let n=l.bold(`${t.length} / ${h} ${B(`Command`,t.length)} Succeeded:`);e.write(`✅ ${l.green(n)} ${l.green(t.join(`, `))}\n`)}if(n.length>0){let t=l.bold(`${n.length} / ${h} ${B(`Command`,n.length)} Failed:`);e.write(`❌ ${l.red(t)} ${l.red(n.join(`, `))}\n`)}}return{exitCode:+!d.every(({exitCode:e})=>e===0),report:s===`json`?S(f,p):void 0}}async function pe(e,i,a,c){let l=await s();if(l===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let u=await s({cwd:o(import.meta.url)});if(u===void 0)return e.write(`Error: The script being called was not in a package, weird.
|
|
5
|
+
`),1;let d=r.join(r.dirname(u),`init`),f=r.dirname(l),p=(i===`file`||i===`package`)&&a!==void 0&&c!==void 0;try{if(p){let n=Object.keys(c)[0],r=t.readJsonSync(l);if(i===`package`){e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=T(r,c);t.writeJSONSync(l,i,{spaces:` `}),await F(l)}else n!==void 0&&Object.keys(r).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete r[n],t.writeJSONSync(l,r,{spaces:` `}),await F(l))}if(!await t.pathExists(d))return 0;if((await t.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await t.copy(d,f,{async filter(o,s){let c=n.statSync(o).isFile(),l=n.existsSync(s);if(c){if(p&&i===`package`&&o.includes(a))return l?(e.write(`Deleting: \n"${o}" → "${s}" (Because --location is set to "package")\n`),t.removeSync(s)):e.write(`Skipping: \n"${o}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&r.extname(s)===`.json`){e.write(`Merging: \n"${o}" → "${s}"\n`);let n=t.readJSONSync(o),r=t.readJSONSync(s),i=s.endsWith(`.vscode/tasks.json`)?D(r,n):T(r,n);return t.writeJSONSync(s,i,{spaces:` `}),await F(s),!1}return l?(e.write(`Overwriting: \n"${o}" → "${s}"\n`),await F(s),!0):(e.write(`Copying: \n"${o}" → "${s}"\n`),await F(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Q(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:f}=e;j();let p=R(s,o);p.pipe(A()===`json`?process.stderr:process.stdout);let m=u(d(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?Y(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=J(e.skip),{exitCode:i}=await Z(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return pe(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(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?Y(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=J(e.skip),i=A(),{exitCode:a,report:o}=await Z(p,t,[],await V(r.commands),f,l,n,i);o!==void 0&&process.stdout.write(`${JSON.stringify(o,void 0,` `)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=X(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?Y(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=J(e.skip),i=A(),{exitCode:a,report:o}=await Z(p,n,[],await V(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&&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?Y(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=J(e.skip),{exitCode:a}=await Z(p,n,[],await V(i.commands),f,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(_),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}const $={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.`},me=/^(?<file>.+?)\((?<line>\d+),(?<column>\d+)\): (?<severity>error|warning) (?<code>TS\d+): (?<message>.*)$/v,he=/^(?<severity>error|warning) (?<code>TS\d+): (?<message>.*)$/v,ge=/^\s/v;function _e(e){let t=[],n=[];for(let r of C(`${e.stdout}\n${e.stderr}`)){let i=me.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:ne(a??``,e.cwd),line:Number(o),message:s??``,rule:n,severity:c===`warning`?`warning`:`error`,tool:`tsc`});continue}let a=he.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&&ge.test(r)){o.message+=`\n${r.trim()}`;continue}n.push(r)}return{diagnostics:t,unparsed:n}}async function ve(){let e=M(),n=await t.readJson(r.join(e,`package.json`));return new Set([...Object.keys(n.dependencies??{}),...Object.keys(n.devDependencies??{})])}async function ye(){let e=await ve(),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:_e},cwdOverride:`package-dir`,name:`tsc`,optionFlags:[`--noEmit`]}]}await Q({commands:{init:{locationOptionFlag:!1},lint:{commands:ye,description:`Run type checking on your project. ${$.packageRun} ${$.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{name:`tsc`,optionFlags:[`--showConfig`],prettyJsonOutput:!0}],description:`Print the TypeScript configuration for the project. ${$.packageSearch} ${$.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's TypeScript shared configuration tools.`,logColor:`blueBright`,logPrefix:`[TypeScript Config]`,name:`ksc-typescript`,order:3});export{};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "2.0.0",
|
|
3
|
+
"tasks": [
|
|
4
|
+
{
|
|
5
|
+
"label": "ksc-typescript lint",
|
|
6
|
+
"detail": "Run type checking on your project.",
|
|
7
|
+
"type": "shell",
|
|
8
|
+
"command": "pnpm exec ksc-typescript 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
|
+
}
|
package/init/tsconfig.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"extends": "@kitschpatrol/typescript-config",
|
|
3
|
-
|
|
4
3
|
"compilerOptions": {
|
|
5
4
|
// TypeScript 6.0 no longer includes @types packages automatically
|
|
6
5
|
"types": ["node"]
|
|
6
|
+
// Consider enabling for new projects
|
|
7
|
+
// https://www.typescriptlang.org/tsconfig/#exactOptionalPropertyTypes
|
|
8
|
+
// "exactOptionalPropertyTypes": true
|
|
7
9
|
},
|
|
8
|
-
|
|
9
10
|
// Includes project dot-files files for typescript-eslint integration
|
|
10
11
|
"include": ["**/*", "**/**.*"],
|
|
11
12
|
"exclude": ["**/dist/"]
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -147,10 +147,11 @@ Usage:
|
|
|
147
147
|
ksc-typescript lint
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
| Option | Description
|
|
151
|
-
| ------------------- |
|
|
152
|
-
| `--
|
|
153
|
-
| `--
|
|
150
|
+
| Option | Description | Type | Default |
|
|
151
|
+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- |
|
|
152
|
+
| `--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"` |
|
|
153
|
+
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
154
|
+
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
154
155
|
|
|
155
156
|
#### Subcommand: `ksc-typescript print-config`
|
|
156
157
|
|
|
@@ -169,13 +170,36 @@ ksc-typescript print-config
|
|
|
169
170
|
|
|
170
171
|
<!-- /cli-help -->
|
|
171
172
|
|
|
173
|
+
### VS Code tasks
|
|
174
|
+
|
|
175
|
+
`ksc-typescript init` adds a `.vscode/tasks.json` with a single task:
|
|
176
|
+
|
|
177
|
+
- **`ksc-typescript lint`** runs `ksc-typescript lint --format machine`, type checking the project
|
|
178
|
+
|
|
179
|
+
If you're using the complete [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) package, you'd more likely want to run:
|
|
180
|
+
|
|
181
|
+
- **`ksc lint`** runs `ksc lint --format machine`, which runs all `ksc lint` tools across the whole project
|
|
182
|
+
- **`ksc fix`** runs `ksc fix --format machine`, which applies all `ksc fix` auto-fixes and reports anything unfixable
|
|
183
|
+
|
|
184
|
+
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
185
|
+
|
|
186
|
+
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 reported issue, pointing to the offending file, line, and column.
|
|
187
|
+
|
|
188
|
+
The tasks share a problem matcher owner with the other `@kitschpatrol/shared-config` tasks, so the panel reflects the most recent run rather than stacking duplicates.
|
|
189
|
+
|
|
190
|
+
If your project already has a `.vscode/tasks.json`, `init` merges by task label: your own tasks are left alone, and same-label tasks are replaced with the latest definitions.
|
|
191
|
+
|
|
172
192
|
## Notes
|
|
173
193
|
|
|
174
|
-
### Svelte caveat
|
|
194
|
+
### Svelte and Astro caveat
|
|
195
|
+
|
|
196
|
+
The `tsc` command ignores `.svelte` and `.astro` files, and [errors](https://github.com/sveltejs/language-tools/issues/2527) on plain `.ts` files that import them. So, if `svelte-check` or `@astrojs/check` is declared in your package's dependencies or devDependencies, the `ksc-typescript lint` command runs that checker instead of `tsc --noEmit`:
|
|
175
197
|
|
|
176
|
-
|
|
198
|
+
- `svelte-check` → `svelte-check --tsconfig ./tsconfig.json` (covers `.svelte` and plain `.ts` / `.js` files)
|
|
199
|
+
- `@astrojs/check` → `astro check` (covers `.astro` and plain `.ts` / `.js` files)
|
|
200
|
+
- Both → `astro check` plus `svelte-check` scoped to `.svelte` files only
|
|
177
201
|
|
|
178
|
-
|
|
202
|
+
If neither checker is declared, `tsc --noEmit` runs as usual, even in projects with a `svelte.config.js` or `astro.config.mjs` file.
|
|
179
203
|
|
|
180
204
|
### General
|
|
181
205
|
|