@optique/run 1.2.0-dev.2282 → 1.2.0-dev.2287

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 -0
  3. package/dist/run.d.ts +11 -0
  4. package/dist/run.js +2 -0
  5. package/package.json +4 -4
package/dist/run.cjs CHANGED
@@ -76,6 +76,7 @@ function buildCoreOptions(options, programMetadata) {
76
76
  const maxWidth = options.maxWidth ?? node_process.default.stdout.columns;
77
77
  const showDefault = options.showDefault;
78
78
  const showChoices = options.showChoices;
79
+ const showUsage = options.showUsage;
79
80
  const sectionOrder = options.sectionOrder;
80
81
  const help = options.help;
81
82
  const version = options.version;
@@ -152,6 +153,7 @@ function buildCoreOptions(options, programMetadata) {
152
153
  maxWidth,
153
154
  showDefault,
154
155
  showChoices,
156
+ showUsage,
155
157
  sectionOrder,
156
158
  help: helpConfig,
157
159
  version: versionConfig,
package/dist/run.d.cts CHANGED
@@ -84,6 +84,17 @@ interface RunOptions {
84
84
  * @since 0.10.0
85
85
  */
86
86
  readonly showChoices?: boolean | ShowChoicesOptions;
87
+ /**
88
+ * Whether to include the usage synopsis in full help output.
89
+ *
90
+ * This affects help pages produced by `--help`, the help command, and
91
+ * `aboveError: "help"`. It does not suppress usage-only error preambles
92
+ * from `aboveError: "usage"`.
93
+ *
94
+ * @default `true`
95
+ * @since 1.2.0
96
+ */
97
+ readonly showUsage?: boolean;
87
98
  /**
88
99
  * A custom comparator function to control the order of sections in the
89
100
  * help output. When provided, it is used instead of the default smart
package/dist/run.d.ts CHANGED
@@ -84,6 +84,17 @@ interface RunOptions {
84
84
  * @since 0.10.0
85
85
  */
86
86
  readonly showChoices?: boolean | ShowChoicesOptions;
87
+ /**
88
+ * Whether to include the usage synopsis in full help output.
89
+ *
90
+ * This affects help pages produced by `--help`, the help command, and
91
+ * `aboveError: "help"`. It does not suppress usage-only error preambles
92
+ * from `aboveError: "usage"`.
93
+ *
94
+ * @default `true`
95
+ * @since 1.2.0
96
+ */
97
+ readonly showUsage?: boolean;
87
98
  /**
88
99
  * A custom comparator function to control the order of sections in the
89
100
  * help output. When provided, it is used instead of the default smart
package/dist/run.js CHANGED
@@ -75,6 +75,7 @@ function buildCoreOptions(options, programMetadata) {
75
75
  const maxWidth = options.maxWidth ?? process.stdout.columns;
76
76
  const showDefault = options.showDefault;
77
77
  const showChoices = options.showChoices;
78
+ const showUsage = options.showUsage;
78
79
  const sectionOrder = options.sectionOrder;
79
80
  const help = options.help;
80
81
  const version = options.version;
@@ -151,6 +152,7 @@ function buildCoreOptions(options, programMetadata) {
151
152
  maxWidth,
152
153
  showDefault,
153
154
  showChoices,
155
+ showUsage,
154
156
  sectionOrder,
155
157
  help: helpConfig,
156
158
  version: versionConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/run",
3
- "version": "1.2.0-dev.2282",
3
+ "version": "1.2.0-dev.2287",
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.2282+c9c50098"
79
+ "@optique/core": "1.2.0-dev.2287+86d0fd20"
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/config": "1.2.0-dev.2282+c9c50098",
87
- "@optique/env": "1.2.0-dev.2282+c9c50098"
86
+ "@optique/env": "1.2.0-dev.2287+86d0fd20",
87
+ "@optique/config": "1.2.0-dev.2287+86d0fd20"
88
88
  },
89
89
  "scripts": {
90
90
  "build": "tsdown",