@qui-cli/core 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,20 @@
2
2
 
3
3
  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.
4
4
 
5
+ ## [4.1.0](https://github.com/battis/qui-cli/compare/core/4.0.1...core/4.1.0) (2025-11-04)
6
+
7
+
8
+ ### Features
9
+
10
+ * support scripting markdown documentation for commands ([03ee6d5](https://github.com/battis/qui-cli/commit/03ee6d55f86f6d7b45bd205896cb0fb6a21523b5))
11
+
12
+ ## [4.0.1](https://github.com/battis/qui-cli/compare/core/4.0.0...core/4.0.1) (2025-08-04)
13
+
14
+
15
+ ### Bug Fixes
16
+
17
+ * update lagging peer dependency specs ([30c0c27](https://github.com/battis/qui-cli/commit/30c0c279d4247a69a30efef8a7426442752cd9c0))
18
+
5
19
  ## [4.0.0](https://github.com/battis/qui-cli/compare/core/3.1.0...core/4.0.0) (2025-08-02)
6
20
 
7
21
 
@@ -7,3 +7,4 @@ export declare function configure(config?: Configuration): void;
7
7
  export declare function args(options: Plugin.Options): void;
8
8
  export declare function parse(): import("jackspeak").Parsed<{}>;
9
9
  export declare function usage(): string;
10
+ export declare function usageMarkdown(): string;
package/dist/JackSpeak.js CHANGED
@@ -42,3 +42,6 @@ export function parse() {
42
42
  export function usage() {
43
43
  return jack().usage();
44
44
  }
45
+ export function usageMarkdown() {
46
+ return jack().usageMarkdown();
47
+ }
@@ -38,7 +38,7 @@ export declare function maximumUnnamedCount(): number | undefined;
38
38
  export declare function requireNoMoreThanUnnamedArgs(maxUnnamed: number): void;
39
39
  export declare function init(args: Plugin.ExpectedArguments<() => Plugin.Options>): void;
40
40
  export declare function usageArgs(): string;
41
- export declare function usage(usage: string): string;
41
+ export declare function usage(usage: string, isMarkdown?: boolean): string;
42
42
  export declare function run(): void;
43
43
  export declare function get(positionalArgName: string): string | undefined;
44
44
  export declare function namedArgs(): Record<string, string | undefined>;
@@ -155,10 +155,15 @@ function wrap(text, indent) {
155
155
  })
156
156
  .join('\n');
157
157
  }
158
- export function usage(usage) {
159
- const pre = usage.slice(0, usage.indexOf('\n') + 1);
160
- const cmd = usage.slice(pre.length, usage.indexOf('\n\n'));
161
- const post = usage.slice(pre.length + cmd.length);
158
+ export function usage(usage, isMarkdown = false) {
159
+ let pre = usage.slice(0, usage.indexOf('\n') + 1);
160
+ let cmd = usage.slice(pre.length, usage.indexOf('\n\n'));
161
+ let post = usage.slice(pre.length + cmd.length);
162
+ if (isMarkdown) {
163
+ pre = usage.slice(0, usage.indexOf('```\n') + 4);
164
+ cmd = usage.slice(pre.length, usage.indexOf('\n```', pre.length));
165
+ post = usage.slice(pre.length + cmd.length);
166
+ }
162
167
  return `${pre}${wrap(`${cmd
163
168
  .split('\n')
164
169
  .map((token) => token.trim())
package/dist/Usage.d.ts CHANGED
@@ -1 +1,2 @@
1
1
  export declare function usage(): string;
2
+ export declare function usageMarkdown(): string;
package/dist/Usage.js CHANGED
@@ -11,3 +11,6 @@ function commandColor(usage) {
11
11
  export function usage() {
12
12
  return Positionals.usage(commandColor(JackSpeak.usage()));
13
13
  }
14
+ export function usageMarkdown() {
15
+ return Positionals.usage(JackSpeak.usageMarkdown(), true);
16
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qui-cli/core",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "Core features of @qui-cli/qui-cli",
5
5
  "homepage": "https://github.com/battis/qui-cli/tree/main/packages/core#readme",
6
6
  "repository": {
@@ -18,21 +18,21 @@
18
18
  "types": "./dist/index.d.ts",
19
19
  "dependencies": {
20
20
  "jackspeak": "^4.1.1",
21
- "wrap-ansi": "^9.0.0"
21
+ "wrap-ansi": "^9.0.2"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@tsconfig/node20": "^20.1.6",
25
- "@types/node": "^24.1.0",
26
- "commit-and-tag-version": "^12.5.2",
25
+ "@types/node": "^24.10.0",
26
+ "commit-and-tag-version": "^12.6.0",
27
27
  "del-cli": "^6.0.0",
28
28
  "npm-run-all": "^4.1.5",
29
- "typescript": "^5.9.2",
30
- "@qui-cli/colors": "3.0.0",
31
- "@qui-cli/plugin": "3.0.0"
29
+ "typescript": "~5.8.3",
30
+ "@qui-cli/plugin": "3.0.0",
31
+ "@qui-cli/colors": "3.0.1"
32
32
  },
33
33
  "peerDependencies": {
34
- "@qui-cli/colors": "2.x",
35
- "@qui-cli/plugin": "^2.4"
34
+ "@qui-cli/colors": "3.x",
35
+ "@qui-cli/plugin": "3.x"
36
36
  },
37
37
  "target": "node",
38
38
  "scripts": {