mdat 0.2.0 → 0.3.1

package/bin/cli.js

@@ -1,4 +1,304 @@
 #!/usr/bin/env node
-import{defaultLoaders as W}from"cosmiconfig";function w(e,t){let n=W[".json"],a=n(e,t);return P(a)}function P(e,t="",n={}){for(let[a,i]of Object.entries(e)){let o=t?`${t}.${a}`:a;typeof i=="object"&&i!==null&&!Array.isArray(i)?P(i,o,n):i===null?n[o]="null":n[o]=i.toString()}return n}import M from"chalk";import{cosmiconfig as v}from"cosmiconfig";import _ from"node:fs/promises";import q from"node:path";import B from"plur";import{deepMergeDefined as b,log as h,optionsSchema as G,rulesSchema as Y}from"remark-mdat";async function C(e){let{additionalConfig:t,additionalRules:n,configExtensionSchema:a,searchFrom:i}=e??{},o={},d=G;a!==void 0&&(d=d.merge(a));let f=v("mdat"),u=await f.search(i);if(u){let{config:l,filepath:s}=u;h.info(`Using config from "${s}"`);let r=k(l,d);r&&(o=b(o,r))}if(t!==void 0){let l=Array.isArray(t)?t:[t];for(let s of l){let r;if(typeof s=="string"){let c=await f.load(s);if(c==null)continue;let{config:p,filepath:y}=c;h.info(`Loaded additional config from "${y}"`),r=p}else r=s;if(r===void 0)continue;h.info("Merging configuration object");let g=k(r,d);g!==void 0&&(o=b(o,g))}}if(n!==void 0){let l=Array.isArray(n)?n:[n],s=v("mdat",{loaders:{".json":w}});for(let r of l){let g;if(typeof r=="string"){let p;if(q.basename(r).endsWith("package.json")){let U=await _.readFile(r,"utf8");p={config:w(r,U),filepath:r}}else p=await s.load(r);if(p==null)continue;let{config:y,filepath:Z}=p;h.info(`Loaded additional config from "${Z}"`),g=y}else g=r;if(g===void 0)continue;h.info("Merging rules into configuration object");let c=H(g,Y);c!==void 0&&(o=b(o,c))}}if(o.rules){let l=Object.keys(o.rules).sort().map(s=>`"${M.bold.green(s)}"`);h.info(`Loaded ${M.bold(l.length)} mdat comment expansion ${B("rule",l.length)}:`);for(let s of l)h.info(`	${s}`)}else h.error("No rules loaded from additional configurations or rules, using default.");return o}function H(e,t){if(t.safeParse(e).success)return{rules:e};h.error(`Rules object has the wrong shape. Ignoring and using default configuration:
-${JSON.stringify(e,void 0,2)}`)}function k(e,t){if(t.safeParse(e).success)return e;h.error(`Config object has the wrong shape. Ignoring and using default configuration:
-${JSON.stringify(e,void 0,2)}`)}import Q from"node:fs";import x from"node:path";import{isFileSync as R}from"path-type";import X from"untildify";function K(e,t){let n=t===0?1:Math.floor(Math.log10(Math.abs(t))+1);return e.toString().padStart(n,"0")}function O(e,t,n,a){let i=[];for(let[o,d]of e.entries()){let f=n&&e.length>1?`-${K(o+1,e.length+1)}`:"",u=$(d,t,n,a,f);i.push(u)}return i}function $(e,t,n,a,i=""){let o=F(e),d=t?F(t):void 0;if(!R(o))throw new Error(`Input file not found: "${o}"`);if(d){if(R(d))throw new Error(`Output path must be a directory, received a file path: "${d}"`);Q.mkdirSync(d,{recursive:!0})}let f=n?x.basename(n,x.extname(n)):x.basename(o,x.extname(o)),u=`.${a??(n&&x.extname(n)!==""?x.extname(n):x.extname(e)===""?"":x.extname(e))}`,l=`${f}${i}${u}`,s=d??x.dirname(o);return{input:o,name:l,output:s}}function F(e){return X(e)}import{remark as S}from"remark";import A from"remark-gfm";import{mdatClean as ee,mdatSplit as ne,default as te}from"remark-mdat";import{read as E}from"to-vfile";import{VFile as Se}from"vfile";async function I(e,t,n,a,i){let o=await C({additionalConfig:a,additionalRules:i}),d=O(e,n,t,"md"),f=[],u=oe(o);for(let{input:l,name:s,output:r}of d){let g=await E(l),c=await u.process(g);c.dirname=r,c.basename=s,f.push(c)}return f}function oe(e){return S().use({settings:{bullet:"-",emphasis:"_"}}).use(A).use(te,e??{})}async function T(e,t,n,a){let i=await C({additionalConfig:a});console.log("----------------------------------"),console.log(`config: ${JSON.stringify(a,void 0,2)}`),console.log(`resolvedOptions: ${JSON.stringify(i,void 0,2)}`);let{closingPrefix:o,keywordPrefix:d,metaCommentIdentifier:f}=i,u=O(e,n,t,"md"),l=[],s=ie({closingPrefix:o,keywordPrefix:d,metaCommentIdentifier:f});for(let{input:r,name:g,output:c}of u){let p=await E(r),y=await s.process(p);y.dirname=c,y.basename=g,l.push(y)}return l}function ie(e){let{closingPrefix:t="/",keywordPrefix:n="",metaCommentIdentifier:a="+"}=e;return S().use({settings:{bullet:"-",emphasis:"_"}}).use(A).use(()=>function(o,d){ne(o,d),ee(o,d,{closingPrefix:t,keywordPrefix:n,metaCommentIdentifier:a})})}import j from"plur";import J from"pretty-ms";import{getMdatReports as V,log as m,reporterMdat as L}from"remark-mdat";import{write as N}from"to-vfile";import re from"yargs";import{hideBin as se}from"yargs/helpers";var D=performance.now(),z=re(se(process.argv));try{await z.scriptName("mdat").usage("$0 [command] [options]","Use the `mdat` comment expansion system with your Markdown files.").command(["$0 <files..> [options]","expand <files..> [options]"],"Expand comment placeholders in Markdown files.",e=>e.positional("files",{array:!0,demandOption:!0,describe:"Markdown file(s) with `mdat` placeholder comments to expand.",type:"string"}).option("config",{defaultDescription:"Configuration is loaded if found from the usual places, or defaults are used.",description:"Path(s) to files containing mdat configs.",string:!0,type:"array"}).option("rules",{alias:"r",description:"Path(s) to files containing `mdat` comment expansion rules.",string:!0,type:"array"}).option("output",{alias:"o",defaultDescription:"Same directory as input file.",description:"Output file directory.",type:"string"}).option("name",{alias:"n",defaultDescription:"Same name as input file. Overwrites the input file.",description:"Output file name.",type:"string"}).option("print",{default:!1,description:"Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.",type:"boolean"}).option("prefix",{description:"Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-`mdat` comments in your Markdown file, or if you're willing to trade some verbosity for safety.",type:"string"}).option("meta",{alias:"m",default:!1,description:"Embed an extra comment at the top of the generated Markdown noting the date of generation and warning editors that certain sections of the document have been generated dynamically.",type:"boolean"}).option("check",{alias:"c",default:!1,describe:"Check the input files for rule violations without expanding them. Identifies things like missing comment placeholders and incorrect placeholder ordering.",type:"boolean"}).option("verbose",{default:!1,describe:"Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.",type:"boolean"}),async({check:e,config:t,files:n,meta:a,name:i,output:o,prefix:d="",print:f,rules:u,verbose:l})=>{m.verbose=l,e&&(o&&(o=void 0,m.warn("Ignoring --output option because --check is set")),i&&(i=void 0,m.warn("Ignoring --name option because --check is set")),f&&(f=!1,m.warn("Ignoring --print option because --check is set"))),f&&(o&&(o=void 0,m.warn("Ignoring --output option because --print is set")),i&&(i=void 0,m.warn("Ignoring --name option because --print is set")));let s=[...t??[],{addMetaComment:a,keywordPrefix:d}];Array.isArray(n)||(n=[n]);let r=await I(n,i,o,s,u);if(f)for(let p of r)process.stdout.write(p.toString());if(L(r),!e&&!f)for(let p of r)await N(p);let c=V(r).reduce((p,y)=>p+y.errors.length,0);m.info(`Expanded comments in ${n.length} ${j("file",n.length)} in ${J(performance.now()-D)}.`),process.exitCode=c>0?1:0}).command(["clean <files..> [options]"],"Collapse `mdat` comment placeholders in Markdown files.",e=>e.positional("files",{array:!0,demandOption:!0,describe:"Markdown file(s) with `mdat` placeholder comments to collapse.",type:"string"}).option("config",{defaultDescription:"Configuration is loaded if found from the usual places, or defaults are used.",description:"Path(s) to files containing mdat configs.",string:!0,type:"array"}).option("output",{alias:"o",defaultDescription:"Same directory as input file.",description:"Output file directory.",type:"string"}).option("name",{alias:"n",defaultDescription:"Same name as input file. Overwrites the input file.",description:"Output file name.",type:"string"}).option("print",{default:!1,description:"Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.",type:"boolean"}).option("verbose",{default:!1,describe:"Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.",type:"boolean"}),async({config:e,files:t,name:n,output:a,print:i,verbose:o})=>{m.verbose=o,i&&(a&&(a=void 0,m.warn("Ignoring --output option because --print is set")),n&&(n=void 0,m.warn("Ignoring --name option because --print is set")));let d=e??[];Array.isArray(t)||(t=[t]);let f=await T(t,n,a,d);if(i)for(let s of f)process.stdout.write(s.toString());if(L(f),!i)for(let s of f)await N(s);let l=V(f).reduce((s,r)=>s+r.errors.length,0);m.info(`Cleaned comments in ${t.length} ${j("file",t.length)} in ${J(performance.now()-D)}.`),process.exitCode=l>0?1:0}).help().alias("h","help").version().alias("v","version").wrap(process.stdout.isTTY?Math.min(120,z.terminalWidth()):0).fail(!1).parse()}catch(e){e instanceof Error&&m.error(e.message),process.exitCode=1}
+import{defaultLoaders as Qt}from"cosmiconfig";function ye(t,e){let n=Qt[".json"],i=n(t,e);return Xe(i)}function Xe(t,e="",n={}){for(let[i,o]of Object.entries(t)){let a=e?`${e}.${i}`:i;typeof o=="object"&&o!==null&&!Array.isArray(o)?Xe(o,a,n):o===null?n[a]="null":n[a]=o.toString()}return n}import{findUp as Xt}from"find-up";import en from"node:fs";import x from"node:path";import{packageUp as tn}from"package-up";import{isFileSync as et}from"path-type";import{packageDirectory as nn}from"pkg-dir";import{log as tt}from"remark-mdat";import on from"untildify";function rn(t,e){let n=e===0?1:Math.floor(Math.log10(Math.abs(e))+1);return t.toString().padStart(n,"0")}function we(t,e,n,i){let o=[];for(let[a,r]of t.entries()){let s=n&&t.length>1?`-${rn(a+1,t.length+1)}`:"",d=W(r,e,n,i,s);o.push(d)}return o}function W(t,e,n,i,o=""){let a=nt(t),r=e?nt(e):void 0;if(!et(a))throw new Error(`Input file not found: "${a}"`);if(r){if(et(r))throw new Error(`Output path must be a directory, received a file path: "${r}"`);en.mkdirSync(r,{recursive:!0})}let s=n?x.basename(n,x.extname(n)):x.basename(a,x.extname(a)),d=`.${i??(n&&x.extname(n)!==""?x.extname(n):x.extname(t)===""?"":x.extname(t))}`,m=`${s}${o}${d}`,c=r??x.dirname(a);return{input:a,name:m,output:c}}function nt(t){return on(t)}async function G(){tt.info("Searching for package directory...");let t=await nn()??process.cwd(),e=await Xt("readme.md",{stopAt:t,type:"file"});if(e!==void 0)return tt.info(`Found closest readme at "${e}"`),e}async function Y(){return tn()}import ot from"chalk";import{cosmiconfig as it}from"cosmiconfig";import an from"node:fs/promises";import st from"node:path";import sn from"plur";import{readPackage as dn}from"read-pkg";import{deepMergeDefined as be,log as y,optionsSchema as mn,rulesSchema as cn}from"remark-mdat";import{z as K}from"zod";var rt=mn.merge(K.object({assetsPath:K.string().optional(),packageFile:K.string().optional(),readmeFile:K.string().optional()})).describe("Config Extension");async function k(t){let{additionalConfig:e,additionalRules:n,searchFrom:i}=t??{},o={addMetaComment:!1,assetsPath:"./assets",closingPrefix:"/",keywordPrefix:"",metaCommentIdentifier:"+",packageFile:await Y(),readmeFile:await G(),rules:{mdat:"Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat)."}},a=it("mdat"),r=await a.search(i);if(r){let{config:s,filepath:d}=r;y.info(`Using config from "${d}"`);let m=at(s,rt);m&&(o=be(o,m))}if(e!==void 0){let s=Array.isArray(e)?e:[e];for(let d of s){let m;if(typeof d=="string"){let p=await a.load(d);if(p==null)continue;let{config:u,filepath:g}=p;y.info(`Loaded additional config from "${g}"`),m=u}else m=d;if(m===void 0)continue;y.info("Merging configuration object");let c=at(m,rt);c!==void 0&&(o=be(o,c))}}if(n!==void 0){let s=Array.isArray(n)?n:[n],d=it("mdat",{loaders:{".json":ye}});for(let m of s){let c;if(typeof m=="string"){let u;if(st.basename(m).endsWith("package.json")){let he=await an.readFile(m,"utf8");u={config:ye(m,he),filepath:m}}else u=await d.load(m);if(u==null)continue;let{config:g,filepath:C}=u;y.info(`Loaded additional config from "${C}"`),c=g}else c=m;if(c===void 0)continue;y.info("Merging rules into configuration object");let p=pn(c,cn);p!==void 0&&(o=be(o,p))}}if(o.rules){let s=Object.keys(o.rules).sort().map(d=>`"${ot.bold.green(d)}"`);y.info(`Loaded ${ot.bold(s.length)} mdat comment expansion ${sn("rule",s.length)}:`);for(let d of s)y.info(`	${d}`)}else y.error("No rules loaded from additional configurations or rules, using default.");return Z=o,o}function pn(t,e){if(e.safeParse(t).success)return{rules:t};y.error(`Rules object has the wrong shape. Ignoring and using default configuration:
+${JSON.stringify(t,void 0,2)}`)}function at(t,e){if(e.safeParse(t).success)return t;y.error(`Config object has the wrong shape. Ignoring and using default configuration:
+${JSON.stringify(t,void 0,2)}`)}var Z;async function w(){return Z===void 0&&(y.warn("getConfig(): config was undefined"),Z??=await k()),Z}var Ce;async function h(){let{packageFile:t}=await w();if(t===void 0)throw new Error("No packageFile found or set in config");if(Ce??=await dn({cwd:st.dirname(t)}),Ce===void 0)throw new Error("No package.json found");return Ce}import{remark as dt}from"remark";import mt from"remark-gfm";import{mdatClean as ln,mdatSplit as un,default as fn}from"remark-mdat";import{read as Q}from"to-vfile";import{VFile as Mo}from"vfile";async function X(t,e,n,i,o){let a=await k({additionalConfig:i,additionalRules:o});i=a;let r=we(t,n,e,"md"),s=[],d=ct(a);for(let{input:m,name:c,output:p}of r){let u=await Q(m),g=await d.process(u);g.dirname=p,g.basename=c,s.push(g)}return s}async function xe(t,e,n,i,o){let a=await k({additionalConfig:i,additionalRules:o});i=a;let r=W(t,n,e,"md"),s=await Q(r.input),d=await ct(a).process(s);return d.dirname=r.output,d.basename=r.name,d}async function ke(t,e,n,i){let o=await k({additionalConfig:i});i=o;let a=we(t,n,e,"md"),r=[],s=pt(o);for(let{input:d,name:m,output:c}of a){let p=await Q(d),u=await s.process(p);u.dirname=c,u.basename=m,r.push(u)}return r}async function Re(t,e,n,i){let o=await k({additionalConfig:i});i=o;let a=W(t,n,e,"md"),r=await Q(a.input),s=await pt(o).process(r);return s.dirname=a.output,s.basename=a.name,s}function ct(t){return dt().use({settings:{bullet:"-",emphasis:"_"}}).use(mt).use(fn,t??{})}function pt(t){let{closingPrefix:e,keywordPrefix:n,metaCommentIdentifier:i}=t;return dt().use({settings:{bullet:"-",emphasis:"_"}}).use(mt).use(()=>function(a,r){un(a,r),ln(a,r,{closingPrefix:e,keywordPrefix:n,metaCommentIdentifier:i})})}import{z as V}from"zod";var ee={badges:{async content(t){var r;let e=V.object({custom:V.record(V.object({image:V.string(),link:V.string()})).optional()}).optional().parse(t),n=await h(),{name:i}=n,o=[];!n.private&&((r=n.publishConfig)==null?void 0:r.access)==="public"&&o.push(`[![NPM Package](https://img.shields.io/npm/v/${i}.svg)](https://npmjs.com/package/${i})`);let{license:a}=n;if(a!==void 0&&o.push(`[![License: ${a}](https://img.shields.io/badge/License-${a}-yellow.svg)](https://opensource.org/licenses/${a})`),(e==null?void 0:e.custom)!==void 0)for(let[s,{image:d,link:m}]of Object.entries(e.custom))o.push(`[![${s}](${d})](${m})`);return o.join(`
+`)},order:3,required:!1}};import{globby as gn}from"globby";import te from"node:path";import{isFile as hn}from"path-type";import{readPackage as yn}from"read-pkg";import{z as Pe}from"zod";async function wn(t){let{packageFile:e}=await w();if(e===void 0)throw new Error("No package.json found");let n=te.dirname(e),i=t===void 0?[".","assets","media","readme-assets","readme-media","readme","images"]:[t],o=["banner","header","logo","readme","cover","screenshot","screenshots","demo","overview","image","hero"],a=["png","gif","jpg","jpeg","svg","webp"],r=await gn(i.map(s=>te.join(n,s)),{expandDirectories:{extensions:a,files:o}});if(r.length>0)return te.relative(process.cwd(),r[0])}var ne={banner:{async content(t){let e=Pe.object({alt:Pe.string().optional(),src:Pe.string().optional()}).optional().parse(t),{assetsPath:n,packageFile:i}=await w();if(i===void 0)throw new Error("No package.json found");let o=(e==null?void 0:e.src)??await wn(n);if(o===void 0||!await hn(o))throw new Error(`Banner image not found at ${o===void 0?"any typical location, consider adding something at ./assets/banner.webp":`"${o}"`}`);let a=(e==null?void 0:e.alt)??`${(await yn({cwd:te.dirname(i)})).name} banner`;if(a===void 0||a==="undefined banner")throw new Error("Banner image alt text not available");return`![${a}](${o})`},order:2}};import{CstParser as bn,Lexer as S,createToken as f}from"chevrotain";var ve=f({name:"flag",pattern:/--[\w-_]+/}),$e=f({name:"alias",pattern:/-[A-Za-z]/}),lt=f({group:S.SKIPPED,name:"comma",pattern:/,/}),F=f({name:"word",pattern:/\S+/}),J=f({name:"argument",pattern:/<\S+>|\[\S+]/}),Ee=f({name:"type",pattern:/\[(boolean|string|array)]/}),Le=f({name:"defaultInfo",pattern:/\[default]/}),Te=f({name:"required",pattern:/\[required]/}),Ne=f({name:"defaultInfoDescription",pattern:/\[default:\s.+?]/}),Fe=f({name:"choices",pattern:/\[choices:\s.+?]/}),Oe=f({group:S.SKIPPED,name:"whiteSpace",pattern:/\s/}),ut=f({group:S.SKIPPED,name:"startProgramDescription",pattern:/\n\n/,push_mode:"PROGRAM_DESCRIPTION_MODE"}),_e=f({name:"programDescription",pattern:/.+/}),ft=f({group:S.SKIPPED,name:"endProgramDescription",pattern:/\n\n/,pop_mode:!0}),je=f({name:"startOptionsSection",pattern:/Options:\n/,push_mode:"SECTION_MODE"}),Ae=f({name:"startPositionalsSection",pattern:/Positionals:\n/,push_mode:"SECTION_MODE"}),De=f({name:"startCommandsSection",pattern:/Commands:\n/,push_mode:"SECTION_MODE"}),Ie=f({name:"startRow",pattern:/ {2,}/,push_mode:"ROW_MODE"}),Me=f({name:"rowDescription",pattern:/ {2}\w.+ {2}/}),Ue=f({name:"rowDescriptionTerminal",pattern:/ {2}\w.+/}),gt=f({group:S.SKIPPED,name:"endRow",pattern:/\n/,pop_mode:!0}),ht=f({group:S.SKIPPED,name:"endSection",pattern:/\n+/,pop_mode:!0}),Cn=new S({defaultMode:"DEFAULT_MODE",modes:{DEFAULT_MODE:[je,Ae,De,ut,J,F,Oe],PROGRAM_DESCRIPTION_MODE:[ft,_e],ROW_MODE:[gt,lt,Ee,Me,Ue,Ne,Le,Te,Fe,ve,$e,J,F,Oe],SECTION_MODE:[Ie,ht]}}),xn=[ve,$e,lt,F,J,Ee,Le,Te,Ne,Fe,Oe,ut,_e,ft,je,Ae,De,Ie,Me,Ue,gt,ht];function kn(t){return Cn.tokenize(t.trim())}var Se=class extends bn{programHelp=this.RULE("programHelp",()=>{this.AT_LEAST_ONE(()=>{this.CONSUME(F,{LABEL:"commandName"})}),this.MANY1(()=>{this.CONSUME(J)}),this.OPTION(()=>{this.CONSUME(_e,{LABEL:"description"})}),this.OPTION1(()=>{this.SUBRULE(this.commandsSection)}),this.OPTION2(()=>{this.SUBRULE(this.positionalsSection)}),this.OPTION3(()=>{this.SUBRULE(this.optionsSection)})});positionalsSection=this.RULE("positionalsSection",()=>{this.CONSUME(Ae),this.MANY(()=>{this.SUBRULE(this.sectionRow)})});commandsSection=this.RULE("commandsSection",()=>{this.CONSUME(De),this.MANY1(()=>{this.SUBRULE1(this.sectionRow)})});optionsSection=this.RULE("optionsSection",()=>{this.CONSUME(je),this.MANY2(()=>{this.SUBRULE2(this.sectionRow)})});sectionRow=this.RULE("sectionRow",()=>{this.CONSUME(Ie),this.OPTION(()=>{this.CONSUME(F,{LABEL:"parentCommandName"})}),this.MANY(()=>{this.CONSUME1(F,{LABEL:"commandName"})}),this.MANY1(()=>{this.OR([{ALT:()=>this.CONSUME(J)},{ALT:()=>this.CONSUME($e)},{ALT:()=>this.CONSUME(ve)},{ALT:()=>this.CONSUME(Me,{LABEL:"description"})},{ALT:()=>this.CONSUME(Ue,{LABEL:"description"})},{ALT:()=>this.CONSUME(Ee)},{ALT:()=>this.CONSUME(Te)},{ALT:()=>this.CONSUME(Ne)},{ALT:()=>this.CONSUME(Le)},{ALT:()=>this.CONSUME(Fe)}])})});constructor(){super(xn),this.performSelfAnalysis()}},N=new Se;function yt(t){let e=kn(t);N.input=e.tokens;let n=N.programHelp();if(N.errors.length>0)throw new Error(`Errors parsing CLI command help text output: ${JSON.stringify(N.errors,void 0,2)}`);return n}var Ve=class extends N.getBaseCstVisitorConstructor(){constructor(){super(),this.validateVisitor()}programHelp(e){let{command:n,subcommand:i}=Pn(this.getString(e.commandName));return{arguments:this.getArray(e.argument),commandName:n,commands:e.commandsSection?this.visit(e.commandsSection):void 0,description:this.getString(e.description),options:e.optionsSection?this.visit(e.optionsSection):void 0,positionals:e.positionalsSection?this.visit(e.positionalsSection):void 0,subcommandName:i}}positionalsSection(e){return e.sectionRow.map(n=>this.positionalParentCommandToArguments(this.visit(n)))}commandsSection(e){return e.sectionRow.map(n=>this.visit(n))}optionsSection(e){return e.sectionRow.map(n=>this.visit(n))}sectionRow(e){return{aliases:this.getArray(e.alias),arguments:this.getArray(e.argument),choices:this.splitChoices(this.getString(e.choices)),commandName:this.getString(e.commandName),default:e.defaultInfo?!0:void 0,defaultValue:this.getString(e.defaultInfoDescription,!0),description:this.getString(e.description,!0),flags:this.getArray(e.flag),parentCommandName:this.getString(e.parentCommandName),required:e.required?!0:void 0,type:this.getString(e.type,!0)}}positionalParentCommandToArguments(e){let{arguments:n,parentCommandName:i,...o}=e;return i===void 0?e:{arguments:[i,...n??[]],...o}}getString(e,n=!1){if(e!==void 0)return e.map(i=>n?this.clean(i.image):i.image).join(" ")}getArray(e){if(e!==void 0)return e.map(n=>n.image)}clean(e){return e.replaceAll(/^[\s[]*(default:)?\s*|[\s\]]*$/g,"")}splitChoices(e){if(e!==void 0)return this.clean(e.replaceAll(/^\[choices:\s/g,"")).split(", ")}},Rn=new Ve;function wt(t){return Rn.visit(t)}function Pn(t){if(t===void 0)throw new Error('Could not find "commandName" entry in help');let e=t.split(" ");if(e.length===0&&t===void 0)throw new Error('Could not find "commandName" entry in help');if(e.length===1)return{command:e[0],subcommand:void 0};let n=e.at(-1);return{command:e.slice(0,-1).join(" "),subcommand:n}}function bt(t,e=!1){var i,o,a;let n=[];if(e){let r=(i=t.commands)==null?void 0:i.find(m=>m.default),s=(o=t.commands)==null?void 0:o.find(m=>m.commandName===void 0),d=`${t.commandName}${t.subcommandName?` ${t.subcommandName}`:""}`;n.push(`#### Command: \`${d}\``),s!=null&&s.description&&n.push(s==null?void 0:s.description),n.push(`This section lists top-level commands for \`${d}\`.`),r&&n.push(`If no command is provided, \`${r.parentCommandName} ${r.commandName}\` is run by default.`),n.push("Usage:"),s&&n.push(`\`\`\`txt
+${s.parentCommandName}${s.arguments?` ${s.arguments.join(" ")}`:""}
+\`\`\``),t.commands=(a=t.commands)==null?void 0:a.filter(m=>m!==s)}else n.push(`#### Subcommand: \`${t.commandName} ${t.subcommandName}\``),n.push(t.description),n.push("Usage:"),n.push(`\`\`\`txt
+${t.commandName} ${t.subcommandName}${t.arguments?` ${t.arguments.join(" ")}`:""}
+\`\`\``);return t.positionals&&!e&&n.push(Je(["Positional Argument","Description","Type","Default"],t.positionals.map(r=>[r.arguments?[r.arguments.map(s=>`\`${s}\``)].join(" "):"",`${r.description??""}${r.required?" _(Required.)_":" _(Optional.)_"}`,r.type?`\`${r.type}\``:"",r.defaultValue?r.defaultValue.includes(" ")?r.defaultValue:`\`${r.defaultValue}\``:""]))),t.commands&&n.push(Je(["Command","Argument","Description"],t.commands.map(r=>{var s;return[`\`${r.commandName??(r.default?"[default]":"")}\``,r.arguments?(s=r.arguments)==null?void 0:s.map(d=>`\`${d}\``).join(" "):"",`${r.description??""}${r.default?" _(Default command.)_":""}`]}))),t.options&&!e&&n.push(Je(["Option","Alias","Argument","Description","Type","Default"],t.options.map(r=>[r.flags?r.flags.map(s=>`\`${s}\``).join(" "):"",r.aliases?r.aliases.map(s=>`\`${s}\``).join(" "):"",r.arguments?r.arguments.map(s=>`\`${s}\``).join(" "):"",r.description??"",r.type?`\`${r.type}\``:"",r.defaultValue?r.defaultValue.includes(" ")?r.defaultValue:`\`${r.defaultValue}\``:""]))),e&&n.push("_See the sections below for more information on each subcommand._"),n.join(`
+
+`)}function Je(t,e){let n=On(e);t=t.filter((o,a)=>!n.includes(a)),e=e.map(o=>o.filter((a,r)=>!n.includes(r)));let i="";i+=`| ${t.join(" | ")} |
+`,i+=`| ${t.map(()=>"---").join(" | ")} |
+`;for(let o of e)i+=`| ${o.join(" | ")} |
+`;return i}function On(t){var i;let e=[],n=((i=t[0])==null?void 0:i.length)||0;for(let o=0;o<n;o++){let a=!0;for(let r of t)if(r[o]!==""){a=!1;break}a&&e.push(o)}return e}import{execaCommand as Sn}from"execa";import{log as Ct}from"remark-mdat";async function Be(t){let e=`${t} --help`,n;try{let{stderr:o,stdout:a}=await Sn(e);n=a,(n===void 0||n==="")&&(n=o)}catch(o){if(o instanceof Error)throw new TypeError(`Error running CLI help command: ${e}
+${o.message}
+`)}if(n===void 0||n==="")throw new Error(`No result from running CLI help command: ${e}
+`);let i;try{let o=yt(n);i=wt(o)}catch(o){o instanceof Error&&(i=void 0,Ct.warn(`Error parsing help output for command: ${t}
+${o.message}`),Ct.warn("Falling back to basic cli help text output."))}return i===void 0?$n(n):vn(t,i)}async function vn(t,e){let n=(e.commands&&e.commands.some(a=>a.default))??!1,i=bt(e,n),o=t.split(" ")[0];if(e.commands)for(let a of e.commands){if(!a.parentCommandName||!a.commandName)continue;let r=await Be(`${o} ${a.commandName}`);i+=`
+
+${r}`}return i}function $n(t){return`\`\`\`txt
+${t}
+\`\`\``}import{isExecutable as En}from"is-executable";import Ln from"node:path";import{log as Tn}from"remark-mdat";import Nn from"which";async function xt(t){return t??=await Fn(),jn(t)}async function Fn(){let t=await h();if(t!=null&&t.bin){let e=typeof t.bin=="string"?t.bin:String(Object.values(t.bin).at(0));if(_n(e))return Tn.info(`Inferred <!-- cli-help --> command to run from package.json: ${e}`),e}throw new Error(`Could not infer which command to run for the <!-- cli-help --> rule. Please pass a "cliCommand" option to the expansion comment, e.g. <!-- cli-help {cliCommend: './dist/bin.js'} -->`)}function _n(t){let e=Ln.parse(t);return e.root!==""||e.dir!==""}async function jn(t){let e=await Nn(t,{nothrow:!0});if(e===null&&(e=await An(t)??void 0),e!==void 0&&await En(e))return e;throw new Error(`The cli-help rule noticed that "${e}" is not executable.`)}async function An(t){var n;let e=await h();return((n=e==null?void 0:e.bin)==null?void 0:n[t])??void 0}import{z as kt}from"zod";var Rt={"cli-help":{async content(t){let e=kt.object({cliCommand:kt.string().optional()}).optional().parse(t),n=await xt(e==null?void 0:e.cliCommand);return Be(n)}}};import Dn from"node:fs/promises";import Pt from"node:path";import{z as qe}from"zod";var Ot={code:{async content(t){let e=qe.object({file:qe.string(),language:qe.string().optional()}).parse(t),n=Pt.extname(e.file)??"",i=await Dn.readFile(Pt.join(process.cwd(),e.file),"utf8");return`\`\`\`${n}
+${i}
+\`\`\``}}};var oe={contributing:{async content(){var n;let t=await h(),e=(n=t==null?void 0:t.bugs)==null?void 0:n.url;if(e===void 0)throw new Error('Could not find "bugs.url" entry in package.json');return`## Contributing
+[Issues](${e}) and pull requests are welcome.`},order:15,required:!0}};var ie={license:{async content(){let t=await h(),{author:e,license:n}=t;if((e==null?void 0:e.name)===void 0)throw new Error('Could not find "author.name" entry in package.json');if(n===void 0)throw new Error('Could not find "license" entry in package.json');return`## License
+[${n}](license.txt) \xA9 ${e.name}`},order:16,required:!0}};import{getSoleRule as St}from"remark-mdat";var vt={footer:{content:[St(oe),St(ie)],order:17}};var re={"short-description":{async content(){let t=await h();if(t.description===void 0)throw new Error('Could not find "description" entry in package.json');return`**${t.description}**`},order:4,required:!0}};import{z as ae}from"zod";var se={title:{applicationOrder:2,async content(t){let{postfix:e,prefix:n,titleCase:i}=ae.object({postfix:ae.string().optional().default(""),prefix:ae.string().optional().default(""),titleCase:ae.boolean().optional().default(!1)}).parse(t??{}),{name:o}=await h();return`# ${n}${i?In(o):o}${e}`},order:1,required:!0}};function In(t){return t.split(/[ _-]/).map(e=>e.charAt(0).toUpperCase()+e.slice(1)).join(" ")}import{getSoleRule as de}from"remark-mdat";var $t={header:{applicationOrder:2,content:[de(se),de(ne),de(ee),de(re)],order:1}};import{toc as Mn}from"mdast-util-toc";import{remark as Un}from"remark";import Vn from"remark-gfm";import{z as R}from"zod";var me={"table-of-contents":{applicationOrder:1,async content(t,e){let n=R.object({maxDepth:R.union([R.literal(1),R.literal(2),R.literal(3),R.literal(4),R.literal(5),R.literal(6)]).optional()}).optional().parse(t),i=Mn(e,{heading:null,maxDepth:(n==null?void 0:n.maxDepth)??3,tight:!0}),o="## Table of contents";if(i.map===void 0)throw new Error("Could not generate table of contents");let a={children:i.map.children,type:"root"},r=Un().use(Vn).stringify(a).replaceAll(`
+
+`,`
+`);return[o,r].join(`
+`)},order:6}};import{tldrawToImage as Et}from"@kitschpatrol/tldraw-cli";import Jn from"node:crypto";import _ from"node:fs/promises";import b from"node:path";import{isFile as He}from"path-type";import{z as ze}from"zod";var Ft={tldraw:{async content(t){let{alt:e="tldraw diagram",src:n}=ze.object({alt:ze.string().optional(),src:ze.string()}).parse(t),{assetsPath:i}=await w();if(i===void 0)throw new Error("No assets path found");await _.mkdir(i,{recursive:!0});let o=await He(n)?await Tt(n):void 0;if(o!==void 0){let m=b.basename(n,b.extname(n)),c=b.join(i,`${m}-${o}-light.svg`),p=b.join(i,`${m}-${o}-dark.svg`);if(await He(c)&&await He(p))return Lt(c,p,e)}let[a]=await Et(n,{dark:!1,format:"svg",output:i,transparent:!0});o??=await Tt(a);let r=`${Nt(a)}-${o}-light.svg`;await _.rename(a,r);let[s]=await Et(n,{dark:!0,format:"svg",output:i,transparent:!0}),d=`${Nt(s)}-${o}-dark.svg`;if(await _.rename(s,d),o!==void 0){let m=b.basename(d),c=b.basename(r),p=c.replace(`${o}-light.svg`,""),u=await _.readdir(i);for(let g of u){let C=b.basename(g);C!==m&&C!==c&&C.startsWith(p)&&C.endsWith(".svg")&&await _.rm(b.join(i,C))}}return Lt(r,d,e)}}};async function Lt(t,e,n){let{readmeFile:i}=await w();if(i===void 0)throw new Error("No readme file found");let o=b.dirname(i),a=b.relative(o,t);return`<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="${b.relative(o,e)}">
+  <source media="(prefers-color-scheme: light)" srcset="${a}">
+  <img alt="${n}" src="${a}">
+</picture>`}async function Tt(t){let e=await _.readFile(t),n=Jn.createHash("sha1");return n.update(e),n.digest("hex").slice(0,8)}function Nt(t){return t.replace(/\.[^./]+$/,"")}import{getSoleRule as Bn}from"remark-mdat";var _t={toc:{applicationOrder:1,content:[Bn(me)]}};var jt={...ee,...ne,...Rt,...Ot,...oe,...vt,...$t,...ie,...re,...me,...Ft,..._t,...se};async function j(t,e,n,i){let o=await Ge({additionalConfig:n,additionalRules:i});return xe(o.readmeFile,t,e,o)}async function We(t){let e=await Ge({additionalConfig:t});return Re(e.readmeFile,void 0,void 0,e)}async function Ge(t){let e={addMetaComment:!0,rules:jt},{additionalConfig:n=[],...i}=t??{},o=Array.isArray(n)?n:[n],a=await k({additionalConfig:[e,...o],...i});if(a.packageFile===void 0||a.readmeFile===void 0)throw new Error("Package and readme files are required in `mdat readme` config");return a}var At=`<!-- header -->
+
+<!-- table-of-contents -->
+
+## Overview
+
+## Getting started
+
+### Dependencies
+
+### Installation
+
+## Usage
+
+### Library
+
+#### API
+
+#### Examples
+
+### CLI
+
+#### Commands
+
+#### Examples
+
+## Background
+
+### Motivation
+
+### Implementation notes
+
+### Similar projects
+
+## The future
+
+## Maintainers
+
+_List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email)._
+
+## Acknowledgements
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- footer -->
+`;var Dt=`<!-- title -->
+
+<!-- banner -->
+
+<!-- badges -->
+
+<!-- short-description -->
+
+<!-- table-of-contents -->
+
+## Overview
+
+## Getting started
+
+### Dependencies
+
+### Installation
+
+## Usage
+
+### Library
+
+#### API
+
+#### Examples
+
+### CLI
+
+#### Commands
+
+#### Examples
+
+## Background
+
+### Motivation
+
+### Implementation notes
+
+### Similar projects
+
+## The future
+
+## Maintainers
+
+_List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email)._
+
+## Acknowledgements
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- contributing -->
+
+<!-- license -->
+`;var It=`<!-- header -->
+
+## Install
+
+\`\`\`ts
+Code block illustrating how to install.
+\`\`\`
+
+## Usage
+
+\`\`\`ts
+Code block illustrating common usage.
+Consider using the <!-- code { src: "path/to/example.ts" } --> comment as well.
+\`\`\`
+
+<!-- footer -->
+`;var Mt=`<!-- title -->
+
+<!-- short-description -->
+
+<!-- table-of-contents -->
+
+## Install
+
+\`\`\`ts
+Code block illustrating how to install.
+\`\`\`
+
+## Usage
+
+\`\`\`ts
+Code block illustrating common usage.
+Consider using the <!-- code { src: "path/to/example.ts" } --> comment as well.
+\`\`\`
+
+<!-- contributing -->
+
+<!-- license -->
+`;var Ut=`<!-- header -->
+
+_Long description goes here._
+
+_No heading. Cover the main reasons for building the repository. This should describe your module in broad terms, generally in just a few paragraphs; more detail of the module's routines or methods, lengthy code examples, or other in-depth material should be given in subsequent sections._
+
+<!-- table-of-contents -->
+
+## Background
+
+_Cover motivation. Cover abstract dependencies. Cover intellectual provenance: A See Also section is also fitting._
+
+### See also
+
+## Install
+
+\`\`\`ts
+Code block illustrating how to install.
+\`\`\`
+
+### Dependencies
+
+_Required if there are unusual dependencies or dependencies that must be manually installed._
+
+## Usage
+
+\`\`\`ts
+Code block illustrating common usage.
+Consider using the <!-- code { src: "path/to/example.ts" } --> comment as well.
+\`\`\`
+
+\`\`\`ts
+If importable, code block indicating both import functionality and usage.
+\`\`\`
+
+### CLI
+
+\`\`\`ts
+If CLI compatible, code block indicating common usage.
+\`\`\`
+
+## _Extra Sections (Rename)_
+
+## Security
+
+## API
+
+_Describe exported functions and objects._
+
+- _Describe signatures, return types, callbacks, and events._
+- _Cover types covered where not obvious._
+- _Describe caveats._
+- _If using an external API generator (like go-doc, js-doc, or so on), point to an external API.md file. This can be the only item in the section, if present._
+
+## Maintainers
+
+_List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email)._
+
+## Thanks
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- footer -->
+`;var Vt=`<!-- title -->
+
+<!-- banner -->
+
+<!-- badges -->
+
+<!-- short-description -->
+
+_Long description goes here._
+
+_No heading. Cover the main reasons for building the repository. This should describe your module in broad terms, generally in just a few paragraphs; more detail of the module's routines or methods, lengthy code examples, or other in-depth material should be given in subsequent sections._
+
+<!-- table-of-contents -->
+
+## Background
+
+_Cover motivation. Cover abstract dependencies. Cover intellectual provenance: A See Also section is also fitting._
+
+### See also
+
+## Install
+
+\`\`\`ts
+Code block illustrating how to install.
+\`\`\`
+
+### Dependencies
+
+_Required if there are unusual dependencies or dependencies that must be manually installed._
+
+## Usage
+
+\`\`\`ts
+Code block illustrating common usage.
+Consider using the <!-- code { src: "path/to/example.ts" } --> comment as well.
+\`\`\`
+
+\`\`\`ts
+If importable, code block indicating both import functionality and usage.
+\`\`\`
+
+### CLI
+
+\`\`\`ts
+If CLI compatible, code block indicating common usage.
+\`\`\`
+
+## _Extra Sections (Rename)_
+
+## Security
+
+## API
+
+_Describe exported functions and objects._
+
+- _Describe signatures, return types, callbacks, and events._
+- _Cover types covered where not obvious._
+- _Describe caveats._
+- _If using an external API generator (like go-doc, js-doc, or so on), point to an external API.md file. This can be the only item in the section, if present._
+
+## Maintainers
+
+_List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email)._
+
+## Thanks
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- contributing -->
+
+<!-- license -->
+`;var v={"Mdat Readme":{content:{compound:At,explicit:Dt},description:"The house style. An expansive starting point. Prune to your context and taste.",exampleLink:"https://github.com/kitschpatrol/mdat/blob/main/readme.md"},"Standard Readme Basic":{content:{compound:It,explicit:Mt},description:'Includes only the "required" sections from the Standard Readme specification.',exampleLink:"https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/minimal-readme.md"},"Standard Readme Full":{content:{compound:Ut,explicit:Vt},description:"Includes all sections from the Standard Readme specification.",exampleLink:"https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/maximal-readme.md"}};import{confirm as Jt,group as Zn,intro as Qn,note as Bt,outro as Xn,select as Ye}from"@clack/prompts";import P from"chalk";import eo from"node:fs/promises";import ce from"node:path";import{deepMergeDefined as to}from"remark-mdat";import{write as no}from"to-vfile";async function qt(){let t=await G(),e=await Y();return{packageDirectory:e===void 0?void 0:ce.dirname(ce.resolve(e)),readmePath:t}}async function Ht(){let{packageDirectory:t,readmePath:e}=await qt(),n=ce.resolve(process.cwd());Qn(`Running ${P.bold("mdat readme init")} interactively`);let i=await Zn({overwrite:async()=>e===void 0||await Jt({message:`Found an existing readme at "${P.blue(e)}". Do you want to overwrite it?`,active:"Overwrite",inactive:"Exit"})?!0:(()=>{throw new Error("`mdat readme init` was cancelled to avoid an overwrite - no changes were made")})(),output:async()=>t!==void 0&&t!==n?Ye({initialValue:t,message:"There's a root package directory nearby, do you want to create the readme there instead of the current directory?",options:[{label:`Create in the current package root: "${P.blue(t)}"`,value:t},{label:`Create in current working directory: "${P.blue(n)}"`,value:n}]}):n,template:async()=>Ye({message:"Which template would you like to use?",options:io()}),compound:async()=>Ye({message:'Do you want to use "compound comments" where possible, which combine several expansions into a single comment block?',options:[{label:`Yes: Combine things like ${P.green("<!-- title -->")} and ${P.green("<!-- badges -->")} in a single ${P.green("<!-- header -->")} comment.`,value:!0},{label:"No:  Use individual `mdat` expansion comments for each section.",value:!1}]}),expand:async()=>t===void 0?!1:Jt({initialValue:!0,message:"Do you want to run `mdat readme` now to expand the template with content from your package.json?"})},{onCancel(){throw new Error("`mdat readme init` was cancelled - no changes were made")}}),o=await Ke(i);return t===void 0&&Bt("No package.json was found. Once you've created one, you can run `mdat readme` to expand the template with content from your package.json."),Bt(`Readme created: "${P.bold.blue(o)}"`),Xn("Done!"),o}async function Ke(t){let{packageDirectory:e}=await qt(),n=to({compound:!0,output:e??process.cwd(),overwrite:!0,expand:e!==void 0,template:Object.keys(v)[0]},t??{}),i=oo(n.template,n.compound),o=ce.join(n.output,"readme.md");await eo.writeFile(o,i,"utf8");let a=await j(void 0,void 0,{readmeFile:o});return await no(a),o}function oo(t,e){let i=v[t].content[e?"compound":"explicit"];if(i===void 0||i==="")throw new Error(`No template found for "${t}"`);return i}function io(){return Object.entries(v).map(([t,e])=>({label:t,hint:e.description,value:t}))}var $={config:{defaultDescription:"Configuration is loaded if found from the usual places, or defaults are used.",description:"Path(s) to files containing mdat configs.",string:!0,type:"array"}},B={meta:{alias:"m",description:"Embed an extra comment at the top of the generated Markdown noting the date of generation and warning editors that certain sections of the document have been generated dynamically.",type:"boolean"}},q={name:{alias:"n",defaultDescription:"Same name as input file. Overwrites the input file.",description:"Output file name.",type:"string"}},A={output:{alias:"o",defaultDescription:"Same directory as input file.",description:"Output file directory.",type:"string"}},E={prefix:{description:"Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-`mdat` comments in your Markdown file, or if you're willing to trade some verbosity for safety.",type:"string"}},H={print:{description:"Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.",type:"boolean"}},z={rules:{alias:"r",description:"Path(s) to files containing `mdat` comment expansion rules.",string:!0,type:"array"}},O={verbose:{describe:"Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.",type:"boolean"}},pe=["files",{array:!0,demandOption:!0,describe:"Markdown file(s) with `mdat` placeholder comments to collapse.",type:"string"}];var le={readme:{defaultDescription:"The closest readme.md file is used by default.",description:"Path to the readme.md file to expand.",type:"string"}},Ze={package:{defaultDescription:"The closest package.json file is used by default.",description:"Path to the package.json file to use to populate the readme.",string:!0}},Qe={assets:{defaultDescription:"./assets",description:"Path to find and save readme-related assets.",string:!0}},zt={interactive:{alias:"i",default:!0,description:"Run the guided interactive `init` process. Set explicitly to `false` to use default values and skip the prompt.",type:"boolean"}},Wt={overwrite:{default:!1,defaultDescription:"`false`, if an existing readme is found, don't touch it.",description:"Replace an existing readme file if one is found.",type:"boolean"}},Gt={expand:{alias:"e",default:!0,description:"Automatically run `mdat readme` immediately after creating the readme template.",type:"boolean"}},Yt={template:{alias:"t",choices:Object.keys(v),default:Object.keys(v)[0],description:"Specify a template to use for the new readme.",type:"string"}},Kt={compound:{alias:"c",default:!0,description:"Use compound comment version of the template to replace several individual comment placeholders where possible. This combines things like `<!-- title -->`, `<!-- badges -->`, etc. in a single `<!-- header -->` comment. It's less clutter when you're editing, but it's also less explicit. The final readme.md output is identical.",type:"boolean"}};import D from"chalk";import L from"pretty-ms";import{getMdatReports as ro,log as l,reporterMdat as I}from"remark-mdat";import{write as ue}from"to-vfile";import ao from"yargs";import{hideBin as so}from"yargs/helpers";var T=performance.now(),Zt=ao(so(process.argv));try{await Zt.scriptName("mdat").usage("$0 [command] [options]","Work with `mdat` placeholder comments in any Markdown file.").command(["$0 <files..> [options]","expand <files..> [options]"],"Expand `mdat` placeholder comments.",t=>t.positional(...pe).option($).option(z).option(A).option(q).option(B).option(E).option(H).option(O),async({config:t,files:e,meta:n,name:i,output:o,prefix:a,print:r,rules:s,verbose:d})=>{l.verbose=d,fe({name:i,output:o,print:r});let m=ge(e),c=M(t,{addMetaComment:n,keywordPrefix:a}),p=await X(m,i,o,c,s);for(let u of p)r?process.stdout.write(u.toString()):await ue(u);I(p),l.info(`Expanded comments in ${L(performance.now()-T)}.`),process.exitCode=U(p)}).command("check <files..> [options]","Validate a markdown file with `mdat` placeholder comments.",t=>t.positional(...pe).option($).option(z).option(B).option(E).option(O),async({config:t,files:e,meta:n,prefix:i,rules:o,verbose:a})=>{l.verbose=a;let r=ge(e),s=M(t,{addMetaComment:n,keywordPrefix:i}),d=await X(r,void 0,void 0,s,o);I(d),l.info(`Checked comments in ${L(performance.now()-T)}.`),process.exitCode=U(d)}).command("clean <files..> [options]","Collapse `mdat` placeholder comments.",t=>t.positional(...pe).option($).option(A).option(q).option(E).option(H).option(O),async({config:t,files:e,name:n,output:i,prefix:o,print:a,verbose:r})=>{l.verbose=r,fe({name:n,output:i,print:a});let s=ge(e),d=M(t,{keywordPrefix:o}),m=await ke(s,void 0,void 0,d);for(let c of m)a?process.stdout.write(c.toString()):await ue(c);I(m),l.info(`Cleaned comments in ${L(performance.now()-T)}.`),process.exitCode=U(m)}).command("readme [command] [options]","Work with `mdat` comments in your readme.md.",t=>t.command(["$0 [options]","expand [options]"],"Expand `mdat` comment placeholders in your readme.md using a collection of helpful built-in expansion rules.",e=>e.option($).option(z).option(A).option(q).option(le).option(Ze).option(Qe).option(E).option(B).option(H).option(O),async({assets:e,config:n,meta:i,name:o,output:a,package:r,prefix:s,print:d,readme:m,rules:c,verbose:p})=>{l.verbose=p,fe({name:o,output:a,print:d});let u=M(n,{addMetaComment:i,assetsPath:e,keywordPrefix:s,packageFile:r,readmeFile:m}),g=await j(o,a,u,c);d?process.stdout.write(g.toString()):await ue(g),I([g]);let{packageFile:C,readmeFile:he}=await w();l.info(`Expanded comments in readme:   ${D.bold.blue(he)}`),l.info(`Pulled package metadata from: ${D.bold.blue(C)}`),l.info(`Expanded readme in ${L(performance.now()-T)}.`),process.exitCode=U([g])}).command("check [options]","Validate `mdat` placeholder comments in your readme.md.",e=>e.option($).option(z).option(le).option(Ze).option(Qe).option(E).option(B).option(O),async({assets:e,config:n,meta:i,package:o,prefix:a,readme:r,rules:s,verbose:d})=>{l.verbose=d;let m=M(n,{addMetaComment:i,assetsPath:e,keywordPrefix:a,packageFile:o,readmeFile:r}),c=await j(void 0,void 0,m,s);I([c]);let{packageFile:p,readmeFile:u}=await w();l.info(`Checked comments in readme:   ${D.bold.blue(u)}`),l.info(`Pulled package metadata from: ${D.bold.blue(p)}`),l.info(`Checked readme in ${L(performance.now()-T)}.`),process.exitCode=U([c])}).command("clean [options]","Collapse `mdat` placeholder comments in your readme.md.",e=>e.option(A).option(q).option(H).option($).option(le).option(E).option(O),async({config:e,name:n,output:i,prefix:o,print:a,readme:r,verbose:s})=>{l.verbose=s,fe({name:n,output:i,print:a});let d=M(e,{keywordPrefix:o,readmeFile:r}),m=await We(d);a?process.stdout.write(m.toString()):await ue(m),I([m]);let{readmeFile:c}=await w();l.info(`Cleaned comments in readme:   ${D.bold.blue(c)}`),l.info(`Cleaned readme in ${L(performance.now()-T)}.`),process.exitCode=U([m])}).command("init [options]","Interactively create a new readme.md file with sensible `mdat` comment placeholders.",e=>e.option(zt).option(Wt).option(A).option(Gt).option(Yt).option(Kt).option(O),async({compound:e,expand:n,interactive:i,output:o,overwrite:a,template:r,verbose:s})=>{if(l.verbose=s,i)await Ht();else{let d=await Ke({compound:e,expand:n,output:o,overwrite:a,template:r});l.info(`Created readme at "${D.blue(d)}" in ${L(performance.now()-T)}.`)}process.exitCode=0}),()=>{l.error("Root mdat readme command should be unreachable.")}).help().alias("h","help").version().alias("v","version").wrap(process.stdout.isTTY?Math.min(120,Zt.terminalWidth()):0).fail(!1).parse()}catch(t){t instanceof Error&&l.error(t.message),process.exitCode=1}function fe(t){t.print&&t.output&&l.warn("Ignoring --output option because --print is set"),t.print&&t.name&&l.warn("Ignoring --name option because --print is set")}function ge(t){return t==null?[]:Array.isArray(t)?t:[t]}function M(t,e){return[...ge(t),e]}function U(t){return ro(t).reduce((i,o)=>i+o.errors.length,0)>0?1:0}

package/dist/api.d.ts

@@ -1,37 +1,20 @@
-import { type MdatCleanOptions, type Options as MdatOptions, type Rules } from 'remark-mdat';
+import { type ConfigToLoad, type RulesToLoad } from './config';
 import { VFile } from 'vfile';
-/**
- * Generously accept either string paths to .ts, .js, or .json files with
- * `MdatOptions` type default exports. Takes a single value, or an array of values which
- * will be merged right to left.
- */
-export type ExpandConfig<T extends MdatOptions = MdatOptions> = Array<T | string> | T | string;
-/**
- * Generously accept either string paths to .ts, .js, or .json files with
- * `MdatOptions` type default exports. Takes a single value, or an array of values which
- * will be merged right to left.
- */
-export type CleanConfig<T extends Partial<MdatCleanOptions> = Partial<MdatCleanOptions>> = Array<T | string> | T | string;
-/**
- * Generously accept either string paths to .ts, .js, or .json files with
- * `Rules` type default exports.
- */
-export type ExpandRules = Array<Rules | string> | Rules | string;
 /**
  * Writing is the responsibility of the caller (e.g. via `await write(result)`)
  */
-export declare function expandFiles(files: string[], name?: string, output?: string, config?: ExpandConfig, rules?: ExpandRules): Promise<VFile[]>;
+export declare function expandFiles(files: string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
 /**
  * Writing is the responsibility of the caller (e.g. via `await write(result)`)
  */
-export declare function expandFile(file: string, name?: string, output?: string, config?: ExpandConfig, rules?: ExpandRules): Promise<VFile>;
-export declare function expandString(markdown: string, config?: ExpandConfig, rules?: ExpandRules): Promise<VFile>;
+export declare function expandFile(file: string, name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+export declare function expandString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
 /**
  * Writing is the responsibility of the caller (e.g. via `await write(result)`)
  */
-export declare function cleanFiles(files: string[], name?: string, output?: string, config?: CleanConfig): Promise<VFile[]>;
+export declare function cleanFiles(files: string[], name?: string, output?: string, config?: ConfigToLoad): Promise<VFile[]>;
 /**
  * Writing is the responsibility of the caller (e.g. via `await write(result)`)
  */
-export declare function cleanFile(file: string, name?: string, output?: string, config?: CleanConfig): Promise<VFile>;
-export declare function cleanString(markdown: string, config: CleanConfig): Promise<VFile>;
+export declare function cleanFile(file: string, name?: string, output?: string, config?: ConfigToLoad): Promise<VFile>;
+export declare function cleanString(markdown: string, config: ConfigToLoad): Promise<VFile>;

package/dist/config.d.ts

@@ -1,6 +1,31 @@
+import { type NormalizedPackageJson } from 'read-pkg';
 import { type Options, type Rules } from 'remark-mdat';
-import { type z } from 'zod';
-export type MdatConfig = Options;
+export type Config = {
+    assetsPath?: string;
+    packageFile?: string;
+    readmeFile?: string;
+} & Options;
+export type ConfigLoaded = {
+    addMetaComment: boolean;
+    assetsPath: string;
+    closingPrefix: string;
+    keywordPrefix: string;
+    metaCommentIdentifier: string;
+    packageFile: string | undefined;
+    readmeFile: string | undefined;
+    rules: Rules;
+};
+/**
+ * Generously accept either string paths to .ts, .js, or .json files with
+ * `Config` type default exports. Takes a single value, or an array of values which
+ * will be merged right to left.
+ */
+export type ConfigToLoad = Array<Config | string> | Config | string;
+/**
+ * Generously accept either string paths to .ts, .js, or .json files with
+ * `Rules` type default exports.
+ */
+export type RulesToLoad = Array<Rules | string> | Rules | string;
 /**
  * Load and validate mdat configuration / rule sets
  * Uses cosmiconfig to search in the usual places.
@@ -8,7 +33,7 @@ export type MdatConfig = Options;
  *
  * Generic to accommodate additional Config options, so set T to your custom config type if needed. You must provide a matching configExtensionSchema as well.
  */
-export declare function loadConfig<T extends MdatConfig>(options?: {
+export declare function loadConfig(options?: {
     /**
      * Additional Config objects to merge.
      *
@@ -16,16 +41,16 @@ export declare function loadConfig<T extends MdatConfig>(options?: {
      * Accepts an individual item, or an array. Objects in the array will be merged right to left.
      *
      */
-    additionalConfig?: Array<T | string> | T | string | undefined;
+    additionalConfig?: ConfigToLoad;
     /**
      * Additional Rules objects to merge.
      *
      * Strings are treated as paths to `ts`, `js`, or `json` files with `Rules` type default exports. These will be dynamically loaded by Cosmiconfig.
      * Accepts an individual item, or an array. Objects in the array will be merged right to left, and take precedence over any rules in previously loaded Config objects as well.
      */
-    additionalRules?: Array<Rules | string> | Rules | string | undefined;
-    /** Additional zod schema that will be merged with the top level of the config schema and used for config validation. Default mdat-remark options schema is used if not provided. Useful if extending config for things like mdat-readme. */
-    configExtensionSchema?: z.ZodObject<any>;
+    additionalRules?: RulesToLoad;
     /** Search for config in specific directories, mainly useful for testing. Cosmiconfig default search paths used if unset. */
     searchFrom?: string;
-}): Promise<T>;
+}): Promise<ConfigLoaded>;
+export declare function getConfig(): Promise<ConfigLoaded>;
+export declare function getPackageJson(): Promise<NormalizedPackageJson>;

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export { type CleanConfig, type ExpandConfig, type ExpandRules, cleanFile, cleanFiles, cleanString, expandFile, expandFiles, expandString, } from './api';
-export { type MdatConfig, loadConfig } from './config';
+export { cleanFile, cleanFiles, cleanString, expandFile, expandFiles, expandString } from './api';
+export { type Config, loadConfig } from './config';
+export { cleanReadme, expandReadme, expandReadmeString, loadConfigReadme } from './readme/api';
+export { type Rules } from 'remark-mdat';