mdat 1.3.3 → 1.3.5

package/dist/bin/cli.js

@@ -0,0 +1,278 @@
+#!/usr/bin/env node
+import e from"picocolors";import t from"pretty-ms";import{deepMergeDefined as n,getMdatReports as r,getSoleRule as i,log as a,mdatCheck as o,mdatClean as s,mdatExpand as c,mdatSplit as l,optionsSchema as u,reporterMdat as d,rulesSchema as f}from"remark-mdat";import{read as p,write as m}from"to-vfile";import ee from"yargs";import{hideBin as h}from"yargs/helpers";import{cosmiconfig as g,defaultLoaders as te}from"cosmiconfig";import{TypeScriptLoader as ne}from"cosmiconfig-typescript-loader";import _ from"node:fs/promises";import v from"node:path";import re from"plur";import{readPackage as ie}from"read-pkg";import{z as y}from"zod";import{packageUp as ae}from"package-up";import{isFile as oe,isFileSync as b}from"path-type";import{Configuration as se}from"unified-engine";import ce from"untildify";import{remark as x}from"remark";import S from"remark-gfm";import"vfile";import{globby as le}from"globby";import{promisify as ue}from"node:util";import{brotliCompress as de,gzip as fe}from"node:zlib";import pe from"pretty-bytes";import{toc as me}from"mdast-util-toc";import{findUp as he}from"find-up";import{packageDirectory as ge}from"package-directory";import{confirm as _e,group as ve,intro as ye,note as be,outro as xe,select as C}from"@clack/prompts";var Se=`1.3.5`;function Ce(e,t){let n=te[`.json`];return we(n(e,t))}function we(e,t=``,n={}){for(let[r,i]of Object.entries(e)){let e=t?`${t}.${r}`:r;typeof i==`object`&&i&&!Array.isArray(i)?we(i,e,n):i===null?n[e]=`null`:n[e]=i.toString()}return n}function Te(e,t){let n=t===0?1:Math.floor(Math.log10(Math.abs(t))+1);return e.toString().padStart(n,`0`)}async function Ee(e,t,n,r){let i=[];for(let[a,o]of e.entries()){let s=await De(o,t,n,r,n&&e.length>1?`-${Te(a+1,e.length)}`:``);i.push(s)}return i}async function De(e,t,n,r,i=``){let a=w(e),o=t?w(t):void 0;if(!b(a))throw Error(`Input file not found: "${a}"`);if(o){if(b(o))throw Error(`Output path must be a directory, received a file path: "${o}"`);await _.mkdir(o,{recursive:!0})}return{input:a,name:`${n?v.basename(n,v.extname(n)):v.basename(a,v.extname(a))}${i}${`.${r??(n&&v.extname(n)!==``?v.extname(n):v.extname(e)===``?``:v.extname(e))}`}`,output:o??v.dirname(a)}}function w(e){return ce(e)}async function T(){return ae()}function E(e){return e==null?[]:Array.isArray(e)?e:[e]}async function Oe(){let e=new se({cwd:process.cwd(),detectConfig:!0,packageField:`remarkConfig`,rcName:`.remarkrc`}),t=await new Promise(t=>{e.load(``,(e,n)=>{if(e){a.error(String(e)),t(void 0);return}t(n)})});if(t){let{filePath:e}=t;return e===void 0?a.info(`No ambient Remark configuration file found`):a.info(`Found and loaded ambient Remark configuration from "${e}"`),t}return a.info(`No ambient Remark configuration found`),{filePath:void 0,plugins:[],settings:{}}}const D=u.merge(y.object({assetsPath:y.string().optional(),packageFile:y.string().optional()})).describe(`Config Extension`);async function O(t){let{additionalConfig:r,additionalRules:i,readmeDefaults:o,searchFrom:s}=t??{};A=void 0,M=void 0;let c={addMetaComment:!1,assetsPath:`./assets`,closingPrefix:`/`,keywordPrefix:``,metaCommentIdentifier:`+`,packageFile:await T(),rules:{mdat:`Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat).`}};o&&(c=n(c,o));let l=g(`mdat`,{loaders:{".ts":ne()}}),u=await l.search(s);if(u){let{config:e,filepath:t}=u,r=e;if(a.info(`Using config from "${t}"`),t.endsWith(`package.json`)&&typeof e==`string`){a.info(`Detected shared config string: "${e}"`);let{default:t}=await import(e);r=t}let i=k(r,D);i&&(c=n(c,i))}if(r!==void 0){let e=Array.isArray(r)?r:[r];for(let t of e){let e;if(typeof t==`string`){let n=await l.load(t);if(n==null)continue;let{config:r,filepath:i}=n;a.info(`Loaded additional config from "${i}"`),e=r}else e=t;if(e===void 0)continue;a.info(`Merging configuration object`);let r=k(e,D);r!==void 0&&(c=n(c,r))}}if(i!==void 0){let e=Array.isArray(i)?i:[i],t=g(`mdat`,{loaders:{".json":Ce,".ts":ne()}});for(let r of e){let e;if(typeof r==`string`){let n;if(n=v.basename(r).endsWith(`package.json`)?{config:Ce(r,await _.readFile(r,`utf8`)),filepath:r}:await t.load(r),n==null)continue;let{config:i,filepath:o}=n;a.info(`Loaded additional config from "${o}"`),e=i}else e=r;if(e===void 0)continue;a.info(`Merging rules into configuration object`);let i=ke(e,f);i!==void 0&&(c=n(c,i))}}if(c.rules){let t=Object.keys(c.rules).toSorted().map(t=>`"${e.green(e.bold(t))}"`);a.info(`Loaded ${e.bold(t.length)} mdat comment expansion ${re(`rule`,t.length)}:`);for(let e of t)a.info(`\t${e}`)}else a.error(`No rules loaded from additional configurations or rules, using default.`);return A=c,c}function ke(e,t){if(t.safeParse(e).success)return{rules:e};a.error(`Rules object has the wrong shape. Ignoring and using default configuration:\n${JSON.stringify(e,void 0,2)}`)}function k(e,t){if(t.safeParse(e).success)return e;a.error(`Config object has the wrong shape. Ignoring and using default configuration:\n${JSON.stringify(e,void 0,2)}`)}let A;async function j(){return A===void 0&&(a.warn(`getConfig(): config was undefined`),A??=await O()),A}let M;async function N(){let{packageFile:e}=await j();if(e===void 0)throw Error(`No packageFile found or set in config`);if(M??=await ie({cwd:v.dirname(e)}),M===void 0)throw Error(`No package.json found`);return M}async function P(e,t,n,r,i,a,o){let s=await t({additionalConfig:a,additionalRules:o}),c=await Oe(),l=await Ee(E(e),i,r,`md`),u=[],d=n(s,c);for(let{input:e,name:t,output:n}of l){let r=await p(e),i=await d.process(r);i.dirname=n,i.basename=t,u.push(i)}return u}function Ae(e,t){return x().use({settings:{bullet:`-`,emphasis:`_`}}).use(S).use(t).use(()=>async function(t,n){l(t,n),s(t,n,e),await c(t,n,e)})}function je(e,t){return x().use({settings:{bullet:`-`,emphasis:`_`}}).use(S).use(t).use(()=>function(t,n){l(t,n),s(t,n,e)})}function Me(e,t){return x().use({settings:{bullet:`-`,emphasis:`_`}}).use(S).use(t).use(()=>async function(t,n){await o(t,n,{...e,paranoid:!1})})}async function Ne(e,t,n,r,i){return P(e,O,Ae,t,n,r,i)}async function Pe(e,t,n,r,i){return P(e,O,Me,t,n,r,i)}async function Fe(e,t,n,r,i){return P(e,O,je,t,n,r,i)}var Ie={badges:{async content(e){let t=y.object({custom:y.record(y.object({image:y.string(),link:y.string()})).optional(),npm:y.array(y.string()).optional()}).optional().parse(e),n=await N(),{name:r}=n,i=[];if(t?.npm===void 0)(!n.name.startsWith(`@`)||n.publishConfig?.access===`public`)&&i.push(`[![NPM Package ${r}](https://img.shields.io/npm/v/${r}.svg)](https://npmjs.com/package/${r})`);else for(let e of t.npm)i.push(`[![NPM Package ${e}](https://img.shields.io/npm/v/${e}.svg)](https://npmjs.com/package/${e})`);let{license:a}=n;if(a!==void 0&&i.push(`[![License: ${a}](https://img.shields.io/badge/License-${a.replaceAll(`-`,`--`)}-yellow.svg)](https://opensource.org/licenses/${a})`),t?.custom!==void 0)for(let[e,{image:n,link:r}]of Object.entries(t.custom))i.push(`[![${e}](${n})](${r})`);return i.join(`
+`)},order:3}},Le={banner:{async content(e){let t=y.object({alt:y.string().optional(),src:y.string().optional()}).optional().parse(e),{assetsPath:n,packageFile:r}=await j();if(r===void 0)throw Error(`No package.json found`);let i=t?.src??await Re(n)??await Re();if(i===void 0)throw Error(`Banner image not found at any typical location, consider adding something at ./assets/banner.webp`);if(!ze(i)&&!await oe(i))throw Error(`Banner image not found at "${i}"`);let a=t?.alt;if(a===void 0){let e=(await ie({cwd:v.dirname(r)})).name;if(e===void 0)throw Error(`Banner image alt text not available`);a=`${e} banner`}return`![${a}](${i})`},order:2}};async function Re(e){let{packageFile:t}=await j();if(t===void 0)throw Error(`No package.json found`);let n=v.dirname(t),r=await le((e===void 0?[`.`,`assets`,`media`,`readme-assets`,`readme-media`,`readme`,`images`,`.github/assets`]:[e]).map(e=>v.join(n,e)),{deep:1,expandDirectories:{extensions:[`png`,`gif`,`jpg`,`jpeg`,`svg`,`webp`],files:[`banner`,`cover`,`demo`,`header`,`hero`,`image`,`logo`,`overview`,`readme`,`screenshot`,`screenshots`,`splash`]}});if(r.length>0)return v.relative(process.cwd(),r[0])}function ze(e,t=!0){if(typeof e!=`string`)throw TypeError(`Expected a string`);if(e=e.trim(),e.includes(` `))return!1;try{return new URL(e),!0}catch{return t?ze(`https://${e}`,!1):!1}}var Be={code:{async content(e){let t=y.object({file:y.string(),language:y.string().optional()}).parse(e);return`\`\`\`${(v.extname(t.file)??``).replace(/^\./,``)}\n${await _.readFile(v.join(process.cwd(),t.file),`utf8`)}\n\`\`\``}}},Ve={contributing:{async content(){let e=(await N()).bugs?.url;if(e===void 0)throw Error(`Could not find "bugs.url" entry in package.json`);return`## Contributing\n[Issues](${e}) and pull requests are welcome.`},order:15}},He={description:{async content(){let e=await N();if(e.description===void 0)throw Error(`Could not find "description" entry in package.json`);return`**${e.description}**`},order:4}},Ue={license:{async content(){let{author:e,license:t}=await N();if(e?.name===void 0)throw Error(`Could not find "author.name" entry in package.json`);if(t===void 0)throw Error(`Could not find "license" entry in package.json`);return`## License\n[${t}](license.txt) © ${e.name}`},order:16}},We={footer:{content:[i(Ve),i(Ue)],order:17}},F={"short-description":i(He)},Ge={title:{applicationOrder:2,async content(e){let{postfix:t,prefix:n,titleCase:r}=y.object({postfix:y.string().optional().default(``),prefix:y.string().optional().default(``),titleCase:y.boolean().optional().default(!1)}).parse(e??{}),{name:i}=await N();return`# ${n}${r?Ke(i):i}${t}`},order:1}};function Ke(e){return e.split(/[ _-]+/).filter(Boolean).map(e=>e.charAt(0).toUpperCase()+e.slice(1)).join(` `)}var qe={header:{applicationOrder:2,content:[i(Ge),i(Le),i(Ie),i(F)],order:1}};const Je=ue(de),Ye=ue(fe);function I(e,t){let n=t===0?0:(t-e)/t*100;return{bytes:e,bytesPretty:pe(e,{maximumFractionDigits:1}),percent:n,percentPretty:`${Math.round(n)}%`}}async function Xe(e){try{let t=await _.readFile(e),n=t.length,[r,i]=await Promise.all([Je(t),Ye(t)]);return{brotli:I(r.length,n),gzip:I(i.length,n),original:I(n,n)}}catch(e){throw Error(`Failed to analyze file: ${e instanceof Error?e.message:`Unknown error`}`)}}const Ze=y.object({compression:y.enum([`none`,`brotli`,`gzip`]).optional().default(`none`),file:y.string()});function Qe(e,t){switch(t){case`brotli`:return e.brotli.bytesPretty;case`gzip`:return e.gzip.bytesPretty;case`none`:return e.original.bytesPretty}}var $e={size:{async content(e){let t=Ze.parse(e);return Qe(await Xe(v.join(process.cwd(),t.file)),t.compression)}}};const et=y.union([y.string(),y.array(y.string())]).transform(e=>Array.isArray(e)?e:[e]),tt=y.union([y.object({brotli:y.boolean().optional().default(!0),file:et,gzip:y.boolean().optional().default(!0),original:y.boolean().optional().default(!0),showPercentage:y.boolean().optional().default(!1)}),y.object({brotli:y.boolean().optional().default(!0),files:et,gzip:y.boolean().optional().default(!0),original:y.boolean().optional().default(!0),showPercentage:y.boolean().optional().default(!1)})]).transform(e=>{if(`file`in e){let{file:t,...n}=e;return{files:t,...n}}return e});function nt(e,t){let n=[`File`];t.original&&n.push(`Original`),t.gzip&&n.push(`Gzip`),t.brotli&&n.push(`Brotli`);let r=n.map(()=>`---`),i=e.map(([e,n])=>{let r=[v.basename(e)];return t.original&&r.push(n.original.bytesPretty),t.gzip&&r.push(t.showPercentage?`${n.gzip.bytesPretty} (${n.gzip.percentPretty})`:n.gzip.bytesPretty),t.brotli&&r.push(t.showPercentage?`${n.brotli.bytesPretty} (${n.brotli.percentPretty})`:n.brotli.bytesPretty),r});return[`| ${n.join(` | `)} |`,`| ${r.join(` | `)} |`,...i.map(e=>`| ${e.join(` | `)} |`)].join(`
+`)}var rt={"size-table":{async content(e){let t=tt.parse(e);return nt(await Promise.all(t.files.map(async e=>[e,await Xe(v.join(process.cwd(),e))])),{brotli:t.brotli,gzip:t.gzip,original:t.original,showPercentage:t.showPercentage})}}},it={"table-of-contents":{applicationOrder:1,async content(e,t){let n=me(t,{heading:null,maxDepth:y.object({depth:y.union([y.literal(1),y.literal(2),y.literal(3),y.literal(4),y.literal(5),y.literal(6)]).optional()}).optional().parse(e)?.depth??3,tight:!0});if(n.map===void 0)throw Error(`Could not generate table of contents`);let r={children:n.map.children,type:`root`};return[`## Table of contents`,x().use(S).stringify(r).replaceAll(`
+
+`,`
+`)].join(`
+`)},order:6}},at={toc:i(it)},ot={...Ie,...Le,...Be,...Ve,...He,...We,...qe,...Ue,...F,...$e,...rt,...it,...Ge,...at};async function L(e){let t={addMetaComment:!0,rules:ot},{additionalConfig:n=[],readmeDefaults:r=t,...i}=e??{},a=await O({additionalConfig:Array.isArray(n)?n:[n],readmeDefaults:r,...i});if(a.packageFile===void 0)throw Error("Package file path is required in `mdat readme` config");return a}async function st(){a.info(`Searching for package directory...`);let e=await he(`readme.md`,{stopAt:await ge()??process.cwd(),type:`file`});if(e!==void 0)return a.info(`Found closest readme at "${e}"`),e}async function R(){let e=await st();if(e===void 0)throw Error(`No readme found`);return e}async function ct(e,t,n,r,i){return e??=await R(),P(e,L,Ae,t,n,r,i)}async function lt(e,t,n,r,i){return e??=await R(),P(e,L,Me,t,n,r,i)}async function ut(e,t,n,r,i){return e??=await R(),P(e,L,je,t,n,r,i)}var dt=`<!-- 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)._
+
+## Acknowledgments
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- footer -->
+`,ft=`<!-- 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)._
+
+## Acknowledgments
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- contributing -->
+
+<!-- license -->
+`,pt=`<!-- header -->
+
+## Install
+
+\`\`\`sh
+# 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 -->
+`,mt=`<!-- title -->
+
+<!-- short-description -->
+
+<!-- table-of-contents -->
+
+## Install
+
+\`\`\`sh
+# 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 -->
+`,ht=`<!-- 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
+
+\`\`\`sh
+# 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 -->
+`,gt=`<!-- 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
+
+\`\`\`sh
+# 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 -->
+`,z={"MDAT Readme":{content:{compound:dt,explicit:ft},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:pt,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:ht,explicit:gt},description:`Includes all sections from the Standard Readme specification.`,exampleLink:`https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/maximal-readme.md`}};async function _t(){let e=await st(),t=await T();return{packageDirectory:t===void 0?void 0:v.dirname(v.resolve(t)),readmePath:e}}async function vt(){let{packageDirectory:t,readmePath:n}=await _t(),r=v.resolve(process.cwd());ye(`Running ${e.bold(`mdat readme init`)} interactively`);let i=await yt(await ve({overwrite:async()=>n===void 0||await _e({message:`Found an existing readme at "${e.blue(n)}". Do you want to overwrite it?`,active:`Overwrite`,inactive:`Exit`})?!0:(()=>{throw Error("`mdat readme init` was cancelled to avoid an overwrite - no changes were made")})(),output:async()=>t!==void 0&&t!==r?C({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: "${e.blue(t)}"`,value:t},{label:`Create in current working directory: "${e.blue(r)}"`,value:r}]}):r,template:async()=>C({message:`Which template would you like to use?`,options:xt()}),compound:async()=>C({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 ${e.green(`<!-- title -->`)} and ${e.green(`<!-- badges -->`)} in a single ${e.green(`<!-- header -->`)} comment.`,value:!0},{label:`No:  Use individual MDAT expansion comments for each section.`,value:!1}]}),expand:async()=>t===void 0?!1:_e({initialValue:!0,message:"Do you want to run `mdat readme` now to expand the template with content from your package.json?"})},{onCancel(){throw Error("`mdat readme init` was cancelled - no changes were made")}}));return t===void 0&&be("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."),be(`Readme created: "${e.blue(e.bold(i))}"`),xe(`Done!`),i}async function yt(e){let{packageDirectory:t}=await _t(),r=n({compound:!0,output:t??process.cwd(),overwrite:!0,expand:t!==void 0,template:Object.keys(z)[0]},e??{}),i=bt(r.template,r.compound),a=v.join(r.output,`readme.md`);if(!r.overwrite&&await _.access(a).then(()=>!0,()=>!1))throw Error(`Readme already exists at "${a}". Use the overwrite option to replace it.`);if(await _.writeFile(a,i,`utf8`),r.expand){let[e]=await ct(a);await m(e)}return a}function bt(e,t){let n=z[e].content[t?`compound`:`explicit`];if(n===void 0||n===``)throw Error(`No template found for "${e}"`);return n}function xt(){return Object.entries(z).map(([e,t])=>({label:e,hint:t.description,value:e}))}const B={config:{defaultDescription:`Configuration is loaded if found from the usual places, or defaults are used.`,description:`Path(s) to files containing MDAT configuration.`,string:!0,type:`array`}},V={meta:{alias:`m`,coerce(e){return typeof e==`string`?e.toLowerCase()===`false`||e===`0`?!1:e.toLowerCase()===`true`||e===`1`?!0:e:e},description:"Embed an extra comment at the top of the generated Markdown warning editors that certain sections of the document have been generated dynamically. Can be a `boolean` to enable/disable the default message, or a `string` to provide a custom message. Defaults to `false` for `mdat` commands and `true` for `mdat readme` commands."}},H={name:{alias:`n`,defaultDescription:`Same name as input file. Overwrites the input file.`,description:`Output file name.`,type:`string`}},U={output:{alias:`o`,defaultDescription:`Same directory as input file.`,description:`Output file directory.`,type:`string`}},W={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`}},G={print:{description:"Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.",type:`boolean`}},K={rules:{alias:`r`,description:`Path(s) to files containing MDAT comment expansion rules.`,string:!0,type:`array`}},q={verbose:{describe:`Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.`,type:`boolean`}},J=[`files`,{array:!0,demandOption:!0,describe:`Markdown file(s) with MDAT placeholder comments.`,type:`string`}],St={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}},Ct={assets:{defaultDescription:`./assets`,description:`Path to find and save readme-related assets.`,string:!0}},wt={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`}},Tt={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`}},Et={expand:{alias:`e`,default:!0,description:"Automatically run `mdat readme` immediately after creating the readme template.",type:`boolean`}},Dt={template:{alias:`t`,choices:Object.keys(z),default:Object.keys(z)[0],description:`Specify a template to use for the new readme.`,type:`string`}},Ot={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`}},Y=[`files`,{array:!0,demandOption:!1,describe:`Readme file(s) with MDAT placeholder comments. If not provided, the closest readme.md file is used.`,type:`string`}],X=performance.now(),kt=ee(h(process.argv));try{await kt.scriptName(`mdat`).usage(`$0 [command]`,`Work with MDAT placeholder comments in any Markdown file.`).command([`$0 <files..> [options]`,`expand <files..> [options]`],`Expand MDAT placeholder comments.`,e=>e.positional(...J).option(B).option(K).option(U).option(H).option(V).option(W).option(G).option(q),async({config:e,files:n,meta:r,name:i,output:o,prefix:s,print:c,rules:l,verbose:u})=>{a.verbose=u??!1,Z({name:i,output:o,print:c});let f=await Ne(n,i,o,Q(e,{addMetaComment:r,keywordPrefix:s}),l);for(let e of f)c?process.stdout.write(e.toString()):await m(e);d(f),a.info(`Expanded comments in ${t(performance.now()-X)}.`),process.exitCode=$(f)}).command(`check <files..> [options]`,`Validate a Markdown file containing MDAT placeholder comments.`,e=>e.positional(...J).option(B).option(K).option(V).option(W).option(q),async({config:e,files:n,meta:r,prefix:i,rules:o,verbose:s})=>{a.verbose=s??!1;let c=await Pe(n,void 0,void 0,Q(e,{addMetaComment:r,keywordPrefix:i}),o);d(c),a.info(`Checked comments in ${t(performance.now()-X)}.`),process.exitCode=$(c)}).command(`collapse <files..> [options]`,`Collapse MDAT placeholder comments.`,e=>e.positional(...J).option(B).option(U).option(H).option(W).option(G).option(q),async({config:e,files:n,name:r,output:i,prefix:o,print:s,verbose:c})=>{a.verbose=c??!1,Z({name:r,output:i,print:s});let l=await Fe(n,r,i,Q(e,{keywordPrefix:o}));for(let e of l)s?process.stdout.write(e.toString()):await m(e);d(l),a.info(`Cleaned comments in ${t(performance.now()-X)}.`),process.exitCode=$(l)}).command(`readme [command]`,`Work with MDAT comments in your readme.md.`,n=>n.command([`$0 [files..] [options]`,`expand [files..] [options]`],`Expand MDAT comment placeholders in your readme.md using a collection of helpful built-in expansion rules.`,e=>e.positional(...Y).option(B).option(K).option(U).option(H).option(St).option(Ct).option(W).option(V).option(G).option(q),async({assets:n,config:r,files:i,meta:o,name:s,output:c,package:l,prefix:u,print:f,rules:p,verbose:ee})=>{a.verbose=ee??!1,Z({name:s,output:c,print:f});let h=await ct(i,s,c,Q(r,{addMetaComment:o,assetsPath:n,keywordPrefix:u,packageFile:l}),p);for(let e of h)f?process.stdout.write(e.toString()):await m(e);d(h);let{packageFile:g}=await j();g!==void 0&&a.info(`Pulled package metadata from: ${e.blue(e.bold(g))}`),a.info(`Expanded readme(s) in ${t(performance.now()-X)}.`),process.exitCode=$(h)}).command(`check [files..] [options]`,`Validate MDAT placeholder comments in your readme.md.`,e=>e.positional(...Y).option(B).option(K).option(St).option(Ct).option(W).option(V).option(q),async({assets:n,config:r,files:i,meta:o,package:s,prefix:c,rules:l,verbose:u})=>{a.verbose=u??!1;let f=await lt(i,void 0,void 0,Q(r,{addMetaComment:o,assetsPath:n,keywordPrefix:c,packageFile:s}),l);d(f);let{packageFile:p}=await j();p!==void 0&&a.info(`Pulled package metadata from: ${e.blue(e.bold(p))}`),a.info(`Checked readme(s) in ${t(performance.now()-X)}.`),process.exitCode=$(f)}).command(`collapse [files..] [options]`,`Collapse MDAT placeholder comments in your readme.md.`,e=>e.positional(...Y).option(U).option(H).option(G).option(B).option(W).option(q),async({config:e,files:n,name:r,output:i,prefix:o,print:s,verbose:c})=>{a.verbose=c??!1,Z({name:r,output:i,print:s});let l=await ut(n,r,i,Q(e,{keywordPrefix:o}));for(let e of l)s?process.stdout.write(e.toString()):await m(e);d(l),a.info(`Cleaned readme(s) in ${t(performance.now()-X)}.`),process.exitCode=$(l)}).command(`init [options]`,`Interactively create a new readme.md file with sensible default MDAT comment placeholders.`,e=>e.option(wt).option(Tt).option(U).option(Et).option(Dt).option(Ot).option(q),async({compound:n,expand:r,interactive:i,output:o,overwrite:s,template:c,verbose:l})=>{if(a.verbose=l??!1,i)await vt();else{let i=await yt({compound:n,expand:r,output:o,overwrite:s,template:c});a.info(`Created readme at "${e.blue(i)}" in ${t(performance.now()-X)}.`)}process.exitCode=0}),()=>{a.error(`Root MDAT readme command should be unreachable.`)}).help().alias(`h`,`help`).version(Se).alias(`v`,`version`).wrap(process.stdout.isTTY?Math.min(120,kt.terminalWidth()):0).fail(!1).parse()}catch(e){e instanceof Error&&a.error(e.message),process.exitCode=1}function Z(e){e.print&&e.output&&a.warn(`Ignoring --output option because --print is set`),e.print&&e.name&&a.warn(`Ignoring --name option because --print is set`)}function Q(e,t){return[...E(e),t]}function $(e){return r(e).reduce((e,t)=>e+t.errors.length,0)>0?1:0}export{};

package/dist/lib/index.d.ts

@@ -0,0 +1,156 @@
+import "read-pkg";
+import { Options, Rules } from "remark-mdat";
+import { VFile } from "vfile";
+import { Simplify } from "type-fest";
+
+//#region src/lib/config.d.ts
+type Config = Simplify<Options & {
+  assetsPath?: string;
+  packageFile?: string;
+}>;
+type ConfigLoaded = {
+  addMetaComment: boolean | string;
+  assetsPath: string;
+  closingPrefix: string;
+  keywordPrefix: string;
+  metaCommentIdentifier: string;
+  packageFile: 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.
+ */
+type ConfigToLoad = Array<Config | string> | Config | string;
+/**
+ * Generously accept either string paths to .ts, .js, or .json files with
+ * `Rules` type default exports.
+ */
+type RulesToLoad = Array<Rules | string> | Rules | string;
+/**
+ * Load and validate mdat configuration / rule sets
+ * Uses cosmiconfig to search in the usual places.
+ * Merge precedence: Base Defaults < Readme Defaults < Searched Config < Additional Config Paths
+ *
+ * Generic to accommodate additional Config options, so set T to your custom config type if needed. You must provide a matching configExtensionSchema as well.
+ */
+declare function loadConfig(options?: {
+  /**
+   * Additional Config objects to merge.
+   *
+   * Strings are treated as paths to `ts`, `js`, or `json` files with `Config` 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.
+   *
+   */
+  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?: RulesToLoad;
+  /**
+   * Readme-specific defaults that have higher priority than base defaults but lower than searched config.
+   * Used internally by loadConfigReadme.
+   */
+  readmeDefaults?: Config; /** Search for config in specific directories, mainly useful for testing. Cosmiconfig default search paths used if unset. */
+  searchFrom?: string;
+}): Promise<ConfigLoaded>;
+/**
+ * Convenience function for merging configs
+ * Performs a deep merge, with the rightmost object taking precedence
+ */
+declare function mergeConfigs(a: Config, b: Config): Config;
+//#endregion
+//#region src/lib/api.d.ts
+/**
+ * Expand MDAT comments in one or more Markdown files
+ * Writing is the responsibility of the caller (e.g. via `await write(result)`)
+ * @returns an array of VFiles (Even if you only pass a single file path!)
+ */
+declare function expandFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Expand MDAT comments in a Markdown string
+ */
+declare function expandString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Check and validate MDAT comments in one or more Markdown files
+ * @returns an array of VFiles (Even if you only pass a single file path!)
+ */
+declare function checkFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Check and validate MDAT comments in a Markdown string
+ */
+declare function checkString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Collapse MDAT comments in one or more Markdown files
+ * Writing is the responsibility of the caller (e.g. via `await write(result)`)
+ * @returns an array of VFiles (Even if you only pass a single file path!)
+ */
+declare function collapseFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Collapse MDAT comments in a Markdown string
+ */
+declare function collapseString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+//#endregion
+//#region src/lib/readme/api.d.ts
+/**
+ * Expands MDAT readme comments in the closest readme.md file
+ * Basically an alias to `expandReadmeFiles()` with certain arguments elided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function expandReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Expands MDAT readme comments in one or more Markdown files
+ * Searches up for a readme.md file if none is provided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function expandReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Expands MDAT readme comments in a Markdown string
+ */
+declare function expandReadmeString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Checks and validates MDAT readme comments in the closest readme.md file
+ * Basically an alias to `checkReadmeFiles()` with certain arguments elided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function checkReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Checks and validates MDAT readme comments in one or more Markdown files
+ * Searches up for a readme.md file if none is provided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function checkReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Checks and validates MDAT readme comments in a Markdown string
+ */
+declare function checkReadmeString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Collapses MDAT readme comments in the closest readme.md file
+ * Basically an alias to `collapseReadmeFiles()` with certain arguments elided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function collapseReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Collapses MDAT readme comments in one or more Markdown files
+ * Searches up for a readme.md file if none is provided.
+ * @see `findReadme()` for more details on the search process.
+ */
+declare function collapseReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+//#endregion
+//#region src/lib/readme/config.d.ts
+type ReadmeConfigLoaded = Simplify<ConfigLoaded & {
+  packageFile: string;
+}>;
+type LoadConfigOptions = Parameters<typeof loadConfig>[0];
+/**
+ * Convenience loader to always include the default readme config.
+ * The readme defaults should have lower priority than searched/user config,
+ * but higher priority than base mdat defaults.
+ */
+declare function loadConfigReadme(options?: LoadConfigOptions): Promise<ReadmeConfigLoaded>;
+//#endregion
+export { type Config, type Rules, checkFiles, checkReadme, checkReadmeFiles, checkReadmeString, checkString, collapseFiles, collapseReadme, collapseReadmeFiles, collapseString, expandFiles, expandReadme, expandReadmeFiles, expandReadmeString, expandString, loadConfig, loadConfigReadme, mergeConfigs };

package/dist/lib/index.js

@@ -0,0 +1,7 @@
+import{cosmiconfig as e,defaultLoaders as t}from"cosmiconfig";import{TypeScriptLoader as n}from"cosmiconfig-typescript-loader";import r from"node:fs/promises";import i from"node:path";import a from"picocolors";import o from"plur";import{readPackage as s}from"read-pkg";import{deepMergeDefined as c,getSoleRule as l,log as u,mdatCheck as d,mdatClean as f,mdatExpand as p,mdatSplit as m,optionsSchema as h,rulesSchema as ee}from"remark-mdat";import{z as g}from"zod";import{packageUp as te}from"package-up";import{isFile as ne,isFileSync as _}from"path-type";import{Configuration as re}from"unified-engine";import ie from"untildify";import{remark as v}from"remark";import y from"remark-gfm";import{read as ae}from"to-vfile";import{VFile as oe}from"vfile";import{globby as se}from"globby";import{promisify as b}from"node:util";import{brotliCompress as ce,gzip as le}from"node:zlib";import ue from"pretty-bytes";import{toc as de}from"mdast-util-toc";import{findUp as fe}from"find-up";import{packageDirectory as pe}from"package-directory";function x(e,n){let r=t[`.json`];return S(r(e,n))}function S(e,t=``,n={}){for(let[r,i]of Object.entries(e)){let e=t?`${t}.${r}`:r;typeof i==`object`&&i&&!Array.isArray(i)?S(i,e,n):i===null?n[e]=`null`:n[e]=i.toString()}return n}function me(e,t){let n=t===0?1:Math.floor(Math.log10(Math.abs(t))+1);return e.toString().padStart(n,`0`)}async function he(e,t,n,r){let i=[];for(let[a,o]of e.entries()){let s=await ge(o,t,n,r,n&&e.length>1?`-${me(a+1,e.length)}`:``);i.push(s)}return i}async function ge(e,t,n,a,o=``){let s=C(e),c=t?C(t):void 0;if(!_(s))throw Error(`Input file not found: "${s}"`);if(c){if(_(c))throw Error(`Output path must be a directory, received a file path: "${c}"`);await r.mkdir(c,{recursive:!0})}return{input:s,name:`${n?i.basename(n,i.extname(n)):i.basename(s,i.extname(s))}${o}${`.${a??(n&&i.extname(n)!==``?i.extname(n):i.extname(e)===``?``:i.extname(e))}`}`,output:c??i.dirname(s)}}function C(e){return ie(e)}async function _e(){return te()}function ve(e){return e==null?[]:Array.isArray(e)?e:[e]}async function w(){let e=new re({cwd:process.cwd(),detectConfig:!0,packageField:`remarkConfig`,rcName:`.remarkrc`}),t=await new Promise(t=>{e.load(``,(e,n)=>{if(e){u.error(String(e)),t(void 0);return}t(n)})});if(t){let{filePath:e}=t;return e===void 0?u.info(`No ambient Remark configuration file found`):u.info(`Found and loaded ambient Remark configuration from "${e}"`),t}return u.info(`No ambient Remark configuration found`),{filePath:void 0,plugins:[],settings:{}}}const T=h.merge(g.object({assetsPath:g.string().optional(),packageFile:g.string().optional()})).describe(`Config Extension`);async function E(t){let{additionalConfig:s,additionalRules:l,readmeDefaults:d,searchFrom:f}=t??{};O=void 0,A=void 0;let p={addMetaComment:!1,assetsPath:`./assets`,closingPrefix:`/`,keywordPrefix:``,metaCommentIdentifier:`+`,packageFile:await _e(),rules:{mdat:`Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat).`}};d&&(p=c(p,d));let m=e(`mdat`,{loaders:{".ts":n()}}),h=await m.search(f);if(h){let{config:e,filepath:t}=h,n=e;if(u.info(`Using config from "${t}"`),t.endsWith(`package.json`)&&typeof e==`string`){u.info(`Detected shared config string: "${e}"`);let{default:t}=await import(e);n=t}let r=D(n,T);r&&(p=c(p,r))}if(s!==void 0){let e=Array.isArray(s)?s:[s];for(let t of e){let e;if(typeof t==`string`){let n=await m.load(t);if(n==null)continue;let{config:r,filepath:i}=n;u.info(`Loaded additional config from "${i}"`),e=r}else e=t;if(e===void 0)continue;u.info(`Merging configuration object`);let n=D(e,T);n!==void 0&&(p=c(p,n))}}if(l!==void 0){let t=Array.isArray(l)?l:[l],a=e(`mdat`,{loaders:{".json":x,".ts":n()}});for(let e of t){let t;if(typeof e==`string`){let n;if(n=i.basename(e).endsWith(`package.json`)?{config:x(e,await r.readFile(e,`utf8`)),filepath:e}:await a.load(e),n==null)continue;let{config:o,filepath:s}=n;u.info(`Loaded additional config from "${s}"`),t=o}else t=e;if(t===void 0)continue;u.info(`Merging rules into configuration object`);let n=ye(t,ee);n!==void 0&&(p=c(p,n))}}if(p.rules){let e=Object.keys(p.rules).toSorted().map(e=>`"${a.green(a.bold(e))}"`);u.info(`Loaded ${a.bold(e.length)} mdat comment expansion ${o(`rule`,e.length)}:`);for(let t of e)u.info(`\t${t}`)}else u.error(`No rules loaded from additional configurations or rules, using default.`);return O=p,p}function ye(e,t){if(t.safeParse(e).success)return{rules:e};u.error(`Rules object has the wrong shape. Ignoring and using default configuration:\n${JSON.stringify(e,void 0,2)}`)}function D(e,t){if(t.safeParse(e).success)return e;u.error(`Config object has the wrong shape. Ignoring and using default configuration:\n${JSON.stringify(e,void 0,2)}`)}let O;async function k(){return O===void 0&&(u.warn(`getConfig(): config was undefined`),O??=await E()),O}let A;async function j(){let{packageFile:e}=await k();if(e===void 0)throw Error(`No packageFile found or set in config`);if(A??=await s({cwd:i.dirname(e)}),A===void 0)throw Error(`No package.json found`);return A}function be(e,t){return c(e,t)}async function M(e,t,n,r,i,a,o){let s=await t({additionalConfig:a,additionalRules:o}),c=await w(),l=await he(ve(e),i,r,`md`),u=[],d=n(s,c);for(let{input:e,name:t,output:n}of l){let r=await ae(e),i=await d.process(r);i.dirname=n,i.basename=t,u.push(i)}return u}async function N(e,t,n,r,i){return n(await t({additionalConfig:r,additionalRules:i}),await w()).process(new oe(e))}function P(e,t){return v().use({settings:{bullet:`-`,emphasis:`_`}}).use(y).use(t).use(()=>async function(t,n){m(t,n),f(t,n,e),await p(t,n,e)})}function F(e,t){return v().use({settings:{bullet:`-`,emphasis:`_`}}).use(y).use(t).use(()=>function(t,n){m(t,n),f(t,n,e)})}function I(e,t){return v().use({settings:{bullet:`-`,emphasis:`_`}}).use(y).use(t).use(()=>async function(t,n){await d(t,n,{...e,paranoid:!1})})}async function xe(e,t,n,r,i){return M(e,E,P,t,n,r,i)}async function Se(e,t,n){return N(e,E,P,t,n)}async function Ce(e,t,n,r,i){return M(e,E,I,t,n,r,i)}async function we(e,t,n){return N(e,E,I,t,n)}async function Te(e,t,n,r,i){return M(e,E,F,t,n,r,i)}async function Ee(e,t,n){return N(e,E,F,t,n)}var L={badges:{async content(e){let t=g.object({custom:g.record(g.object({image:g.string(),link:g.string()})).optional(),npm:g.array(g.string()).optional()}).optional().parse(e),n=await j(),{name:r}=n,i=[];if(t?.npm===void 0)(!n.name.startsWith(`@`)||n.publishConfig?.access===`public`)&&i.push(`[![NPM Package ${r}](https://img.shields.io/npm/v/${r}.svg)](https://npmjs.com/package/${r})`);else for(let e of t.npm)i.push(`[![NPM Package ${e}](https://img.shields.io/npm/v/${e}.svg)](https://npmjs.com/package/${e})`);let{license:a}=n;if(a!==void 0&&i.push(`[![License: ${a}](https://img.shields.io/badge/License-${a.replaceAll(`-`,`--`)}-yellow.svg)](https://opensource.org/licenses/${a})`),t?.custom!==void 0)for(let[e,{image:n,link:r}]of Object.entries(t.custom))i.push(`[![${e}](${n})](${r})`);return i.join(`
+`)},order:3}},R={banner:{async content(e){let t=g.object({alt:g.string().optional(),src:g.string().optional()}).optional().parse(e),{assetsPath:n,packageFile:r}=await k();if(r===void 0)throw Error(`No package.json found`);let a=t?.src??await z(n)??await z();if(a===void 0)throw Error(`Banner image not found at any typical location, consider adding something at ./assets/banner.webp`);if(!B(a)&&!await ne(a))throw Error(`Banner image not found at "${a}"`);let o=t?.alt;if(o===void 0){let e=(await s({cwd:i.dirname(r)})).name;if(e===void 0)throw Error(`Banner image alt text not available`);o=`${e} banner`}return`![${o}](${a})`},order:2}};async function z(e){let{packageFile:t}=await k();if(t===void 0)throw Error(`No package.json found`);let n=i.dirname(t),r=await se((e===void 0?[`.`,`assets`,`media`,`readme-assets`,`readme-media`,`readme`,`images`,`.github/assets`]:[e]).map(e=>i.join(n,e)),{deep:1,expandDirectories:{extensions:[`png`,`gif`,`jpg`,`jpeg`,`svg`,`webp`],files:[`banner`,`cover`,`demo`,`header`,`hero`,`image`,`logo`,`overview`,`readme`,`screenshot`,`screenshots`,`splash`]}});if(r.length>0)return i.relative(process.cwd(),r[0])}function B(e,t=!0){if(typeof e!=`string`)throw TypeError(`Expected a string`);if(e=e.trim(),e.includes(` `))return!1;try{return new URL(e),!0}catch{return t?B(`https://${e}`,!1):!1}}var De={code:{async content(e){let t=g.object({file:g.string(),language:g.string().optional()}).parse(e);return`\`\`\`${(i.extname(t.file)??``).replace(/^\./,``)}\n${await r.readFile(i.join(process.cwd(),t.file),`utf8`)}\n\`\`\``}}},V={contributing:{async content(){let e=(await j()).bugs?.url;if(e===void 0)throw Error(`Could not find "bugs.url" entry in package.json`);return`## Contributing\n[Issues](${e}) and pull requests are welcome.`},order:15}},H={description:{async content(){let e=await j();if(e.description===void 0)throw Error(`Could not find "description" entry in package.json`);return`**${e.description}**`},order:4}},U={license:{async content(){let{author:e,license:t}=await j();if(e?.name===void 0)throw Error(`Could not find "author.name" entry in package.json`);if(t===void 0)throw Error(`Could not find "license" entry in package.json`);return`## License\n[${t}](license.txt) © ${e.name}`},order:16}},Oe={footer:{content:[l(V),l(U)],order:17}},W={"short-description":l(H)},G={title:{applicationOrder:2,async content(e){let{postfix:t,prefix:n,titleCase:r}=g.object({postfix:g.string().optional().default(``),prefix:g.string().optional().default(``),titleCase:g.boolean().optional().default(!1)}).parse(e??{}),{name:i}=await j();return`# ${n}${r?ke(i):i}${t}`},order:1}};function ke(e){return e.split(/[ _-]+/).filter(Boolean).map(e=>e.charAt(0).toUpperCase()+e.slice(1)).join(` `)}var Ae={header:{applicationOrder:2,content:[l(G),l(R),l(L),l(W)],order:1}};const je=b(ce),Me=b(le);function K(e,t){let n=t===0?0:(t-e)/t*100;return{bytes:e,bytesPretty:ue(e,{maximumFractionDigits:1}),percent:n,percentPretty:`${Math.round(n)}%`}}async function q(e){try{let t=await r.readFile(e),n=t.length,[i,a]=await Promise.all([je(t),Me(t)]);return{brotli:K(i.length,n),gzip:K(a.length,n),original:K(n,n)}}catch(e){throw Error(`Failed to analyze file: ${e instanceof Error?e.message:`Unknown error`}`)}}const Ne=g.object({compression:g.enum([`none`,`brotli`,`gzip`]).optional().default(`none`),file:g.string()});function Pe(e,t){switch(t){case`brotli`:return e.brotli.bytesPretty;case`gzip`:return e.gzip.bytesPretty;case`none`:return e.original.bytesPretty}}var Fe={size:{async content(e){let t=Ne.parse(e);return Pe(await q(i.join(process.cwd(),t.file)),t.compression)}}};const J=g.union([g.string(),g.array(g.string())]).transform(e=>Array.isArray(e)?e:[e]),Ie=g.union([g.object({brotli:g.boolean().optional().default(!0),file:J,gzip:g.boolean().optional().default(!0),original:g.boolean().optional().default(!0),showPercentage:g.boolean().optional().default(!1)}),g.object({brotli:g.boolean().optional().default(!0),files:J,gzip:g.boolean().optional().default(!0),original:g.boolean().optional().default(!0),showPercentage:g.boolean().optional().default(!1)})]).transform(e=>{if(`file`in e){let{file:t,...n}=e;return{files:t,...n}}return e});function Le(e,t){let n=[`File`];t.original&&n.push(`Original`),t.gzip&&n.push(`Gzip`),t.brotli&&n.push(`Brotli`);let r=n.map(()=>`---`),a=e.map(([e,n])=>{let r=[i.basename(e)];return t.original&&r.push(n.original.bytesPretty),t.gzip&&r.push(t.showPercentage?`${n.gzip.bytesPretty} (${n.gzip.percentPretty})`:n.gzip.bytesPretty),t.brotli&&r.push(t.showPercentage?`${n.brotli.bytesPretty} (${n.brotli.percentPretty})`:n.brotli.bytesPretty),r});return[`| ${n.join(` | `)} |`,`| ${r.join(` | `)} |`,...a.map(e=>`| ${e.join(` | `)} |`)].join(`
+`)}var Re={"size-table":{async content(e){let t=Ie.parse(e);return Le(await Promise.all(t.files.map(async e=>[e,await q(i.join(process.cwd(),e))])),{brotli:t.brotli,gzip:t.gzip,original:t.original,showPercentage:t.showPercentage})}}},Y={"table-of-contents":{applicationOrder:1,async content(e,t){let n=de(t,{heading:null,maxDepth:g.object({depth:g.union([g.literal(1),g.literal(2),g.literal(3),g.literal(4),g.literal(5),g.literal(6)]).optional()}).optional().parse(e)?.depth??3,tight:!0});if(n.map===void 0)throw Error(`Could not generate table of contents`);let r={children:n.map.children,type:`root`};return[`## Table of contents`,v().use(y).stringify(r).replaceAll(`
+
+`,`
+`)].join(`
+`)},order:6}},ze={toc:l(Y)},Be={...L,...R,...De,...V,...H,...Oe,...Ae,...U,...W,...Fe,...Re,...Y,...G,...ze};async function X(e){let t={addMetaComment:!0,rules:Be},{additionalConfig:n=[],readmeDefaults:r=t,...i}=e??{},a=await E({additionalConfig:Array.isArray(n)?n:[n],readmeDefaults:r,...i});if(a.packageFile===void 0)throw Error("Package file path is required in `mdat readme` config");return a}async function Ve(){u.info(`Searching for package directory...`);let e=await fe(`readme.md`,{stopAt:await pe()??process.cwd(),type:`file`});if(e!==void 0)return u.info(`Found closest readme at "${e}"`),e}async function Z(){let e=await Ve();if(e===void 0)throw Error(`No readme found`);return e}async function He(e,t){return Q(void 0,void 0,void 0,e,t)}async function Q(e,t,n,r,i){return e??=await Z(),M(e,X,P,t,n,r,i)}async function Ue(e,t,n){return N(e,X,P,t,n)}async function We(e,t){return Ge(void 0,void 0,void 0,e,t)}async function Ge(e,t,n,r,i){return e??=await Z(),M(e,X,I,t,n,r,i)}async function Ke(e,t,n){return N(e,X,I,t,n)}async function qe(e,t){return $(void 0,void 0,void 0,e,t)}async function $(e,t,n,r,i){return e??=await Z(),M(e,X,F,t,n,r,i)}export{Ce as checkFiles,We as checkReadme,Ge as checkReadmeFiles,Ke as checkReadmeString,we as checkString,Te as collapseFiles,qe as collapseReadme,$ as collapseReadmeFiles,Ee as collapseString,xe as expandFiles,He as expandReadme,Q as expandReadmeFiles,Ue as expandReadmeString,Se as expandString,E as loadConfig,X as loadConfigReadme,be as mergeConfigs};

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-2025 Eric Mika
+Copyright (c) 2024-2026 Eric Mika
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "1.3.3",
+  "version": "1.3.5",
   "description": "CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.",
   "keywords": [
     "mdat",
@@ -26,66 +26,78 @@
     "url": "https://ericmika.com"
   },
   "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/lib/index.d.ts",
+      "import": "./dist/lib/index.js"
+    }
+  },
+  "main": "./dist/lib/index.js",
+  "module": "./dist/lib/index.js",
+  "types": "./dist/lib/index.d.ts",
   "bin": {
-    "mdat": "bin/cli.js"
+    "mdat": "dist/bin/cli.js"
   },
   "files": [
-    "bin/*",
     "dist/*"
   ],
   "dependencies": {
-    "@clack/prompts": "^0.11.0",
-    "@types/mdast": "^4.0.4",
-    "@types/node": "^22.19.1",
-    "@types/unist": "^3.0.3",
-    "@types/yargs": "^17.0.35",
+    "@clack/prompts": "^1.0.1",
     "cosmiconfig": "^9.0.0",
     "cosmiconfig-typescript-loader": "^6.2.0",
-    "globby": "^14.1.0",
-    "read-pkg": "^10.0.0",
-    "remark-mdat": "^1.2.1",
-    "type-fest": "^5.3.1",
-    "unified-engine": "^11.2.2",
-    "vfile": "^6.0.3"
-  },
-  "devDependencies": {
-    "@kitschpatrol/shared-config": "^5.10.0",
-    "bumpp": "^10.3.2",
-    "execa": "^9.6.1",
     "find-up": "^8.0.0",
+    "globby": "^16.1.1",
     "mdast-util-toc": "^7.1.0",
-    "mdat-plugin-cli-help": "^1.0.4",
-    "mdat-plugin-example": "^1.0.1",
-    "mdat-plugin-tldraw": "^1.0.2",
-    "nanoid": "^5.1.6",
-    "package-directory": "^8.1.0",
+    "package-directory": "^8.2.0",
     "package-up": "^5.0.0",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
     "pretty-bytes": "^7.1.0",
     "pretty-ms": "^9.3.0",
+    "read-pkg": "^10.1.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
+    "remark-mdat": "^1.2.3",
     "to-vfile": "^8.0.0",
-    "tsdown": "^0.17.1",
-    "typescript": "~5.9.3",
-    "unplugin-raw": "^0.6.3",
+    "type-fest": "^5.4.4",
+    "unified-engine": "^11.2.2",
     "untildify": "^6.0.0",
-    "vitest": "^4.0.15",
-    "yargs": "^17.7.2",
+    "vfile": "^6.0.3",
+    "yargs": "^18.0.0",
     "zod": "^3.25.76"
   },
+  "devDependencies": {
+    "@arethetypeswrong/core": "^0.18.2",
+    "@kitschpatrol/shared-config": "^6.0.0",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "~20.19.33",
+    "@types/unist": "^3.0.3",
+    "@types/yargs": "^17.0.35",
+    "bumpp": "^10.4.1",
+    "execa": "^9.6.1",
+    "mdat-plugin-cli-help": "^1.0.6",
+    "mdat-plugin-example": "^1.0.4",
+    "mdat-plugin-tldraw": "^1.0.6",
+    "nanoid": "^5.1.6",
+    "publint": "^0.3.17",
+    "tsdown": "^0.20.3",
+    "typescript": "~5.9.3",
+    "unplugin-raw": "^0.6.4",
+    "vitest": "^4.0.18"
+  },
   "engines": {
     "node": ">=20.19.0"
   },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": ">=22.21.0"
+    }
+  },
   "scripts": {
-    "build": "tsdown && tsc -p tsconfig.build.lib.json",
+    "build": "tsdown",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
-    "dev": "pnpm run test",
     "fix": "ksc fix",
     "lint": "ksc lint",
     "release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",