feat(lib): [Command] versioning

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

__fixtures__/commands/clamp.mts

@@ -4,6 +4,7 @@
  */
 
 import sfmt from '#tests/utils/sfmt'
+import { faker } from '@faker-js/faker'
 import type { CommandInfo } from '@flex-development/kronk'
 
 /**
@@ -38,7 +39,8 @@ export default {
       flags: '-m | --min <n>',
       parser: int
     }
-  ]
+  ],
+  version: faker.system.semver()
 } as CommandInfo
 
 /**

__fixtures__/commands/mlly.mts

@@ -4,8 +4,10 @@
  */
 
 import sfmt from '#tests/utils/sfmt'
+import { faker } from '@faker-js/faker'
 import type { CommandInfo } from '@flex-development/kronk'
 import * as mlly from '@flex-development/mlly'
+import { SemVer } from 'semver'
 
 /**
  * `mlly` program info.
@@ -56,7 +58,8 @@ export default {
           description: 'keep symlinks instead of resolving them',
           flags: '--ps | --preserve-symlinks'
         }
-      ]
+      ],
+      version: new SemVer(faker.system.semver())
     }
   ]
 } as CommandInfo

__tests__/setup/faker.mts

@@ -0,0 +1,9 @@
+/**
+ * @file Test Setup - faker
+ * @module tests/setup/faker
+ * @see https://github.com/faker-js/faker
+ */
+
+import { faker } from '@faker-js/faker'
+
+global.faker = faker

package.json

@@ -146,6 +146,7 @@
     "@flex-development/fsm-tokenizer": "1.0.0-alpha.1",
     "@flex-development/log": "5.0.0-alpha.3",
     "@flex-development/tutils": "6.0.0-alpha.25",
+    "@types/semver": "7.7.0",
     "eventemitter2": "6.4.9",
     "micromark-util-character": "2.1.1",
     "plur": "5.1.0"
@@ -154,6 +155,7 @@
     "@arethetypeswrong/cli": "0.18.2",
     "@commitlint/cli": "19.8.1",
     "@commitlint/types": "19.8.1",
+    "@faker-js/faker": "9.8.0",
     "@flex-development/colors": "1.0.2",
     "@flex-development/commitlint-config": "1.0.1",
     "@flex-development/eslint-config": "1.1.1",
@@ -186,6 +188,7 @@
     "prettier": "3.5.3",
     "remark": "15.0.1",
     "remark-cli": "12.0.1",
+    "semver": "7.7.2",
     "sh-syntax": "0.5.8",
     "to-vfile": "8.0.0",
     "trash-cli": "6.0.0",

src/__snapshots__/index.e2e.snap

@@ -6,6 +6,7 @@ exports[`e2e:kronk > should expose public api 1`] = `
   "Argument",
   "Command",
   "Option",
+  "VersionOption",
   "CommandError",
   "KronkError",
   "KronkEvent",

src/interfaces/__tests__/data-command.spec-d.mts

@@ -17,7 +17,10 @@ import type {
   Option,
   OptionInfo,
   OptionPriority,
-  UnknownStrategy
+  UnknownStrategy,
+  Version,
+  VersionOption,
+  VersionOptionInfo
 } from '@flex-development/kronk'
 import type { Nilable } from '@flex-development/tutils'
 
@@ -123,4 +126,10 @@ describe('unit-d:interfaces/CommandData', () => {
       .toHaveProperty('unknown')
       .toEqualTypeOf<Nilable<UnknownStrategy>>()
   })
+
+  it('should match [version?: Version | VersionOption | VersionOptionInfo | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('version')
+      .toEqualTypeOf<Nilable<Version | VersionOption | VersionOptionInfo>>()
+  })
 })

src/interfaces/__tests__/info-option-version.spec-d.mts

@@ -0,0 +1,26 @@
+/**
+ * @file Type Tests - VersionOptionInfo
+ * @module kronk/interfaces/tests/unit-d/VersionOptionInfo
+ */
+
+import type TestSubject from '#interfaces/info-option-version'
+import type { Flags, OptionData, Version } from '@flex-development/kronk'
+import type { Nilable } from '@flex-development/tutils'
+
+describe('unit-d:interfaces/VersionOptionInfo', () => {
+  it('should extend OptionData', () => {
+    expectTypeOf<TestSubject>().toExtend<OptionData>()
+  })
+
+  it('should match [flags?: Flags | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('flags')
+      .toEqualTypeOf<Nilable<Flags>>()
+  })
+
+  it('should match [version: Version]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('version')
+      .toEqualTypeOf<Version>()
+  })
+})

src/interfaces/data-command.mts

@@ -16,7 +16,10 @@ import type {
   Option,
   OptionInfo,
   OptionPriority,
-  UnknownStrategy
+  UnknownStrategy,
+  Version,
+  VersionOption,
+  VersionOptionInfo
 } from '@flex-development/kronk'
 
 /**
@@ -130,6 +133,15 @@ interface CommandData {
    * @default false
    */
   unknown?: UnknownStrategy | null | undefined
+
+  /**
+   * The version of the command.
+   *
+   * @see {@linkcode Version}
+   * @see {@linkcode VersionOption}
+   * @see {@linkcode VersionOptionInfo}
+   */
+  version?: Version | VersionOption | VersionOptionInfo | null | undefined
 }
 
 export type { CommandData as default }

src/interfaces/index.mts

@@ -17,6 +17,9 @@ export type { default as ArgumentInfo } from '#interfaces/info-argument'
 export type { default as CommandInfo } from '#interfaces/info-command'
 export type { default as DefaultInfo } from '#interfaces/info-default'
 export type { default as OptionInfo } from '#interfaces/info-option'
+export type {
+  default as VersionOptionInfo
+} from '#interfaces/info-option-version'
 export type { default as KronkErrorCause } from '#interfaces/kronk-error-cause'
 export type { default as KronkErrorInfo } from '#interfaces/kronk-error-info'
 export type { default as KronkErrorJson } from '#interfaces/kronk-error-json'

src/interfaces/info-option-version.mts

@@ -0,0 +1,33 @@
+/**
+ * @file Interfaces - VersionOptionInfo
+ * @module kronk/interfaces/VersionOptionInfo
+ */
+
+import type { Flags, OptionData, Version } from '@flex-development/kronk'
+
+/**
+ * Data used to create a version (i.e. `-v | --version`) command option.
+ *
+ * @see {@linkcode OptionData}
+ *
+ * @extends {OptionData}
+ */
+interface VersionOptionInfo extends OptionData {
+  /**
+   * Option flags.
+   *
+   * @see {@linkcode Flags}
+   *
+   * @default '-v | --version'
+   */
+  flags?: Flags | null | undefined
+
+  /**
+   * The command version.
+   *
+   * @see {@linkcode Version}
+   */
+  version: Version
+}
+
+export type { VersionOptionInfo as default }