@optique/run 1.2.0-dev.2297 → 1.2.0-dev.2301

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.
Files changed (5) hide show
  1. package/dist/run.cjs +2 -0
  2. package/dist/run.d.cts +11 -1
  3. package/dist/run.d.ts +11 -1
  4. package/dist/run.js +2 -0
  5. package/package.json +4 -4
package/dist/run.cjs CHANGED
@@ -77,6 +77,7 @@ function buildCoreOptions(options, programMetadata) {
77
77
  const showDefault = options.showDefault;
78
78
  const showChoices = options.showChoices;
79
79
  const showUsage = options.showUsage;
80
+ const commandList = options.commandList;
80
81
  const sectionOrder = options.sectionOrder;
81
82
  const help = options.help;
82
83
  const version = options.version;
@@ -154,6 +155,7 @@ function buildCoreOptions(options, programMetadata) {
154
155
  showDefault,
155
156
  showChoices,
156
157
  showUsage,
158
+ commandList,
157
159
  sectionOrder,
158
160
  help: helpConfig,
159
161
  version: versionConfig,
package/dist/run.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { ShellCompletion } from "@optique/core/completion";
2
2
  import { SourceContext } from "@optique/core/context";
3
- import { CommandSubConfig, ContextOptionsParam, OptionSubConfig } from "@optique/core/facade";
3
+ import { CommandListMode, CommandSubConfig, ContextOptionsParam, OptionSubConfig } from "@optique/core/facade";
4
4
  import { InferMode, InferValue, Mode, ModeValue, Parser } from "@optique/core/parser";
5
5
  import { Program } from "@optique/core/program";
6
6
  import { DocSection, ShowChoicesOptions, ShowDefaultOptions } from "@optique/core/doc";
@@ -95,6 +95,16 @@ interface RunOptions {
95
95
  * @since 1.2.0
96
96
  */
97
97
  readonly showUsage?: boolean;
98
+ /**
99
+ * How to render command lists in top-level help pages.
100
+ *
101
+ * Pass `"top-level"` to show only first-level commands in the command menu
102
+ * while keeping nested command help available through `<command> --help`.
103
+ *
104
+ * @default `"recursive"`
105
+ * @since 1.2.0
106
+ */
107
+ readonly commandList?: CommandListMode;
98
108
  /**
99
109
  * A custom comparator function to control the order of sections in the
100
110
  * help output. When provided, it is used instead of the default smart
package/dist/run.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { CommandSubConfig, ContextOptionsParam, OptionSubConfig } from "@optique/core/facade";
1
+ import { CommandListMode, CommandSubConfig, ContextOptionsParam, OptionSubConfig } from "@optique/core/facade";
2
2
  import { Message } from "@optique/core/message";
3
3
  import { ShellCompletion } from "@optique/core/completion";
4
4
  import { SourceContext } from "@optique/core/context";
@@ -95,6 +95,16 @@ interface RunOptions {
95
95
  * @since 1.2.0
96
96
  */
97
97
  readonly showUsage?: boolean;
98
+ /**
99
+ * How to render command lists in top-level help pages.
100
+ *
101
+ * Pass `"top-level"` to show only first-level commands in the command menu
102
+ * while keeping nested command help available through `<command> --help`.
103
+ *
104
+ * @default `"recursive"`
105
+ * @since 1.2.0
106
+ */
107
+ readonly commandList?: CommandListMode;
98
108
  /**
99
109
  * A custom comparator function to control the order of sections in the
100
110
  * help output. When provided, it is used instead of the default smart
package/dist/run.js CHANGED
@@ -76,6 +76,7 @@ function buildCoreOptions(options, programMetadata) {
76
76
  const showDefault = options.showDefault;
77
77
  const showChoices = options.showChoices;
78
78
  const showUsage = options.showUsage;
79
+ const commandList = options.commandList;
79
80
  const sectionOrder = options.sectionOrder;
80
81
  const help = options.help;
81
82
  const version = options.version;
@@ -153,6 +154,7 @@ function buildCoreOptions(options, programMetadata) {
153
154
  showDefault,
154
155
  showChoices,
155
156
  showUsage,
157
+ commandList,
156
158
  sectionOrder,
157
159
  help: helpConfig,
158
160
  version: versionConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/run",
3
- "version": "1.2.0-dev.2297",
3
+ "version": "1.2.0-dev.2301",
4
4
  "description": "Type-safe combinatorial command-line interface parser",
5
5
  "keywords": [
6
6
  "CLI",
@@ -76,15 +76,15 @@
76
76
  },
77
77
  "sideEffects": false,
78
78
  "dependencies": {
79
- "@optique/core": "1.2.0-dev.2297+c8c9ac4a"
79
+ "@optique/core": "1.2.0-dev.2301+7cd22796"
80
80
  },
81
81
  "devDependencies": {
82
82
  "@types/node": "^24.0.0",
83
83
  "fast-check": "^4.7.0",
84
84
  "tsdown": "^0.13.0",
85
85
  "typescript": "^5.8.3",
86
- "@optique/env": "1.2.0-dev.2297+c8c9ac4a",
87
- "@optique/config": "1.2.0-dev.2297+c8c9ac4a"
86
+ "@optique/env": "1.2.0-dev.2301+7cd22796",
87
+ "@optique/config": "1.2.0-dev.2301+7cd22796"
88
88
  },
89
89
  "scripts": {
90
90
  "build": "tsdown",