@kitschpatrol/mdat-config 8.3.0 → 8.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli.js +5 -5
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -2
- package/package.json +4 -4
- package/readme.md +6 -4
package/bin/cli.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
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{
|
|
3
|
-
`);try{return await r.execute(a,t,n)}catch(e){return console.error(String(e)),1}}function U(e,t,n,r,i){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...i&&e.cache!==void 0?[...e.cache.flags,`--cache-location`,o.join(F(),`node_modules`,`.cache`,`ksc`,e.cache.name)]:[],...e.receivePositionalArguments?t:[],...e.positionalArguments??[]]}async function
|
|
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),
|
|
5
|
-
`),1;let
|
|
6
|
-
`);for(let t of r)e.write(`${t}\n`);return 0}async function
|
|
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{findWorkspaces as y,findWorkspacesRoot as b}from"find-workspaces";import x from"node:fs/promises";import{loadConfig as ee}from"mdat";var te=`8.5.0`;const S=[`json`,`machine`,`native`],ne=S;function C(e){return typeof e==`string`&&S.includes(e)}function w(){let e=process.env.KSC_FORMAT;return C(e)?e:`native`}function re(){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)),C(r)&&(process.env.KSC_FORMAT=r)}}function ie(){let{env:e}=process;if(e.NO_COLOR!==void 0&&e.NO_COLOR!==``)return!1;if(e.FORCE_COLOR!==void 0)return e.FORCE_COLOR!==`0`&&e.FORCE_COLOR!==`false`;if(e.TERM===`dumb`)return!1}function T(e,{ciColor:t=!0}={}){let n=ie();return n===void 0?e.isTTY===!0||t&&!!process.env.CI:n}function E(){return w()===`json`?process.stderr:process.stdout}function D(){return w()===`machine`?p.createColors(!1):p.createColors(T(E()))}function O(e){if(!e)return{FORCE_COLOR:`0`,NO_COLOR:`1`};let t=process.env.FORCE_COLOR;return t===void 0||t===``?{FORCE_COLOR:`1`}:{}}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 k(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 A(e){return T(process.stdout,{ciColor:!1})?de(e):j(e)}function j(e){return v(g(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}})}function de(e){return h(j(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]=M(e[i],a,n):e.includes(a)||r.push(a);return r};function M(e,t,n={arrayMerge:fe}){return _(e,t,n)}function N(e){let{tasks:t}=e;return Array.isArray(t)?t:[]}function pe(e,t){let n=[...N(e)];for(let e of N(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 me(e,t){return e.startsWith(t+o.sep)}function he(){let e=P(),t=new Set([e]),n=y();if(n!==null)for(let r of n){let n=o.resolve(r.location);me(n,e)&&t.add(n)}return[...t]}function P(){let e=u();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function F(){let e=b();return e===null?P():o.resolve(e.location)}function I(e){if(e===`workspace-root`)return F();if(e===`package-dir`)return P();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function ge(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await x.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function L(e){try{await ge(e,await x.readFile(e,`utf8`))}catch{}}const R=/\r?\n/v;function z(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(R);t=a.pop()??``,i(void 0,n(a))}})}function B(e,t){let n=w()===`native`?e:void 0,r=n===void 0||n===``?``:t===void 0?n:D()[t](n),i=``,a=e=>e.filter(e=>e.trim().length>0).map(e=>r===``?`${e}\n`:`${r} ${e}\n`).join(``);return new c({flush(e){e(void 0,a([i]))},transform(e,t,n){let r=(i+e.toString()).split(R);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 V(e,t){return t===1?e:e+`s`}async function H(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=B(r.logPrefix,r.logColor);t.pipe(e),a=t}i&&a.write(D().bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`)+`
|
|
3
|
+
`);try{return await r.execute(a,t,n)}catch(e){return console.error(String(e)),1}}function U(e,t,n,r,i){return[...e.subcommands??[],...e.receiveOptionFlags?n:[],...r??[],...i&&e.cache!==void 0?[...e.cache.flags,`--cache-location`,o.join(F(),`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=B(i.logPrefix,i.logColor);t.pipe(e),l=t}let u=U(i,t,r,i.optionFlags,a),d=I(i.cwdOverride);o&&l.write(`Running: "${i.name} ${u.join(` `)}"\n`);let f=i.prettyJsonOutput?new s:void 0,p=f??l,m=O(w()===`native`&&i.prettyJsonOutput!==!0&&T(E()));try{let e=n(i.name,u,{cwd:d,env:m,preferLocal:!0,reject:!1,stdin:`inherit`});if(i.outputFilter){let t=z(i.outputFilter),n=z(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=A(JSON.parse(e)).split(`
|
|
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 W(e){return`execute`in e}function G(e){return`kind`in e}async function K(e,t,r,i,a){let o=U(r,e,t,r.collect?.optionFlags??r.optionFlags,i),s=I(r.cwdOverride);try{let e=n(r.name,o,{cwd:s,env:O(!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 q(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(W(r)){if(r.collect!==void 0)try{let e=await r.collect(t,n),i=q(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:k(e)}]}}if(G(r))throw Error(`Command groups must be expanded before collection`);if(r.outputFormatAware){let a=await K(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:k(a.stdout)}]}}}let c=await K(t,n,r,i);if(r.collect!==void 0)try{let{diagnostics:e,unparsed:t}=r.collect.parse(c),n=q(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:[...k(c.stdout),...k(c.stderr),String(e)]}]}}return{diagnostics:[],exitCode:c.exitCode,tools:[{durationMs:o(),exitCode:c.exitCode,name:r.name,unparsed:[...k(c.stdout),...k(c.stderr)]}]}}const Se=/^ksc-/v;function J(e){return e.replace(Se,``)}function Y(e){return e===void 0||e.length===0?[]:e.flatMap(e=>e.split(`,`)).map(e=>J(e.trim()))}function X(e){return e.option(`skip`,{array:!0,describe:`Tool names to skip (with or without "ksc-" prefix).`,type:`string`})}function Ce(e){return e.option(`format`,{choices:ne,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 we(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 Te(e,t){return t===`native`||t===`machine`&&!W(e)&&!G(e)&&e.outputFormatAware===!0}function Ee(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 De(){return Math.min(4,a())}var Oe=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 ke(e){let t=e.cache??!1,n=e.concurrency??De();if(!Number.isInteger(n)||n<1)throw Error(`Concurrency must be a positive integer.`);return t&&await r.ensureDir(o.join(F(),`node_modules`,`.cache`,`ksc`)),{cache:t,scheduler:new Oe(n)}}function Ae(e,t){return e.positionalArgumentMode===`none`?[]:t.length>0?t:e.positionalArgumentDefault===void 0?[]:[e.positionalArgumentDefault]}function je(e,t){if(t.logPrefix===void 0)return e;let n=B(t.logPrefix,t.logColor);return n.pipe(e),n}function Me(e){return G(e)?`${e.name} ${e.subcommand}`:!W(e)&&e.subcommands!==void 0?[e.name,...e.subcommands].join(` `):e.name}async function Z(e,t){if(G(e)){let n=je(t.logStream,e);try{let r=await H(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 Ne(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(Te(e,t.format))return{diagnostics:[],exitCode:await(W(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 Ne(e,t,n){if(!n||t.scheduler.concurrency===1){let n=[];for(let r of e)n.push(await Z(r,t));return n}await Promise.resolve();let r=new Map;for(let[t,n]of e.entries()){let e=n.stage??0,i=r.get(e)??[];i.push({command:n,index:t}),r.set(e,i)}let i=Array.from({length:e.length}),a=r.keys().toArray().toSorted((e,t)=>e-t);for(let e of a){let n=r.get(e)??[],a=await Promise.all(n.map(async({command:e,index:n})=>({index:n,outcome:await Z(e,t)})));for(let{index:e,outcome:t}of a)i[e]=t}return i.filter(e=>e!==void 0)}function Pe(e,t,n){let r=[],i=[];for(let e of t)n.length>0&&n.includes(J(e.name))?i.push(e):r.push(e);if(n.length>0){let r=new Set(i.map(e=>J(e.name))),a=n.filter(e=>!r.has(e));if(a.length>0){let n=t.map(e=>J(e.name)).join(`, `);e.write(`⚠️ ${D().yellow(`Unrecognized --skip ${V(`value`,a.length)}: ${a.join(`, `)}. Available: ${n}`)}\n`)}}return{commandsToRun:r,skippedCommands:i}}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}=Pe(e,r,o??[]),f=l===`native`&&i,{cache:p,scheduler:m}=await ke(c),h=await Ne(u,{cache:p,format:l,logStream:e,nativeVerbose:f,optionFlags:n,positionalArguments:t,scheduler:m},c.parallel===!0),g=h.map(({exitCode:e,name:t})=>({exitCode:e,name:t})),_=h.flatMap(({tools:e})=>e),v=h.flatMap(({diagnostics:e})=>e);if(l===`machine`)for(let t of h)for(let n of t.machineOutcomes)Ee(e,n);let y=r.length,b=D();if(l===`native`&&d.length>0){let t=d.map(({name:e})=>e),n=b.bold(`${t.length} / ${y} ${V(`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} ${V(`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} ${V(`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 Fe(e){let t=await l({cwd:e});return t===void 0?void 0:o.join(o.dirname(t),`init`)}async function Ie(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 Fe(import.meta.dirname);if(c===void 0)return e.write(`Error: Could not locate the package containing this CLI.
|
|
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=M(i,a);r.writeJSONSync(s,t,{spaces:` `}),await L(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 L(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):M(n,t);return r.writeJSONSync(s,i,{spaces:` `}),await L(s),!1}return l?(e.write(`Overwriting: \n"${a}" → "${s}"\n`),await L(s),!0):(e.write(`Copying: \n"${a}" → "${s}"\n`),await L(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Le(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:u}=e;re();let p=B(s,o);p.pipe(E());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?X(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=Y(e.skip),{exitCode:i}=await Q(p,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return Ie(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=we(Ce(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?X(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=Y(e.skip),i=w(),{exitCode:a,report:o}=await Q(p,t,[],await H(r.commands),u,l,n,{cache:e.cache,format:i,parallel:r.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),t!==void 0&&m.command({builder(e){let n=we(Ce(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?X(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=Y(e.skip),i=w(),{exitCode:a,report:o}=await Q(p,n,[],await H(t.commands),void 0,void 0,r,{cache:e.cache,format:i,parallel:t.parallel});o!==void 0&&process.stdout.write(`${A(o)}\n`),process.exitCode=a}}),i!==void 0&&m.command({builder(e){let t=i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault!==void 0&&{default:i.positionalArgumentDefault},describe:`File or glob pattern to print configuration for.`,type:`string`});return l?X(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=Y(e.skip),{exitCode:a}=await Q(p,n,[],await H(i.commands),u,l,r);process.exitCode=a}}),m.alias(`h`,`help`),m.version(te),m.alias(`v`,`version`),m.help(),m.wrap(process.stdout.isTTY?Math.min(120,m.terminalWidth()):0),await m.parseAsync()}async function Re(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 $={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 ze(){return(await Re(`mdat`))?.filepath}async function Be(e){let t=`mdat`,n=await Re(t);n!==void 0&&e.write(`Found ${t} readme configuration at "${n.filepath}"\n`);let r=A(await ee()).split(`
|
|
6
|
+
`);for(let t of r)e.write(`${t}\n`);return 0}async function Ve(e){let t=he(),n=await ze(),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}await Le({commands:{fix:{commands:await Ve(`expand`),description:`Expand all Mdat content placeholders in your readme.md file(s). ${$.packageRun} ${$.monorepoRun}`,parallel:!0,positionalArgumentMode:`none`},init:{configFile:`mdat.config.ts`,configPackageJson:{mdat:{$import:`node_modules/@kitschpatrol/mdat-config/dist/index.js`}},locationOptionFlag:!0},lint:{commands:await Ve(`check`),description:`Validate that all Mdat content placeholders in your readme.md file(s) have been expanded and are up to date. ${$.packageRun} ${$.monorepoRun}`,parallel:!0,positionalArgumentMode:`none`},printConfig:{commands:[{execute:Be,name:`mdat-config`}],description:`Print the effective Mdat configuration. ${$.packageSearch}. ${$.monorepoSearch}.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Mdat shared configuration tools.`,logColor:`green`,logPrefix:`[Mdat Config]`,name:`ksc-mdat`,order:2});export{};
|
package/dist/index.d.ts
CHANGED
|
@@ -30,6 +30,8 @@ declare function fix(source: string, config?: MdatConfig): Promise<string>;
|
|
|
30
30
|
* Expand Mdat comment placeholders in a Markdown file in place using the shared
|
|
31
31
|
* configuration.
|
|
32
32
|
*
|
|
33
|
+
* Non-Markdown files are left unchanged.
|
|
34
|
+
*
|
|
33
35
|
* @param filePath - Path to the Markdown file.
|
|
34
36
|
* @param config - Optional `MdatConfig` overrides merged on top of the shared
|
|
35
37
|
* config.
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import e from"node:fs/promises";import{mergeConfig as
|
|
1
|
+
import e from"node:fs/promises";import t from"node:path";import{mergeConfig as n}from"mdat";const r={"shared-config":`## Project configuration
|
|
2
2
|
|
|
3
|
-
This project uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) to consolidate various linting and formatting tool configurations under a single dependency and the CLI command \`ksc\`. (ESLint, Prettier, CSpell, etc.)`};function
|
|
3
|
+
This project uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) to consolidate various linting and formatting tool configurations under a single dependency and the CLI command \`ksc\`. (ESLint, Prettier, CSpell, etc.)`};function i(e){return n(r,e??{})}let a;const o=new Set([`.markdown`,`.md`]);async function s(){if(!a){let e=await import(`mdat`);a={expandString:e.expandString,mergeConfig:e.mergeConfig}}return a}async function c(e,t){let{expandString:n,mergeConfig:i}=await s(),a=await n(e,t?i(r,t):r,{format:!0});return String(a)}async function l(n,i){if(!o.has(t.extname(n).toLowerCase()))return;let a=await e.readFile(n,`utf8`),{expandString:c,mergeConfig:l}=await s(),u=await c(a,i?l(r,i):r,{format:!0});await e.writeFile(n,String(u),`utf8`)}function u(){a=void 0}export{u as clearCache,r as default,r as sharedMdatConfig,c as fix,l as fixFile,i as mdatConfig};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/mdat-config",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.5.0",
|
|
4
4
|
"description": "MDAT configuration for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -51,12 +51,12 @@
|
|
|
51
51
|
"deepmerge": "^4.3.1",
|
|
52
52
|
"execa": "^10.0.0",
|
|
53
53
|
"find-workspaces": "^0.3.1",
|
|
54
|
-
"fs-extra": "^11.
|
|
54
|
+
"fs-extra": "^11.4.0",
|
|
55
55
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
56
|
-
"mdat": "^
|
|
56
|
+
"mdat": "^3.0.0",
|
|
57
57
|
"package-up": "^5.0.0",
|
|
58
58
|
"picocolors": "^1.1.1",
|
|
59
|
-
"prettier": "^3.9.
|
|
59
|
+
"prettier": "^3.9.6",
|
|
60
60
|
"yargs": "^18.0.0"
|
|
61
61
|
},
|
|
62
62
|
"engines": {
|
package/readme.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
<!-- badges -->
|
|
8
8
|
|
|
9
|
-
[](https://npmjs.com/package/@kitschpatrol/mdat-config)
|
|
10
|
-
[](https://opensource.org/license/mit
|
|
9
|
+
[](https://www.npmjs.com/package/@kitschpatrol/mdat-config)
|
|
10
|
+
[](https://opensource.org/license/mit)
|
|
11
11
|
|
|
12
12
|
<!-- /badges -->
|
|
13
13
|
|
|
@@ -72,7 +72,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
|
|
|
72
72
|
|
|
73
73
|
"Fix" in this case is a slight misnomer for consistency with the other shared-config tools.
|
|
74
74
|
|
|
75
|
-
It runs `mdat expand` to expand placeholder comments in your readme.md using the bundled [`mdat`](https://github.com/kitschpatrol/mdat/blob/main/
|
|
75
|
+
It runs `mdat expand` to expand placeholder comments in your readme.md using the bundled [`mdat`](https://github.com/kitschpatrol/mdat/blob/main/readme.md) expansion rules, plus custom rules provided by `mdat-config`'s `mdat.config.ts` file, plus any additional rules specified in the repository-specific `mdat.config.ts` file.
|
|
76
76
|
|
|
77
77
|
### Configuration
|
|
78
78
|
|
|
@@ -205,7 +205,7 @@ If you're using the complete [@kitschpatrol/shared-config](https://github.com/ki
|
|
|
205
205
|
|
|
206
206
|
Run them via the _Tasks: Run Task_ command (or the _Terminal → Run Task…_ menu item).
|
|
207
207
|
|
|
208
|
-
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/
|
|
208
|
+
Each task's problem matcher parses the machine-format output and populates VS Code's [Problems panel](https://code.visualstudio.com/docs/editing/editingevolved#_errors-warnings) with every reported issue, pointing to the offending file, line, and column.
|
|
209
209
|
|
|
210
210
|
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.
|
|
211
211
|
|
|
@@ -215,6 +215,8 @@ If your project already has a `.vscode/tasks.json`, `init` merges by task label:
|
|
|
215
215
|
|
|
216
216
|
The package also exports `fix`, `fixFile` functions for expanding Mdat comment placeholders programmatically, pre-configured with the shared Mdat configuration. The [mdat](https://github.com/kitschpatrol/mdat) project already provides a robust TypeScript API and CLI for general use cases, but these proxies are provided for convenience in @kitschpatrol/shared-config projects.
|
|
217
217
|
|
|
218
|
+
`fixFile` only processes `.md` and `.markdown` files; other file types are left unchanged.
|
|
219
|
+
|
|
218
220
|
```typescript
|
|
219
221
|
import { clearCache, fix, fixFile } from '@kitschpatrol/mdat-config'
|
|
220
222
|
|