@optique/man 1.4.0-dev.2708 → 1.4.0-dev.2711

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/dist/cli.cjs CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env node
2
- const require_man = require('./man-CbkazOBJ.cjs');
2
+ const require_man = require('./man-DGAR8ct4.cjs');
3
3
  require('./roff-C8MvQ2tL.cjs');
4
- const require_generator = require('./generator-oBpyBLKQ.cjs');
4
+ const require_generator = require('./generator-BAYozOjf.cjs');
5
5
  const __optique_core_constructs = require_man.__toESM(require("@optique/core/constructs"));
6
6
  const __optique_core_primitives = require_man.__toESM(require("@optique/core/primitives"));
7
7
  const __optique_core_valueparser = require_man.__toESM(require("@optique/core/valueparser"));
@@ -17,7 +17,7 @@ const node_url = require_man.__toESM(require("node:url"));
17
17
 
18
18
  //#region deno.json
19
19
  var name = "@optique/man";
20
- var version = "1.4.0-dev.2708+0119545d";
20
+ var version = "1.4.0-dev.2711+fda80c51";
21
21
  var license = "MIT";
22
22
  var exports$1 = {
23
23
  ".": "./src/index.ts",
package/dist/cli.js CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env node
2
2
  import "./roff-Bh9bsH6u.js";
3
- import "./man-CQXpql4K.js";
4
- import { generateManPageAsync } from "./generator-B5yyN1Vt.js";
3
+ import "./man-fxL2soSJ.js";
4
+ import { generateManPageAsync } from "./generator-D36bK8bw.js";
5
5
  import { object } from "@optique/core/constructs";
6
6
  import { argument, option } from "@optique/core/primitives";
7
7
  import { choice, string } from "@optique/core/valueparser";
@@ -17,7 +17,7 @@ import { fileURLToPath, pathToFileURL } from "node:url";
17
17
 
18
18
  //#region deno.json
19
19
  var name = "@optique/man";
20
- var version = "1.4.0-dev.2708+0119545d";
20
+ var version = "1.4.0-dev.2711+fda80c51";
21
21
  var license = "MIT";
22
22
  var exports = {
23
23
  ".": "./src/index.ts",
@@ -1,4 +1,4 @@
1
- const require_man = require('./man-CbkazOBJ.cjs');
1
+ const require_man = require('./man-DGAR8ct4.cjs');
2
2
  const __optique_core_parser = require_man.__toESM(require("@optique/core/parser"));
3
3
 
4
4
  //#region src/generator.ts
@@ -1,4 +1,4 @@
1
- import { ManPageOptions } from "./man-BB48LlND.cjs";
1
+ import { ManPageOptions } from "./man-Czp4fceb.cjs";
2
2
  import { Mode, ModeValue, Parser } from "@optique/core/parser";
3
3
  import { Program } from "@optique/core/program";
4
4
 
@@ -1,4 +1,4 @@
1
- import { ManPageOptions } from "./man-WqxcdyoU.js";
1
+ import { ManPageOptions } from "./man-DgWDaZfO.js";
2
2
  import { Program } from "@optique/core/program";
3
3
  import { Mode, ModeValue, Parser } from "@optique/core/parser";
4
4
 
@@ -1,4 +1,4 @@
1
- import { formatDocPageAsMan } from "./man-CQXpql4K.js";
1
+ import { formatDocPageAsMan } from "./man-fxL2soSJ.js";
2
2
  import { getDocPageAsync, getDocPageSync } from "@optique/core/parser";
3
3
 
4
4
  //#region src/generator.ts
@@ -1,6 +1,6 @@
1
- require('./man-CbkazOBJ.cjs');
1
+ require('./man-DGAR8ct4.cjs');
2
2
  require('./roff-C8MvQ2tL.cjs');
3
- const require_generator = require('./generator-oBpyBLKQ.cjs');
3
+ const require_generator = require('./generator-BAYozOjf.cjs');
4
4
 
5
5
  exports.generateManPage = require_generator.generateManPage;
6
6
  exports.generateManPageAsync = require_generator.generateManPageAsync;
@@ -1,3 +1,3 @@
1
- import "./man-BB48LlND.cjs";
2
- import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-pUbUcxVA.cjs";
1
+ import "./man-Czp4fceb.cjs";
2
+ import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-BOtzZZU6.cjs";
3
3
  export { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync };
@@ -1,3 +1,3 @@
1
- import "./man-WqxcdyoU.js";
2
- import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-1fDy_sht.js";
1
+ import "./man-DgWDaZfO.js";
2
+ import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-BZBZucRz.js";
3
3
  export { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync };
package/dist/generator.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import "./roff-Bh9bsH6u.js";
2
- import "./man-CQXpql4K.js";
3
- import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-B5yyN1Vt.js";
2
+ import "./man-fxL2soSJ.js";
3
+ import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-D36bK8bw.js";
4
4
 
5
5
  export { generateManPage, generateManPageAsync, generateManPageSync };
package/dist/index.cjs CHANGED
@@ -1,6 +1,6 @@
1
- const require_man = require('./man-CbkazOBJ.cjs');
1
+ const require_man = require('./man-DGAR8ct4.cjs');
2
2
  const require_roff = require('./roff-C8MvQ2tL.cjs');
3
- const require_generator = require('./generator-oBpyBLKQ.cjs');
3
+ const require_generator = require('./generator-BAYozOjf.cjs');
4
4
 
5
5
  exports.escapeHyphens = require_roff.escapeHyphens;
6
6
  exports.escapeQuotedValue = require_roff.escapeQuotedValue;
package/dist/index.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-BB48LlND.cjs";
2
- import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-pUbUcxVA.cjs";
1
+ import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-Czp4fceb.cjs";
2
+ import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-BOtzZZU6.cjs";
3
3
  import { RoffFormatOptions, escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-Cpm_FJok.cjs";
4
4
  export { type GenerateManPageOptions, type GenerateManPageProgramOptions, type ManPageOptions, type RoffFormatOptions, escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatDateForMan, formatDocPageAsMan, formatMessageAsRoff, formatUsageTermAsRoff, generateManPage, generateManPageAsync, generateManPageSync };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-WqxcdyoU.js";
2
- import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-1fDy_sht.js";
1
+ import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-DgWDaZfO.js";
2
+ import { GenerateManPageOptions, GenerateManPageProgramOptions, generateManPage, generateManPageAsync, generateManPageSync } from "./generator-BZBZucRz.js";
3
3
  import { RoffFormatOptions, escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-DkJvVQ1o.js";
4
4
  export { type GenerateManPageOptions, type GenerateManPageProgramOptions, type ManPageOptions, type RoffFormatOptions, escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatDateForMan, formatDocPageAsMan, formatMessageAsRoff, formatUsageTermAsRoff, generateManPage, generateManPageAsync, generateManPageSync };
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-Bh9bsH6u.js";
2
- import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CQXpql4K.js";
3
- import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-B5yyN1Vt.js";
2
+ import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-fxL2soSJ.js";
3
+ import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-D36bK8bw.js";
4
4
 
5
5
  export { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatDateForMan, formatDocPageAsMan, formatMessageAsRoff, formatUsageTermAsRoff, generateManPage, generateManPageAsync, generateManPageSync };
@@ -132,8 +132,9 @@ interface ManPageOptions {
132
132
  declare function formatDateForMan(date: string | Date | undefined): string | undefined;
133
133
  /**
134
134
  * Formats a single {@link UsageTerm} as roff markup for the SYNOPSIS section.
135
- * Optionality follows the supplied usage wrappers. Usage describes display
136
- * structure; empty-input acceptance depends on the parser's runtime behavior.
135
+ * Optionality follows the supplied usage wrappers, except that a group
136
+ * recording `acceptsEmpty` is drawn as omissible exactly when its parser
137
+ * accepts an empty argument list, as in `formatUsage()`.
137
138
  *
138
139
  * @param term The usage term to format.
139
140
  * @returns The roff-formatted string.
@@ -24,6 +24,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
24
24
  const require_roff = require('./roff-C8MvQ2tL.cjs');
25
25
  const __optique_core_doc = __toESM(require("@optique/core/doc"));
26
26
  const __optique_core_usage = __toESM(require("@optique/core/usage"));
27
+ const __optique_core_internal_usage = __toESM(require("@optique/core/internal/usage"));
27
28
 
28
29
  //#region src/man.ts
29
30
  /**
@@ -65,8 +66,9 @@ function formatCommandNameAsRoff(name) {
65
66
  }
66
67
  /**
67
68
  * Formats a single {@link UsageTerm} as roff markup for the SYNOPSIS section.
68
- * Optionality follows the supplied usage wrappers. Usage describes display
69
- * structure; empty-input acceptance depends on the parser's runtime behavior.
69
+ * Optionality follows the supplied usage wrappers, except that a group
70
+ * recording `acceptsEmpty` is drawn as omissible exactly when its parser
71
+ * accepts an empty argument list, as in `formatUsage()`.
70
72
  *
71
73
  * @param term The usage term to format.
72
74
  * @returns The roff-formatted string.
@@ -74,7 +76,7 @@ function formatCommandNameAsRoff(name) {
74
76
  * @since 0.10.0
75
77
  */
76
78
  function formatUsageTermAsRoff(term) {
77
- return formatUsageTermAsRoffInternal(term, false);
79
+ return formatUsageAsRoff([term]);
78
80
  }
79
81
  /**
80
82
  * Returns whether a usage list contains exactly one visible term that can
@@ -150,7 +152,7 @@ function formatUsageTermAsRoffInternal(term, insideBrackets) {
150
152
  * @returns The roff-formatted string.
151
153
  */
152
154
  function formatUsageAsRoff(usage) {
153
- return formatUsageAsRoffInternal(usage, false);
155
+ return formatUsageAsRoffInternal((0, __optique_core_internal_usage.resolveUsageForDisplay)(usage, __optique_core_usage.isUsageHidden), false);
154
156
  }
155
157
  function formatUsageAsRoffInternal(usage, insideBrackets) {
156
158
  return usage.map((term) => formatUsageTermAsRoffInternal(term, insideBrackets)).filter((s) => s !== "").join(" ");
@@ -132,8 +132,9 @@ interface ManPageOptions {
132
132
  declare function formatDateForMan(date: string | Date | undefined): string | undefined;
133
133
  /**
134
134
  * Formats a single {@link UsageTerm} as roff markup for the SYNOPSIS section.
135
- * Optionality follows the supplied usage wrappers. Usage describes display
136
- * structure; empty-input acceptance depends on the parser's runtime behavior.
135
+ * Optionality follows the supplied usage wrappers, except that a group
136
+ * recording `acceptsEmpty` is drawn as omissible exactly when its parser
137
+ * accepts an empty argument list, as in `formatUsage()`.
137
138
  *
138
139
  * @param term The usage term to format.
139
140
  * @returns The roff-formatted string.
@@ -1,6 +1,7 @@
1
1
  import { escapeHyphens, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-Bh9bsH6u.js";
2
2
  import { deriveEnvironmentSection } from "@optique/core/doc";
3
3
  import { isDocHidden, isUsageHidden } from "@optique/core/usage";
4
+ import { resolveUsageForDisplay } from "@optique/core/internal/usage";
4
5
 
5
6
  //#region src/man.ts
6
7
  /**
@@ -42,8 +43,9 @@ function formatCommandNameAsRoff(name) {
42
43
  }
43
44
  /**
44
45
  * Formats a single {@link UsageTerm} as roff markup for the SYNOPSIS section.
45
- * Optionality follows the supplied usage wrappers. Usage describes display
46
- * structure; empty-input acceptance depends on the parser's runtime behavior.
46
+ * Optionality follows the supplied usage wrappers, except that a group
47
+ * recording `acceptsEmpty` is drawn as omissible exactly when its parser
48
+ * accepts an empty argument list, as in `formatUsage()`.
47
49
  *
48
50
  * @param term The usage term to format.
49
51
  * @returns The roff-formatted string.
@@ -51,7 +53,7 @@ function formatCommandNameAsRoff(name) {
51
53
  * @since 0.10.0
52
54
  */
53
55
  function formatUsageTermAsRoff(term) {
54
- return formatUsageTermAsRoffInternal(term, false);
56
+ return formatUsageAsRoff([term]);
55
57
  }
56
58
  /**
57
59
  * Returns whether a usage list contains exactly one visible term that can
@@ -127,7 +129,7 @@ function formatUsageTermAsRoffInternal(term, insideBrackets) {
127
129
  * @returns The roff-formatted string.
128
130
  */
129
131
  function formatUsageAsRoff(usage) {
130
- return formatUsageAsRoffInternal(usage, false);
132
+ return formatUsageAsRoffInternal(resolveUsageForDisplay(usage, isUsageHidden), false);
131
133
  }
132
134
  function formatUsageAsRoffInternal(usage, insideBrackets) {
133
135
  return usage.map((term) => formatUsageTermAsRoffInternal(term, insideBrackets)).filter((s) => s !== "").join(" ");
package/dist/man.cjs CHANGED
@@ -1,4 +1,4 @@
1
- const require_man = require('./man-CbkazOBJ.cjs');
1
+ const require_man = require('./man-DGAR8ct4.cjs');
2
2
  require('./roff-C8MvQ2tL.cjs');
3
3
 
4
4
  exports.formatDateForMan = require_man.formatDateForMan;
package/dist/man.d.cts CHANGED
@@ -1,2 +1,2 @@
1
- import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-BB48LlND.cjs";
1
+ import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-Czp4fceb.cjs";
2
2
  export { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff };
package/dist/man.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-WqxcdyoU.js";
1
+ import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-DgWDaZfO.js";
2
2
  export { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff };
package/dist/man.js CHANGED
@@ -1,4 +1,4 @@
1
1
  import "./roff-Bh9bsH6u.js";
2
- import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CQXpql4K.js";
2
+ import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-fxL2soSJ.js";
3
3
 
4
4
  export { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/man",
3
- "version": "1.4.0-dev.2708",
3
+ "version": "1.4.0-dev.2711",
4
4
  "description": "Man page generator for Optique CLI parsers",
5
5
  "keywords": [
6
6
  "CLI",
@@ -90,11 +90,11 @@
90
90
  "optique-man": "./dist/cli.js"
91
91
  },
92
92
  "dependencies": {
93
- "@optique/core": "1.4.0-dev.2708+0119545d",
94
- "@optique/run": "1.4.0-dev.2708+0119545d"
93
+ "@optique/core": "1.4.0-dev.2711+fda80c51",
94
+ "@optique/run": "1.4.0-dev.2711+fda80c51"
95
95
  },
96
96
  "devDependencies": {
97
- "@optique/testing": "1.4.0-dev.2708+0119545d",
97
+ "@optique/testing": "1.4.0-dev.2711+fda80c51",
98
98
  "@types/node": "^24.0.0",
99
99
  "tsdown": "^0.13.0",
100
100
  "tsx": "^4.21.0",