@optique/man 1.0.0-dev.908 → 1.0.0-dev.921

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-NL-hVPdd.cjs');
2
+ const require_man = require('./man-Bah5ZMyV.cjs');
3
3
  require('./roff-Cl0vekdg.cjs');
4
- const require_generator = require('./generator-BORgW1yS.cjs');
4
+ const require_generator = require('./generator-bugVqGJn.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.0.0-dev.908+f60f037d";
20
+ var version = "1.0.0-dev.921+754748bd";
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-CwBRpWCo.js";
3
- import "./man-CcjsLpyb.js";
4
- import { generateManPageAsync } from "./generator-Di1pIRAG.js";
3
+ import "./man-BiY491LQ.js";
4
+ import { generateManPageAsync } from "./generator-CnMxnsMc.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.0.0-dev.908+f60f037d";
20
+ var version = "1.0.0-dev.921+754748bd";
21
21
  var license = "MIT";
22
22
  var exports = {
23
23
  ".": "./src/index.ts",
@@ -1,4 +1,4 @@
1
- import { formatDocPageAsMan } from "./man-CcjsLpyb.js";
1
+ import { formatDocPageAsMan } from "./man-BiY491LQ.js";
2
2
  import { getDocPageAsync, getDocPageSync } from "@optique/core/parser";
3
3
 
4
4
  //#region src/generator.ts
@@ -1,4 +1,4 @@
1
- const require_man = require('./man-NL-hVPdd.cjs');
1
+ const require_man = require('./man-Bah5ZMyV.cjs');
2
2
  const __optique_core_parser = require_man.__toESM(require("@optique/core/parser"));
3
3
 
4
4
  //#region src/generator.ts
package/dist/index.cjs CHANGED
@@ -1,6 +1,6 @@
1
- const require_man = require('./man-NL-hVPdd.cjs');
1
+ const require_man = require('./man-Bah5ZMyV.cjs');
2
2
  const require_roff = require('./roff-Cl0vekdg.cjs');
3
- const require_generator = require('./generator-BORgW1yS.cjs');
3
+ const require_generator = require('./generator-bugVqGJn.cjs');
4
4
 
5
5
  exports.escapeHyphens = require_roff.escapeHyphens;
6
6
  exports.escapeQuotedValue = require_roff.escapeQuotedValue;
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-C_87xXP6.cjs";
2
- import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-D2t8hkyn.cjs";
2
+ import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-Dp4oW-al.cjs";
3
3
  import { Mode, ModeValue, Parser } from "@optique/core/parser";
4
4
  import { Program } from "@optique/core/program";
5
5
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-DlmeL3KB.js";
2
- import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-DXQgwt1g.js";
2
+ import { ManPageOptions, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CGBnZvZF.js";
3
3
  import { Program } from "@optique/core/program";
4
4
  import { Mode, ModeValue, Parser } from "@optique/core/parser";
5
5
 
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatMessageAsRoff } from "./roff-CwBRpWCo.js";
2
- import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CcjsLpyb.js";
3
- import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-Di1pIRAG.js";
2
+ import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-BiY491LQ.js";
3
+ import { generateManPage, generateManPageAsync, generateManPageSync } from "./generator-CnMxnsMc.js";
4
4
 
5
5
  export { escapeHyphens, escapeQuotedValue, escapeRequestArg, escapeRoff, formatDateForMan, formatDocPageAsMan, formatMessageAsRoff, formatUsageTermAsRoff, generateManPage, generateManPageAsync, generateManPageSync };
@@ -231,8 +231,8 @@ function formatDocSectionEntries(section) {
231
231
  * @param options The man page options.
232
232
  * @returns The complete man page in roff format.
233
233
  * @throws {TypeError} If the program name is empty.
234
- * @throws {RangeError} If the section number is not a valid man page section
235
- * (1–8).
234
+ * @throws {RangeError} If the section number or any `seeAlso` entry's section
235
+ * number is not a valid man page section (1–8).
236
236
  * @since 0.10.0
237
237
  */
238
238
  function formatDocPageAsMan(page, options) {
@@ -308,6 +308,15 @@ function formatDocPageAsMan(page, options) {
308
308
  lines.push(require_roff.formatMessageAsRoff(options.bugs));
309
309
  }
310
310
  if (options.seeAlso && options.seeAlso.length > 0) {
311
+ for (const ref of options.seeAlso) if (!Number.isInteger(ref.section) || ref.section < 1 || ref.section > 8) {
312
+ let repr;
313
+ try {
314
+ repr = JSON.stringify(ref.section);
315
+ } catch {
316
+ repr = String(typeof ref.section);
317
+ }
318
+ throw new RangeError(`Invalid man page section number for seeAlso entry ${JSON.stringify(ref.name)} (must be 1–8): ${repr}`);
319
+ }
311
320
  lines.push(".SH SEE ALSO");
312
321
  const refs = options.seeAlso.map((ref, i) => {
313
322
  const suffix = i < options.seeAlso.length - 1 ? "," : "";
@@ -208,8 +208,8 @@ function formatDocSectionEntries(section) {
208
208
  * @param options The man page options.
209
209
  * @returns The complete man page in roff format.
210
210
  * @throws {TypeError} If the program name is empty.
211
- * @throws {RangeError} If the section number is not a valid man page section
212
- * (1–8).
211
+ * @throws {RangeError} If the section number or any `seeAlso` entry's section
212
+ * number is not a valid man page section (1–8).
213
213
  * @since 0.10.0
214
214
  */
215
215
  function formatDocPageAsMan(page, options) {
@@ -285,6 +285,15 @@ function formatDocPageAsMan(page, options) {
285
285
  lines.push(formatMessageAsRoff(options.bugs));
286
286
  }
287
287
  if (options.seeAlso && options.seeAlso.length > 0) {
288
+ for (const ref of options.seeAlso) if (!Number.isInteger(ref.section) || ref.section < 1 || ref.section > 8) {
289
+ let repr;
290
+ try {
291
+ repr = JSON.stringify(ref.section);
292
+ } catch {
293
+ repr = String(typeof ref.section);
294
+ }
295
+ throw new RangeError(`Invalid man page section number for seeAlso entry ${JSON.stringify(ref.name)} (must be 1–8): ${repr}`);
296
+ }
288
297
  lines.push(".SH SEE ALSO");
289
298
  const refs = options.seeAlso.map((ref, i) => {
290
299
  const suffix = i < options.seeAlso.length - 1 ? "," : "";
@@ -64,7 +64,7 @@ interface ManPageOptions {
64
64
  */
65
65
  readonly seeAlso?: ReadonlyArray<{
66
66
  readonly name: string;
67
- readonly section: number;
67
+ readonly section: ManPageSection;
68
68
  }>;
69
69
  /**
70
70
  * Environment variables to document in the ENVIRONMENT section.
@@ -130,8 +130,8 @@ declare function formatUsageTermAsRoff(term: UsageTerm): string;
130
130
  * @param options The man page options.
131
131
  * @returns The complete man page in roff format.
132
132
  * @throws {TypeError} If the program name is empty.
133
- * @throws {RangeError} If the section number is not a valid man page section
134
- * (1–8).
133
+ * @throws {RangeError} If the section number or any `seeAlso` entry's section
134
+ * number is not a valid man page section (1–8).
135
135
  * @since 0.10.0
136
136
  */
137
137
  declare function formatDocPageAsMan(page: DocPage, options: ManPageOptions): string;
@@ -64,7 +64,7 @@ interface ManPageOptions {
64
64
  */
65
65
  readonly seeAlso?: ReadonlyArray<{
66
66
  readonly name: string;
67
- readonly section: number;
67
+ readonly section: ManPageSection;
68
68
  }>;
69
69
  /**
70
70
  * Environment variables to document in the ENVIRONMENT section.
@@ -130,8 +130,8 @@ declare function formatUsageTermAsRoff(term: UsageTerm): string;
130
130
  * @param options The man page options.
131
131
  * @returns The complete man page in roff format.
132
132
  * @throws {TypeError} If the program name is empty.
133
- * @throws {RangeError} If the section number is not a valid man page section
134
- * (1–8).
133
+ * @throws {RangeError} If the section number or any `seeAlso` entry's section
134
+ * number is not a valid man page section (1–8).
135
135
  * @since 0.10.0
136
136
  */
137
137
  declare function formatDocPageAsMan(page: DocPage, options: ManPageOptions): string;
package/dist/man.cjs CHANGED
@@ -1,4 +1,4 @@
1
- const require_man = require('./man-NL-hVPdd.cjs');
1
+ const require_man = require('./man-Bah5ZMyV.cjs');
2
2
  require('./roff-Cl0vekdg.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-D2t8hkyn.cjs";
1
+ import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-Dp4oW-al.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-DXQgwt1g.js";
1
+ import { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CGBnZvZF.js";
2
2
  export { ManPageOptions, ManPageSection, formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff };
package/dist/man.js CHANGED
@@ -1,4 +1,4 @@
1
1
  import "./roff-CwBRpWCo.js";
2
- import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-CcjsLpyb.js";
2
+ import { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff } from "./man-BiY491LQ.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.0.0-dev.908+f60f037d",
3
+ "version": "1.0.0-dev.921+754748bd",
4
4
  "description": "Man page generator for Optique CLI parsers",
5
5
  "keywords": [
6
6
  "CLI",
@@ -84,8 +84,8 @@
84
84
  "optique-man": "./dist/cli.js"
85
85
  },
86
86
  "dependencies": {
87
- "@optique/run": "1.0.0-dev.908+f60f037d",
88
- "@optique/core": "1.0.0-dev.908+f60f037d"
87
+ "@optique/core": "1.0.0-dev.921+754748bd",
88
+ "@optique/run": "1.0.0-dev.921+754748bd"
89
89
  },
90
90
  "devDependencies": {
91
91
  "@types/node": "^20.19.9",