@optique/core 1.4.0-dev.2679 → 1.4.0-dev.2681

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/doc.d.cts CHANGED
@@ -420,7 +420,7 @@ interface DocPageFormatOptions {
420
420
  * { showAliases: { prefix: " [", suffix: "]", label: "aka " } }
421
421
  * ```
422
422
  */
423
- showAliases?: boolean | ShowAliasesOptions;
423
+ readonly showAliases?: boolean | ShowAliasesOptions;
424
424
  /**
425
425
  * A custom comparator function to control the order of sections in the
426
426
  * help output. When provided, it is used instead of the default smart
package/dist/doc.d.ts CHANGED
@@ -420,7 +420,7 @@ interface DocPageFormatOptions {
420
420
  * { showAliases: { prefix: " [", suffix: "]", label: "aka " } }
421
421
  * ```
422
422
  */
423
- showAliases?: boolean | ShowAliasesOptions;
423
+ readonly showAliases?: boolean | ShowAliasesOptions;
424
424
  /**
425
425
  * A custom comparator function to control the order of sections in the
426
426
  * help output. When provided, it is used instead of the default smart
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/core",
3
- "version": "1.4.0-dev.2679",
3
+ "version": "1.4.0-dev.2681",
4
4
  "description": "Type-safe combinatorial command-line interface parser",
5
5
  "keywords": [
6
6
  "CLI",
@@ -237,7 +237,7 @@
237
237
  },
238
238
  "sideEffects": false,
239
239
  "devDependencies": {
240
- "@optique/env": "1.4.0-dev.2679+3a3a57d2",
240
+ "@optique/env": "1.4.0-dev.2681+eaa9a981",
241
241
  "@types/node": "^24.0.0",
242
242
  "fast-check": "^4.7.0",
243
243
  "tsdown": "^0.13.0",
@@ -75,9 +75,9 @@ Core rules
75
75
  `context.previousValidationMessage`, and forward `context.signal` when the
76
76
  prompt library supports aborting active work. Adapter-native validation
77
77
  remains separate and completes inside one shared attempt.
78
- - Build subcommands with `command()` combined by `or()`. Put a literal field
79
- such as `command: constant("serve")` in each branch when you want a
80
- discriminated union.
78
+ - Build subcommands with `command()` combined by `or()`; add a literal field
79
+ such as `command: constant("serve")` per branch for a discriminated union.
80
+ Show hidden `aliases` in help with `showAliases` on `command()` or runner.
81
81
  - Use `run(parser, { completion: "both" })` for completion, or the object form
82
82
  with `completion.errors` for custom shell errors. Do not hand-write scripts.
83
83
  - Use `usageLine: [{ type: "ellipsis" }]` in runner options when a large root