@optique/run 0.10.0-dev.327 → 0.10.0-dev.329

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 +7 -1
  2. package/dist/run.d.cts +18 -0
  3. package/dist/run.d.ts +18 -0
  4. package/dist/run.js +7 -1
  5. package/package.json +2 -2
package/dist/run.cjs CHANGED
@@ -26,10 +26,13 @@ function runImpl(parserOrProgram, options = {}) {
26
26
  programMetadata = {
27
27
  brief: program.metadata.brief,
28
28
  description: program.metadata.description,
29
+ examples: program.metadata.examples,
30
+ author: program.metadata.author,
31
+ bugs: program.metadata.bugs,
29
32
  footer: program.metadata.footer
30
33
  };
31
34
  } else parser = parserOrProgram;
32
- const { programName = programNameFromProgram ?? node_path.default.basename(node_process.default.argv[1] || "cli"), args = node_process.default.argv.slice(2), colors = node_process.default.stdout.isTTY, maxWidth = node_process.default.stdout.columns, showDefault, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, footer = programMetadata?.footer } = options;
35
+ const { programName = programNameFromProgram ?? node_path.default.basename(node_process.default.argv[1] || "cli"), args = node_process.default.argv.slice(2), colors = node_process.default.stdout.isTTY, maxWidth = node_process.default.stdout.columns, showDefault, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
33
36
  const helpConfig = help ? {
34
37
  mode: help,
35
38
  onShow: () => node_process.default.exit(0)
@@ -61,6 +64,9 @@ function runImpl(parserOrProgram, options = {}) {
61
64
  aboveError,
62
65
  brief,
63
66
  description,
67
+ examples,
68
+ author,
69
+ bugs,
64
70
  footer,
65
71
  onError() {
66
72
  return node_process.default.exit(errorExitCode);
package/dist/run.d.cts CHANGED
@@ -118,6 +118,24 @@ interface RunOptions {
118
118
  * @since 0.4.0
119
119
  */
120
120
  readonly description?: Message;
121
+ /**
122
+ * Usage examples for the program.
123
+ *
124
+ * @since 0.10.0
125
+ */
126
+ readonly examples?: Message;
127
+ /**
128
+ * Author information.
129
+ *
130
+ * @since 0.10.0
131
+ */
132
+ readonly author?: Message;
133
+ /**
134
+ * Information about where to report bugs.
135
+ *
136
+ * @since 0.10.0
137
+ */
138
+ readonly bugs?: Message;
121
139
  /**
122
140
  * Footer text shown at the bottom of help text.
123
141
  *
package/dist/run.d.ts CHANGED
@@ -118,6 +118,24 @@ interface RunOptions {
118
118
  * @since 0.4.0
119
119
  */
120
120
  readonly description?: Message;
121
+ /**
122
+ * Usage examples for the program.
123
+ *
124
+ * @since 0.10.0
125
+ */
126
+ readonly examples?: Message;
127
+ /**
128
+ * Author information.
129
+ *
130
+ * @since 0.10.0
131
+ */
132
+ readonly author?: Message;
133
+ /**
134
+ * Information about where to report bugs.
135
+ *
136
+ * @since 0.10.0
137
+ */
138
+ readonly bugs?: Message;
121
139
  /**
122
140
  * Footer text shown at the bottom of help text.
123
141
  *
package/dist/run.js CHANGED
@@ -25,10 +25,13 @@ function runImpl(parserOrProgram, options = {}) {
25
25
  programMetadata = {
26
26
  brief: program.metadata.brief,
27
27
  description: program.metadata.description,
28
+ examples: program.metadata.examples,
29
+ author: program.metadata.author,
30
+ bugs: program.metadata.bugs,
28
31
  footer: program.metadata.footer
29
32
  };
30
33
  } else parser = parserOrProgram;
31
- const { programName = programNameFromProgram ?? path.basename(process.argv[1] || "cli"), args = process.argv.slice(2), colors = process.stdout.isTTY, maxWidth = process.stdout.columns, showDefault, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, footer = programMetadata?.footer } = options;
34
+ const { programName = programNameFromProgram ?? path.basename(process.argv[1] || "cli"), args = process.argv.slice(2), colors = process.stdout.isTTY, maxWidth = process.stdout.columns, showDefault, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
32
35
  const helpConfig = help ? {
33
36
  mode: help,
34
37
  onShow: () => process.exit(0)
@@ -60,6 +63,9 @@ function runImpl(parserOrProgram, options = {}) {
60
63
  aboveError,
61
64
  brief,
62
65
  description,
66
+ examples,
67
+ author,
68
+ bugs,
63
69
  footer,
64
70
  onError() {
65
71
  return process.exit(errorExitCode);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/run",
3
- "version": "0.10.0-dev.327+76d21ea0",
3
+ "version": "0.10.0-dev.329+96b4ad62",
4
4
  "description": "Type-safe combinatorial command-line interface parser",
5
5
  "keywords": [
6
6
  "CLI",
@@ -70,7 +70,7 @@
70
70
  },
71
71
  "sideEffects": false,
72
72
  "dependencies": {
73
- "@optique/core": "0.10.0-dev.327+76d21ea0"
73
+ "@optique/core": "0.10.0-dev.329+96b4ad62"
74
74
  },
75
75
  "devDependencies": {
76
76
  "@types/node": "^20.19.9",