markdown-magic 4.0.3 → 4.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-magic",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "Automatically update markdown files with content from external sources",
   "main": "src/index.js",
   "bin": {
@@ -22,6 +22,11 @@
     "docs": "node examples/generate-readme.js",
     "test": "uvu . '.test.([mc]js|[jt]sx?)$'",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
+    "bundle": "npm run bundle:all",
+    "bundle:all": "npm run bundle:mac && npm run bundle:linux && npm run bundle:windows",
+    "bundle:mac": "bun build ./cli.js --compile --minify --target=bun-darwin-arm64 --outfile dist/md-magic-darwin-arm64 && bun build ./cli.js --compile --minify --target=bun-darwin-x64 --outfile dist/md-magic-darwin-x64",
+    "bundle:linux": "bun build ./cli.js --compile --minify --target=bun-linux-x64 --outfile dist/md-magic-linux-x64 && bun build ./cli.js --compile --minify --target=bun-linux-arm64 --outfile dist/md-magic-linux-arm64",
+    "bundle:windows": "bun build ./cli.js --compile --minify --target=bun-windows-x64 --outfile dist/md-magic-windows-x64.exe",
     "postpublish": "git push origin && git push origin --tags",
     "release:patch": "pnpm version patch --git-tag-version && pnpm publish",
     "release:minor": "pnpm version minor --git-tag-version && pnpm publish",
@@ -36,9 +41,10 @@
   },
   "dependencies": {
     "@davidwells/md-utils": "0.0.53",
-    "comment-block-parser": "1.1.0",
-    "comment-block-replacer": "0.1.2",
-    "comment-block-transformer": "0.2.1",
+    "color-convert": "^2.0.1",
+    "comment-block-parser": "1.1.2",
+    "comment-block-replacer": "0.1.4",
+    "comment-block-transformer": "0.2.3",
     "globrex": "^0.1.2",
     "gray-matter": "^4.0.3",
     "is-glob": "^4.0.3",
@@ -48,14 +54,12 @@
     "module-alias": "^2.2.3",
     "mri": "^1.2.0",
     "node-fetch": "^2.7.0",
-    "oparser": "^3.0.22",
+    "oparser": "^3.0.24",
     "punycode": "^2.3.1",
     "smart-glob": "^1.0.2",
-    "string-width": "^4.2.3",
-    "sync-request": "^6.1.0"
+    "string-width": "^4.2.3"
   },
   "devDependencies": {
-    "ansi-styles": "^4.2.1",
     "concordance": "^5.0.1",
     "doxxx": "^2.0.7",
     "rimraf": "^3.0.2",
@@ -66,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ddedd0639200db28f1b1d0e3b805603ffaa234ee"
+  "gitHead": "7d81950b7a6d27d1192b1bc2d0f19d1d5ff0f321"
 }

package/src/cli-run.js

@@ -21,6 +21,33 @@ function findSingleDashStrings(arr) {
 }
 
 async function runCli(options = {}, rawArgv) {
+  if (options.help || options.h) {
+    console.log(`
+Usage: md-magic [options] [files...]
+
+Options:
+  --files, --file    Files or glob patterns to process
+  --config           Path to config file (default: md.config.js)
+  --output           Output directory
+  --dry              Dry run - show what would be changed
+  --debug            Show debug output
+  --help, -h         Show this help message
+  --version, -v      Show version
+
+Examples:
+  md-magic README.md
+  md-magic --files "**/*.md"
+  md-magic --config ./my-config.js
+`)
+    return
+  }
+
+  if (options.version || options.v) {
+    const pkg = require('../package.json')
+    console.log(pkg.version)
+    return
+  }
+
   let configFile
   let opts = {}
 

package/src/utils/ansi-styles.d.ts

@@ -0,0 +1,345 @@
+declare type CSSColor =
+	| 'aliceblue'
+	| 'antiquewhite'
+	| 'aqua'
+	| 'aquamarine'
+	| 'azure'
+	| 'beige'
+	| 'bisque'
+	| 'black'
+	| 'blanchedalmond'
+	| 'blue'
+	| 'blueviolet'
+	| 'brown'
+	| 'burlywood'
+	| 'cadetblue'
+	| 'chartreuse'
+	| 'chocolate'
+	| 'coral'
+	| 'cornflowerblue'
+	| 'cornsilk'
+	| 'crimson'
+	| 'cyan'
+	| 'darkblue'
+	| 'darkcyan'
+	| 'darkgoldenrod'
+	| 'darkgray'
+	| 'darkgreen'
+	| 'darkgrey'
+	| 'darkkhaki'
+	| 'darkmagenta'
+	| 'darkolivegreen'
+	| 'darkorange'
+	| 'darkorchid'
+	| 'darkred'
+	| 'darksalmon'
+	| 'darkseagreen'
+	| 'darkslateblue'
+	| 'darkslategray'
+	| 'darkslategrey'
+	| 'darkturquoise'
+	| 'darkviolet'
+	| 'deeppink'
+	| 'deepskyblue'
+	| 'dimgray'
+	| 'dimgrey'
+	| 'dodgerblue'
+	| 'firebrick'
+	| 'floralwhite'
+	| 'forestgreen'
+	| 'fuchsia'
+	| 'gainsboro'
+	| 'ghostwhite'
+	| 'gold'
+	| 'goldenrod'
+	| 'gray'
+	| 'green'
+	| 'greenyellow'
+	| 'grey'
+	| 'honeydew'
+	| 'hotpink'
+	| 'indianred'
+	| 'indigo'
+	| 'ivory'
+	| 'khaki'
+	| 'lavender'
+	| 'lavenderblush'
+	| 'lawngreen'
+	| 'lemonchiffon'
+	| 'lightblue'
+	| 'lightcoral'
+	| 'lightcyan'
+	| 'lightgoldenrodyellow'
+	| 'lightgray'
+	| 'lightgreen'
+	| 'lightgrey'
+	| 'lightpink'
+	| 'lightsalmon'
+	| 'lightseagreen'
+	| 'lightskyblue'
+	| 'lightslategray'
+	| 'lightslategrey'
+	| 'lightsteelblue'
+	| 'lightyellow'
+	| 'lime'
+	| 'limegreen'
+	| 'linen'
+	| 'magenta'
+	| 'maroon'
+	| 'mediumaquamarine'
+	| 'mediumblue'
+	| 'mediumorchid'
+	| 'mediumpurple'
+	| 'mediumseagreen'
+	| 'mediumslateblue'
+	| 'mediumspringgreen'
+	| 'mediumturquoise'
+	| 'mediumvioletred'
+	| 'midnightblue'
+	| 'mintcream'
+	| 'mistyrose'
+	| 'moccasin'
+	| 'navajowhite'
+	| 'navy'
+	| 'oldlace'
+	| 'olive'
+	| 'olivedrab'
+	| 'orange'
+	| 'orangered'
+	| 'orchid'
+	| 'palegoldenrod'
+	| 'palegreen'
+	| 'paleturquoise'
+	| 'palevioletred'
+	| 'papayawhip'
+	| 'peachpuff'
+	| 'peru'
+	| 'pink'
+	| 'plum'
+	| 'powderblue'
+	| 'purple'
+	| 'rebeccapurple'
+	| 'red'
+	| 'rosybrown'
+	| 'royalblue'
+	| 'saddlebrown'
+	| 'salmon'
+	| 'sandybrown'
+	| 'seagreen'
+	| 'seashell'
+	| 'sienna'
+	| 'silver'
+	| 'skyblue'
+	| 'slateblue'
+	| 'slategray'
+	| 'slategrey'
+	| 'snow'
+	| 'springgreen'
+	| 'steelblue'
+	| 'tan'
+	| 'teal'
+	| 'thistle'
+	| 'tomato'
+	| 'turquoise'
+	| 'violet'
+	| 'wheat'
+	| 'white'
+	| 'whitesmoke'
+	| 'yellow'
+	| 'yellowgreen';
+
+declare namespace AnsiStylesTypes {
+	interface ColorConvert {
+		/**
+		The RGB color space.
+
+		@param red - (`0`-`255`)
+		@param green - (`0`-`255`)
+		@param blue - (`0`-`255`)
+		*/
+		rgb(red: number, green: number, blue: number): string;
+
+		/**
+		The RGB HEX color space.
+
+		@param hex - A hexadecimal string containing RGB data.
+		*/
+		hex(hex: string): string;
+
+		/**
+		@param keyword - A CSS color name.
+		*/
+		keyword(keyword: CSSColor): string;
+
+		/**
+		The HSL color space.
+
+		@param hue - (`0`-`360`)
+		@param saturation - (`0`-`100`)
+		@param lightness - (`0`-`100`)
+		*/
+		hsl(hue: number, saturation: number, lightness: number): string;
+
+		/**
+		The HSV color space.
+
+		@param hue - (`0`-`360`)
+		@param saturation - (`0`-`100`)
+		@param value - (`0`-`100`)
+		*/
+		hsv(hue: number, saturation: number, value: number): string;
+
+		/**
+		The HSV color space.
+
+		@param hue - (`0`-`360`)
+		@param whiteness - (`0`-`100`)
+		@param blackness - (`0`-`100`)
+		*/
+		hwb(hue: number, whiteness: number, blackness: number): string;
+
+		/**
+		Use a [4-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4-bit) to set text color.
+		*/
+		ansi(ansi: number): string;
+
+		/**
+		Use an [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) to set text color.
+		*/
+		ansi256(ansi: number): string;
+	}
+
+	interface CSPair {
+		/**
+		The ANSI terminal control sequence for starting this style.
+		*/
+		readonly open: string;
+
+		/**
+		The ANSI terminal control sequence for ending this style.
+		*/
+		readonly close: string;
+	}
+
+	interface ColorBase {
+		readonly ansi: ColorConvert;
+		readonly ansi256: ColorConvert;
+		readonly ansi16m: ColorConvert;
+
+		/**
+		The ANSI terminal control sequence for ending this color.
+		*/
+		readonly close: string;
+	}
+
+	interface Modifier {
+		/**
+		Resets the current color chain.
+		*/
+		readonly reset: CSPair;
+
+		/**
+		Make text bold.
+		*/
+		readonly bold: CSPair;
+
+		/**
+		Emitting only a small amount of light.
+		*/
+		readonly dim: CSPair;
+
+		/**
+		Make text italic. (Not widely supported)
+		*/
+		readonly italic: CSPair;
+
+		/**
+		Make text underline. (Not widely supported)
+		*/
+		readonly underline: CSPair;
+
+		/**
+		Inverse background and foreground colors.
+		*/
+		readonly inverse: CSPair;
+
+		/**
+		Prints the text, but makes it invisible.
+		*/
+		readonly hidden: CSPair;
+
+		/**
+		Puts a horizontal line through the center of the text. (Not widely supported)
+		*/
+		readonly strikethrough: CSPair;
+	}
+
+	interface ForegroundColor {
+		readonly black: CSPair;
+		readonly red: CSPair;
+		readonly green: CSPair;
+		readonly yellow: CSPair;
+		readonly blue: CSPair;
+		readonly cyan: CSPair;
+		readonly magenta: CSPair;
+		readonly white: CSPair;
+
+		/**
+		Alias for `blackBright`.
+		*/
+		readonly gray: CSPair;
+
+		/**
+		Alias for `blackBright`.
+		*/
+		readonly grey: CSPair;
+
+		readonly blackBright: CSPair;
+		readonly redBright: CSPair;
+		readonly greenBright: CSPair;
+		readonly yellowBright: CSPair;
+		readonly blueBright: CSPair;
+		readonly cyanBright: CSPair;
+		readonly magentaBright: CSPair;
+		readonly whiteBright: CSPair;
+	}
+
+	interface BackgroundColor {
+		readonly bgBlack: CSPair;
+		readonly bgRed: CSPair;
+		readonly bgGreen: CSPair;
+		readonly bgYellow: CSPair;
+		readonly bgBlue: CSPair;
+		readonly bgCyan: CSPair;
+		readonly bgMagenta: CSPair;
+		readonly bgWhite: CSPair;
+
+		/**
+		Alias for `bgBlackBright`.
+		*/
+		readonly bgGray: CSPair;
+
+		/**
+		Alias for `bgBlackBright`.
+		*/
+		readonly bgGrey: CSPair;
+
+		readonly bgBlackBright: CSPair;
+		readonly bgRedBright: CSPair;
+		readonly bgGreenBright: CSPair;
+		readonly bgYellowBright: CSPair;
+		readonly bgBlueBright: CSPair;
+		readonly bgCyanBright: CSPair;
+		readonly bgMagentaBright: CSPair;
+		readonly bgWhiteBright: CSPair;
+	}
+}
+
+declare const ansiStyles: {
+	readonly modifier: AnsiStylesTypes.Modifier;
+	readonly color: AnsiStylesTypes.ForegroundColor & AnsiStylesTypes.ColorBase;
+	readonly bgColor: AnsiStylesTypes.BackgroundColor & AnsiStylesTypes.ColorBase;
+	readonly codes: ReadonlyMap<number, number>;
+} & AnsiStylesTypes.BackgroundColor & AnsiStylesTypes.ForegroundColor & AnsiStylesTypes.Modifier;
+
+export = ansiStyles;

package/src/utils/ansi-styles.js

@@ -0,0 +1,167 @@
+
+'use strict';
+
+// https://github.com/chalk/ansi-styles/blob/main/index.js
+// fix for https://github.com/DavidWells/markdown-magic/pull/111
+
+const wrapAnsi16 = (fn, offset) => (...args) => {
+	const code = fn(...args);
+	return `\u001B[${code + offset}m`;
+};
+
+const wrapAnsi256 = (fn, offset) => (...args) => {
+	const code = fn(...args);
+	return `\u001B[${38 + offset};5;${code}m`;
+};
+
+const wrapAnsi16m = (fn, offset) => (...args) => {
+	const rgb = fn(...args);
+	return `\u001B[${38 + offset};2;${rgb[0]};${rgb[1]};${rgb[2]}m`;
+};
+
+const ansi2ansi = n => n;
+const rgb2rgb = (r, g, b) => [r, g, b];
+
+const setLazyProperty = (object, property, get) => {
+	Object.defineProperty(object, property, {
+		get: () => {
+			const value = get();
+
+			Object.defineProperty(object, property, {
+				value,
+				enumerable: true,
+				configurable: true
+			});
+
+			return value;
+		},
+		enumerable: true,
+		configurable: true
+	});
+};
+
+/** @type {typeof import('color-convert')} */
+let colorConvert;
+const makeDynamicStyles = (wrap, targetSpace, identity, isBackground) => {
+	if (colorConvert === undefined) {
+		colorConvert = require('color-convert');
+	}
+
+	const offset = isBackground ? 10 : 0;
+	const styles = {};
+
+	for (const [sourceSpace, suite] of Object.entries(colorConvert)) {
+		const name = sourceSpace === 'ansi16' ? 'ansi' : sourceSpace;
+		if (sourceSpace === targetSpace) {
+			styles[name] = wrap(identity, offset);
+		} else if (typeof suite === 'object') {
+			styles[name] = wrap(suite[targetSpace], offset);
+		}
+	}
+
+	return styles;
+};
+
+function assembleStyles() {
+	const codes = new Map();
+	const styles = {
+		modifier: {
+			reset: [0, 0],
+			// 21 isn't widely supported and 22 does the same thing
+			bold: [1, 22],
+			dim: [2, 22],
+			italic: [3, 23],
+			underline: [4, 24],
+			inverse: [7, 27],
+			hidden: [8, 28],
+			strikethrough: [9, 29]
+		},
+		color: {
+			black: [30, 39],
+			red: [31, 39],
+			green: [32, 39],
+			yellow: [33, 39],
+			blue: [34, 39],
+			magenta: [35, 39],
+			cyan: [36, 39],
+			white: [37, 39],
+
+			// Bright color
+			blackBright: [90, 39],
+			redBright: [91, 39],
+			greenBright: [92, 39],
+			yellowBright: [93, 39],
+			blueBright: [94, 39],
+			magentaBright: [95, 39],
+			cyanBright: [96, 39],
+			whiteBright: [97, 39]
+		},
+		bgColor: {
+			bgBlack: [40, 49],
+			bgRed: [41, 49],
+			bgGreen: [42, 49],
+			bgYellow: [43, 49],
+			bgBlue: [44, 49],
+			bgMagenta: [45, 49],
+			bgCyan: [46, 49],
+			bgWhite: [47, 49],
+
+			// Bright color
+			bgBlackBright: [100, 49],
+			bgRedBright: [101, 49],
+			bgGreenBright: [102, 49],
+			bgYellowBright: [103, 49],
+			bgBlueBright: [104, 49],
+			bgMagentaBright: [105, 49],
+			bgCyanBright: [106, 49],
+			bgWhiteBright: [107, 49]
+		}
+	};
+
+	// Alias bright black as gray (and grey)
+	styles.color.gray = styles.color.blackBright;
+	styles.bgColor.bgGray = styles.bgColor.bgBlackBright;
+	styles.color.grey = styles.color.blackBright;
+	styles.bgColor.bgGrey = styles.bgColor.bgBlackBright;
+
+	for (const [groupName, group] of Object.entries(styles)) {
+		for (const [styleName, style] of Object.entries(group)) {
+			styles[styleName] = {
+				open: `\u001B[${style[0]}m`,
+				close: `\u001B[${style[1]}m`
+			};
+
+			group[styleName] = styles[styleName];
+
+			codes.set(style[0], style[1]);
+		}
+
+		Object.defineProperty(styles, groupName, {
+			value: group,
+			enumerable: false
+		});
+	}
+
+	Object.defineProperty(styles, 'codes', {
+		value: codes,
+		enumerable: false
+	});
+
+	styles.color.close = '\u001B[39m';
+	styles.bgColor.close = '\u001B[49m';
+
+	setLazyProperty(styles.color, 'ansi', () => makeDynamicStyles(wrapAnsi16, 'ansi16', ansi2ansi, false));
+	setLazyProperty(styles.color, 'ansi256', () => makeDynamicStyles(wrapAnsi256, 'ansi256', ansi2ansi, false));
+	setLazyProperty(styles.color, 'ansi16m', () => makeDynamicStyles(wrapAnsi16m, 'rgb', rgb2rgb, false));
+	setLazyProperty(styles.bgColor, 'ansi', () => makeDynamicStyles(wrapAnsi16, 'ansi16', ansi2ansi, true));
+	setLazyProperty(styles.bgColor, 'ansi256', () => makeDynamicStyles(wrapAnsi256, 'ansi256', ansi2ansi, true));
+	setLazyProperty(styles.bgColor, 'ansi16m', () => makeDynamicStyles(wrapAnsi16m, 'rgb', rgb2rgb, true));
+
+	return styles;
+}
+
+// Make the export immutable
+Object.defineProperty(module, 'exports', {
+	enumerable: true,
+	get: assembleStyles
+});

package/src/utils/fs.test.js

@@ -39,6 +39,7 @@ test('getGitignoreContents', async () => {
     'yarn-error.log*',
     'test/fixtures/output',
     '_out.md',
+    'dist',
     'misc',
     'misc/**/**.js',
     "__misc",

package/src/utils/logs.js

@@ -1,5 +1,5 @@
 const util = require('util')
-const ansi = require('ansi-styles') // https://github.com/chalk/ansi-styles/blob/main/index.js
+const ansi = require('./ansi-styles') // https://github.com/chalk/ansi-styles/blob/main/index.js
 const process = require('process')
 
 function convertHrtime(hrtime) {
@@ -91,7 +91,7 @@ const error = log.bind(null, 'error')
 /*
 // Usage:
 console.log('Nice logs')
-deepLog({ deep: {object }})
+deepLog({ deep: { object: 'test' }})
 success('Success! Yay it worked')
 info('Info: Additional details here')
 warning('Warning: Watch out')

package/src/utils/remoteRequest.js

@@ -1,28 +1,9 @@
 const fetch = require('node-fetch')
-const request = require('sync-request')
 
 function formatUrl(url = '') {
   return url.match(/^https?:\/\//) ? url : `https://${url}`
 }
 
-function remoteRequestSync(url, settings = {}, srcPath) {
-  let body
-  const finalUrl = formatUrl(url)
-  try {
-    // @ts-expect-error
-    const res = request('GET', finalUrl)
-    body = res.getBody('utf8')
-  } catch (e) {
-    console.log(`⚠️  WARNING: REMOTE URL "${finalUrl}" NOT FOUND`)
-    const msg = (e.message || '').split('\n')[0] + `\nFix "${url}" value in ${srcPath}`
-    console.log(msg)
-    if (settings.failOnMissingRemote) {
-      throw new Error(msg)
-    }
-  }
-  return body
-}
-
 async function remoteRequest(url, settings = {}, srcPath) {
   let body
   const finalUrl = formatUrl(url)
@@ -45,7 +26,6 @@ async function remoteRequest(url, settings = {}, srcPath) {
 }
 
 module.exports = {
-  remoteRequestSync,
   remoteRequest
 }
 

package/types/src/defaults.d.ts

@@ -1,5 +1,5 @@
 export const SYNTAX: "md";
-export const OPEN_WORD: "doc-gen";
-export const CLOSE_WORD: "end-doc-gen";
+export const OPEN_WORD: "docs";
+export const CLOSE_WORD: "/docs";
 export const DEFAULT_GLOB_PATTERN: "**/**.md";
 //# sourceMappingURL=defaults.d.ts.map

package/types/src/defaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/defaults.js"],"names":[],"mappings":"AACA,qBAAe,IAAI,CAAA;AACnB,wBAAkB,SAAS,CAAA;AAC3B,yBAAmB,aAAa,CAAA;AAChC,mCAA6B,UAAU,CAAA"}
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/defaults.js"],"names":[],"mappings":"AACA,qBAAe,IAAI,CAAA;AACnB,wBAAkB,MAAM,CAAA;AACxB,yBAAmB,OAAO,CAAA;AAC1B,mCAA6B,UAAU,CAAA"}

package/types/src/index.d.ts

@@ -22,19 +22,19 @@ export type MarkdownMagicOptions = {
      */
     transforms?: any;
     /**
-     * - Output configuration
+     * - Output configuration object or directory path
      */
-    output?: OutputConfig;
+    output?: OutputConfig | string;
     /**
      * - Syntax to parse
      */
     syntax?: SyntaxType;
     /**
-     * - Opening match word
+     * - Opening match word. Default is 'docs'.
      */
     open?: string;
     /**
-     * - Closing match word. If not defined will be same as opening word.
+     * - Closing match word. Default is '/docs'. If not defined will be same as opening word with closing slash added.
      */
     close?: string;
     /**
@@ -52,7 +52,7 @@ export type MarkdownMagicOptions = {
     /**
      * - See planned execution of matched blocks
      */
-    dryRun?: boolean;
+    dry?: boolean;
     /**
      * - See debug details
      */
@@ -73,6 +73,10 @@ export type MarkdownMagicOptions = {
      * - Fail if remote file is missing.
      */
     failOnMissingRemote?: boolean;
+    /**
+     * - Deprecated: Use `output` instead. Output directory path.
+     */
+    outputDir?: string;
 };
 /**
  * Optional output configuration
@@ -131,19 +135,20 @@ export type MarkdownMagicResult = {
  * @typedef {object} MarkdownMagicOptions
  * @property {FilePathsOrGlobs} [files] - Files to process.
  * @property {Object} [transforms = defaultTransforms] - Custom commands to transform block contents, see transforms & custom transforms sections below.
- * @property {OutputConfig} [output] - Output configuration
+ * @property {OutputConfig|string} [output] - Output configuration object or directory path
  * @property {SyntaxType} [syntax = 'md'] - Syntax to parse
- * @property {string} [open = 'doc-gen'] - Opening match word
- * @property {string} [close = 'end-doc-gen'] - Closing match word. If not defined will be same as opening word.
- * @property {string} [cwd = process.cwd() ] - Current working directory. Default process.cwd()
+ * @property {string}  [open = 'docs'] - Opening match word. Default is 'docs'.
+ * @property {string}  [close = '/docs'] - Closing match word. Default is '/docs'. If not defined will be same as opening word with closing slash added.
+ * @property {string}  [cwd = process.cwd() ] - Current working directory. Default process.cwd()
  * @property {boolean} [outputFlatten] - Flatten files that are output
  * @property {boolean} [useGitGlob] - Use git glob for LARGE file directories
- * @property {boolean} [dryRun = false] - See planned execution of matched blocks
+ * @property {boolean} [dry = false] - See planned execution of matched blocks
  * @property {boolean} [debug = false] - See debug details
  * @property {boolean} [silent = false] - Silence all console output
  * @property {boolean} [applyTransformsToSource = true] - Apply transforms to source file. Default is true.
  * @property {boolean} [failOnMissingTransforms = false] - Fail if transform functions are missing. Default skip blocks.
  * @property {boolean} [failOnMissingRemote = true] - Fail if remote file is missing.
+ * @property {string}  [outputDir] - Deprecated: Use `output` instead. Output directory path.
  */
 /**
  * Optional output configuration

package/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;yBAkDa,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM;;;;+BAK5B,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC;iCAIpB,OAAO,wBAAwB,EAAE,kBAAkB;;;;;;;;;;YASlD,gBAAgB;;;;;;;;aAEhB,YAAY;;;;aACZ,UAAU;;;;WACV,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;oBACN,OAAO;;;;iBACP,OAAO;;;;aACP,OAAO;;;;YACP,OAAO;;;;aACP,OAAO;;;;8BACP,OAAO;;;;8BACP,OAAO;;;;0BACP,OAAO;;;;;;;;;gBAMP,MAAM;;;;qBACN,OAAO;;;;;;;;8BAEP,OAAO;;;;;;;;;;;;;kBAQP,KAAK,CAAC,MAAM,CAAC;;;;;;AAnD3B;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,2CARW,gBAAgB,GAAC,oBAAoB,YACrC,oBAAoB,GAClB,OAAO,CAAC,mBAAmB,CAAC,CA2lBxC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;yBAkDa,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM;;;;+BAK5B,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC;iCAIpB,OAAO,wBAAwB,EAAE,kBAAkB;;;;;;;;;;YASlD,gBAAgB;;;;;;;;aAEhB,YAAY,GAAC,MAAM;;;;aACnB,UAAU;;;;WACV,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;oBACN,OAAO;;;;iBACP,OAAO;;;;UACP,OAAO;;;;YACP,OAAO;;;;aACP,OAAO;;;;8BACP,OAAO;;;;8BACP,OAAO;;;;0BACP,OAAO;;;;gBACP,MAAM;;;;;;;;;gBAMN,MAAM;;;;qBACN,OAAO;;;;;;;;8BAEP,OAAO;;;;;;;;;;;;;kBAQP,KAAK,CAAC,MAAM,CAAC;;;;;;AApD3B;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,2CARW,gBAAgB,GAAC,oBAAoB,YACrC,oBAAoB,GAClB,OAAO,CAAC,mBAAmB,CAAC,CA6lBxC"}

package/types/src/transforms/install.d.ts

@@ -9,12 +9,12 @@ export = install;
  *
  * **Example:**
  * ```md
- * <!-- doc-gen INSTALL packageName=my-package -->
+ * <!-- docs INSTALL packageName=my-package -->
  * Installation instructions will be generated here
- * <!-- end-doc-gen -->
+ * <!-- /docs -->
  * ```
  *
- * Default `matchWord` is `doc-gen`
+ * Default `matchWord` is `docs`
  *
  * ---
  * @param {string} content The current content of the comment block

package/types/src/utils/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../src/utils/text.js"],"names":[],"mappings":"AAgaA;;;;GAIG;AACH,kCAHW,MAAM,GACJ,MAAM,CAmBlB;AApbD;;;;GAIG;AACH,+BAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;AAED;;;;GAIG;AACH,mCAHW,MAAM,GACJ,MAAM,CAIlB;AAgBD;;;;GAIG;AACH,mCAHW,MAAM,GACJ,MAAM,CAIlB;AAoBD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,MAAM,CAKlB;AA1BD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,sCAHW,MAAM,GACJ,MAAM,CAIlB;AAvCD;;;;;GAKG;AACH,kDAJW,MAAM,eACN,MAAM,GACJ;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,CAQtC;AAuCD;;;;;;GAMG;AACH,0CALW,MAAM,SACN,MAAM,OACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;GAMG;AACH,uCALW,MAAM,UACN,MAAM,UACN,MAAM,GACJ,MAAM,CAYlB;AAcD;;;;;;;GAOG;AACH,6CALW,MAAM,aACN,MAAM,WACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAiB5B;AAnCD;;;;;;;GAOG;AACH,6CANW,MAAM,SACN,MAAM,OACN,MAAM,UACN,MAAM,GACJ,MAAM,CAIlB;AAgDD;;;;;GAKG;AACH,oCAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CASlB;AAaD;;;;;;;;GAQG;AACH,qCAPW,MAAM,UACN,MAAM,YAEd;IAAyB,MAAM,GAAvB,MAAM;IACY,iBAAiB,GAAnC,OAAO;CACf,GAAU,MAAM,CAclB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ,MAAM,CAOlB;AAuCD;;;;;GAKG;AACH,mCAJW,MAAM,WACN,OAAO,UAAU,EAAE,UAAU,GAC3B,MAAM,CAmBlB;AA4DD;;;QAmCC;AAvFD,yEAEC;AAND,wEAEC;AAeD,8DAqCC;AArKD;;;;GAIG;AACF,iCAHU,MAAM,GAAC,MAAM,GACX,MAAM,CAMlB;AAnCD;;;;GAIG;AACH,sCAHW,MAAM,GACJ,MAAM,CAMlB;AAnBD;;;;GAIG;AACH,iCAHW,MAAM,GACJ,OAAO,CAInB"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../src/utils/text.js"],"names":[],"mappings":"AA8ZA;;;;GAIG;AACH,kCAHW,MAAM,GACJ,MAAM,CAmBlB;AAlbD;;;;GAIG;AACH,+BAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;AAED;;;;GAIG;AACH,mCAHW,MAAM,GACJ,MAAM,CAIlB;AAgBD;;;;GAIG;AACH,mCAHW,MAAM,GACJ,MAAM,CAIlB;AAoBD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,MAAM,CAKlB;AA1BD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,sCAHW,MAAM,GACJ,MAAM,CAIlB;AAvCD;;;;;GAKG;AACH,kDAJW,MAAM,eACN,MAAM,GACJ;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,CAQtC;AAuCD;;;;;;GAMG;AACH,0CALW,MAAM,SACN,MAAM,OACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;GAMG;AACH,uCALW,MAAM,UACN,MAAM,UACN,MAAM,GACJ,MAAM,CAYlB;AAcD;;;;;;;GAOG;AACH,6CALW,MAAM,aACN,MAAM,WACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAe5B;AAjCD;;;;;;;GAOG;AACH,6CANW,MAAM,SACN,MAAM,OACN,MAAM,UACN,MAAM,GACJ,MAAM,CAIlB;AA8CD;;;;;GAKG;AACH,oCAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CASlB;AAaD;;;;;;;;GAQG;AACH,qCAPW,MAAM,UACN,MAAM,YAEd;IAAyB,MAAM,GAAvB,MAAM;IACY,iBAAiB,GAAnC,OAAO;CACf,GAAU,MAAM,CAclB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ,MAAM,CAOlB;AAuCD;;;;;GAKG;AACH,mCAJW,MAAM,WACN,OAAO,UAAU,EAAE,UAAU,GAC3B,MAAM,CAmBlB;AA4DD;;;QAmCC;AAvFD,yEAEC;AAND,wEAEC;AAeD,8DAqCC;AArKD;;;;GAIG;AACF,iCAHU,MAAM,GAAC,MAAM,GACX,MAAM,CAMlB;AAnCD;;;;GAIG;AACH,sCAHW,MAAM,GACJ,MAAM,CAMlB;AAnBD;;;;GAIG;AACH,iCAHW,MAAM,GACJ,OAAO,CAInB"}