@qui-cli/markdown 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.2.0](https://github.com/battis/qui-cli/compare/markdown/1.1.2...markdown/1.2.0) (2026-02-22)
+
+
+### Features
+
+* convert ANSI coloring to markdown ([5828d89](https://github.com/battis/qui-cli/commit/5828d894a37950d89f16003bf2b815543cfa9113))
+
+## [1.1.2](https://github.com/battis/qui-cli/compare/markdown/1.1.1...markdown/1.1.2) (2026-01-18)
+
+
+### Bug Fixes
+
+* compile against Node.js v24 ([7b06b4f](https://github.com/battis/qui-cli/commit/7b06b4f4ac4f9688719041ab8b1d837b3a0ee214))
+
 ## [1.1.1](https://github.com/battis/qui-cli/compare/markdown/1.1.0...markdown/1.1.1) (2026-01-02)
 
 

package/dist/Markdown.d.ts

@@ -1,3 +1,4 @@
+import { Colors } from '@qui-cli/colors';
 import * as Plugin from '@qui-cli/plugin';
 export type Configuration = Plugin.Configuration & {
     /**
@@ -20,7 +21,10 @@ export type Configuration = Plugin.Configuration & {
     post?: string;
     /** Whether or not to overwrite an existing file with output. Default: `false` */
     overwrite?: boolean;
+    /** Style configuration options */
+    style?: Partial<Record<keyof typeof Colors, [string, string]>>;
 };
 export declare const name = "markdown";
-export declare function configure(config?: Configuration): void;
+export declare function restyle(text: string): string;
+export declare function configure(proposal?: Configuration): void;
 export declare function run(): Promise<void>;

package/dist/Markdown.js

@@ -1,46 +1,81 @@
 import { Colors } from '@qui-cli/colors';
 import { Core } from '@qui-cli/core';
-import * as Plugin from '@qui-cli/plugin';
 import { Root } from '@qui-cli/root';
 import fs from 'node:fs';
 import path from 'node:path';
 import stripAnsi from 'strip-ansi';
 export const name = 'markdown';
-let outputPath = '.';
-let fileName = 'usage.md';
-let pre = '';
-let headingLevelAdjustment = 0;
-let post = '';
-let overwrite = false;
-export function configure(config = {}) {
-    outputPath = Plugin.hydrate(config.outputPath, outputPath);
-    fileName = Plugin.hydrate(config.fileName, fileName);
-    pre = Plugin.hydrate(config.pre, pre);
-    headingLevelAdjustment = Plugin.hydrate(config.headingLevelAdjustment, headingLevelAdjustment);
-    post = Plugin.hydrate(config.post, post);
-    overwrite = Plugin.hydrate(config.overwrite, overwrite);
+const config = {
+    outputPath: '.',
+    fileName: 'usage.md',
+    pre: '',
+    headingLevelAdjustment: 0,
+    post: '',
+    overwrite: false,
+    style: {
+        value: ['`', '`'],
+        keyword: ['*', '*']
+    }
+};
+const placeholder = '@';
+export function restyle(text) {
+    for (const key of Object.keys(Colors)) {
+        const replacement = config.style[key] || config.style.value;
+        if (replacement) {
+            const [ansiOpen, ansiClose] = Colors[key](placeholder).split(placeholder);
+            const [markdownOpen, markdownClose] = replacement;
+            let start;
+            while ((start = text.indexOf(ansiOpen)) >= 0) {
+                const end = text.indexOf(ansiClose, start);
+                text =
+                    text.slice(0, start) +
+                        markdownOpen +
+                        text.slice(start + ansiOpen.length, end) +
+                        markdownClose +
+                        text.slice(end + ansiClose.length);
+            }
+        }
+    }
+    return text;
+}
+export function configure(proposal = {}) {
+    for (const key in proposal) {
+        if (proposal[key] !== undefined) {
+            switch (key) {
+                case 'style':
+                    for (const k of Object.keys(proposal.style || {})) {
+                        if (proposal.style && proposal.style[k] !== undefined) {
+                            config.style[k] = proposal.style[k];
+                        }
+                    }
+                    break;
+                default:
+                    config[key] = proposal[key];
+            }
+        }
+    }
 }
 export async function run() {
-    outputPath = path.resolve(Root.path(), outputPath);
-    if (fs.existsSync(outputPath)) {
-        if (fs.statSync(outputPath).isFile()) {
-            if (!overwrite) {
-                throw new Error(`File ${Colors.url(outputPath)} already exists and will not be overwritten`);
+    config.outputPath = path.resolve(Root.path(), config.outputPath);
+    if (fs.existsSync(config.outputPath)) {
+        if (fs.statSync(config.outputPath).isFile()) {
+            if (!config.overwrite) {
+                throw new Error(`File ${Colors.path(config.outputPath)} already exists and will not be overwritten`);
             }
         }
         else {
-            outputPath = path.join(outputPath, fileName);
+            config.outputPath = path.join(config.outputPath, config.fileName);
         }
     }
     else {
-        if (path.extname(outputPath) === '') {
-            outputPath = path.join(outputPath, fileName);
+        if (path.extname(config.outputPath) === '') {
+            config.outputPath = path.join(config.outputPath, config.fileName);
         }
-        fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+        fs.mkdirSync(path.dirname(config.outputPath), { recursive: true });
     }
-    fs.writeFileSync(outputPath, `${pre.length ? `${pre}\n` : ''}${adjustHeadingLevel(stripAnsi(Core.usageMarkdown()))
+    fs.writeFileSync(config.outputPath, `${config.pre.length ? `${config.pre}\n` : ''}${adjustHeadingLevel(stripAnsi(restyle(Core.usageMarkdown())))
         .replace('Usage:\n\n```', '## Usage:\n\n```bash')
-        .replace('#### `-h --help', '## Arguments\n\n#### `-h --help')}${post.length ? `\n${post}` : ''}`);
+        .replace('#### `-h --help', '## Arguments\n\n#### `-h --help')}${config.post.length ? `\n${config.post}` : ''}`);
 }
 function adjustHeadingLevel(usage) {
     return usage
@@ -48,7 +83,7 @@ function adjustHeadingLevel(usage) {
         .map((line) => {
         const [, heading] = line.match(/^(#+) /) || [];
         if (heading) {
-            return line.replace(/^(#+)/, '#'.repeat(heading.length + headingLevelAdjustment));
+            return line.replace(/^(#+)/, '#'.repeat(heading.length + config.headingLevelAdjustment));
         }
         return line;
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/markdown",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "@qui-cli Plugin: Export usage as markdown",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/markdown#readme",
   "repository": {
@@ -18,18 +18,18 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "strip-ansi": "^7.1.2",
-    "@qui-cli/colors": "3.2.1"
+    "@qui-cli/colors": "3.2.3"
   },
   "devDependencies": {
-    "@tsconfig/node20": "^20.1.8",
-    "@types/node": "^24.10.4",
+    "@tsconfig/node24": "^24.0.4",
+    "@types/node": "^24.10.13",
     "commit-and-tag-version": "^12.6.1",
-    "del-cli": "^6.0.0",
+    "del-cli": "^7.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.9.3",
-    "@qui-cli/root": "3.0.6",
-    "@qui-cli/plugin": "4.0.0",
-    "@qui-cli/core": "5.0.2"
+    "@qui-cli/core": "6.0.3",
+    "@qui-cli/root": "3.1.0",
+    "@qui-cli/plugin": "4.1.0"
   },
   "peerDependencies": {
     "@qui-cli/core": ">=4",
@@ -42,6 +42,6 @@
     "build": "run-s build:*",
     "build:clean": "run-s clean",
     "build:compile": "tsc",
-    "release": "commit-and-tag-version"
+    "version": "commit-and-tag-version"
   }
 }