@gunshi/definition 0.27.2 → 0.27.4

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 (2) hide show
  1. package/lib/index.d.ts +33 -11
  2. package/package.json +2 -2
package/lib/index.d.ts CHANGED
@@ -1229,27 +1229,49 @@ type LazyCommand<G extends GunshiParamsConstraint = DefaultGunshiParams, D exten
1229
1229
  * @since v0.27.1
1230
1230
  */
1231
1231
  interface SubCommandable {
1232
- /** Command name */
1232
+ /**
1233
+ * see {@link Command.name}
1234
+ */
1233
1235
  name?: string;
1234
- /** Command description */
1236
+ /**
1237
+ * see {@link Command.description}
1238
+ */
1235
1239
  description?: string;
1236
- /** Command arguments - accepts any args structure */
1240
+ /**
1241
+ * see {@link Command.args}
1242
+ */
1237
1243
  args?: Args | Record<string, any>;
1238
- /** Command examples */
1244
+ /**
1245
+ * see {@link Command.examples}
1246
+ */
1239
1247
  examples?: string | ((...args: any[]) => any);
1240
- /** Command runner */
1248
+ /**
1249
+ * see {@link Command.run}
1250
+ */
1241
1251
  run?: (...args: any[]) => any;
1242
- /** Whether to convert camelCase to kebab-case */
1252
+ /**
1253
+ * see {@link Command.toKebab}
1254
+ */
1243
1255
  toKebab?: boolean;
1244
- /** Whether this is an internal command */
1256
+ /**
1257
+ * see {@link Command.internal}
1258
+ */
1245
1259
  internal?: boolean;
1246
- /** Whether this is an entry command */
1260
+ /**
1261
+ * see {@link Command.entry}
1262
+ */
1247
1263
  entry?: boolean;
1248
- /** Rendering options */
1264
+ /**
1265
+ * see {@link Command.rendering}
1266
+ */
1249
1267
  rendering?: any;
1250
- /** Command name for lazy commands */
1268
+ /**
1269
+ * see {@link LazyCommand.commandName}
1270
+ */
1251
1271
  commandName?: string;
1252
- /** Index signature to allow additional properties */
1272
+ /**
1273
+ * Index signature to allow additional properties
1274
+ */
1253
1275
  [key: string]: any;
1254
1276
  }
1255
1277
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gunshi/definition",
3
3
  "description": "utilities for gunshi command definition",
4
- "version": "0.27.2",
4
+ "version": "0.27.4",
5
5
  "author": {
6
6
  "name": "kazuya kawaguchi",
7
7
  "email": "kawakazu80@gmail.com"
@@ -57,7 +57,7 @@
57
57
  "jsr-exports-lint": "^0.4.1",
58
58
  "publint": "^0.3.16",
59
59
  "tsdown": "0.15.12",
60
- "gunshi": "0.27.2"
60
+ "gunshi": "0.27.4"
61
61
  },
62
62
  "scripts": {
63
63
  "build": "tsdown",