@decaf-ts/utils 1.5.1 → 1.5.3

package/lib/types/cli/commands/build-scripts.d.mts

@@ -69,11 +69,14 @@ export declare class BuildScripts extends Command<CommandOptions<typeof options>
     private replacements;
     private readonly pkgVersion;
     private readonly pkgName;
+    private readonly commitHash;
+    private readonly fullVersion;
     constructor();
     /**
-     * @description Patches files with version and package name.
-     * @summary This method reads all files in a directory, finds placeholders for version
-     * and package name, and replaces them with the actual values from package.json.
+     * @description Patches files with version, commit, full version, and package name.
+     * @summary This method reads all files in a directory, finds placeholders for version,
+     * commit hash, full version, and package name, and replaces them with the actual values
+     * from package.json and the current git revision.
      * @param {string} p - The path to the directory containing the files to patch.
      */
     patchFiles(p: string): void;

package/lib/types/cli/commands/help.d.cts

@@ -0,0 +1,7 @@
+import { Logger } from "@decaf-ts/logging";
+export type HelpOption = {
+    flag: string;
+    description: string;
+    defaultValue?: string;
+};
+export declare function printCommandHelp(log: Logger, commandName: string, summary: string, usage: string, options: HelpOption[], notes?: string[], examples?: string[]): void;

package/lib/types/cli/commands/help.d.mts

@@ -0,0 +1,7 @@
+import { Logger } from "@decaf-ts/logging";
+export type HelpOption = {
+    flag: string;
+    description: string;
+    defaultValue?: string;
+};
+export declare function printCommandHelp(log: Logger, commandName: string, summary: string, usage: string, options: HelpOption[], notes?: string[], examples?: string[]): void;

package/lib/types/cli/commands/modules.d.cts

@@ -11,6 +11,7 @@ declare const options: {
 };
 export declare class ModulesCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         basePath: string;
     }): Promise<void>;

package/lib/types/cli/commands/modules.d.mts

@@ -11,6 +11,7 @@ declare const options: {
 };
 export declare class ModulesCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         basePath: string;
     }): Promise<void>;

package/lib/types/cli/commands/npm-link.d.cts

@@ -16,6 +16,15 @@ declare const options: {
         multiple: boolean;
         default: never[];
     };
+    packages: {
+        type: string;
+        multiple: boolean;
+        default: never[];
+    };
+    mainPackagePath: {
+        type: string;
+        default: string;
+    };
     operation: {
         type: string;
         default: string;
@@ -28,6 +37,8 @@ export declare class NpmLinkCommand extends Command<typeof options, void> {
         maxTraversal: unknown;
         excludes: unknown;
         include: unknown;
+        packages: unknown;
+        mainPackagePath: unknown;
         operation: unknown;
     }): Promise<void>;
 }

package/lib/types/cli/commands/npm-link.d.mts

@@ -16,6 +16,15 @@ declare const options: {
         multiple: boolean;
         default: never[];
     };
+    packages: {
+        type: string;
+        multiple: boolean;
+        default: never[];
+    };
+    mainPackagePath: {
+        type: string;
+        default: string;
+    };
     operation: {
         type: string;
         default: string;
@@ -28,6 +37,8 @@ export declare class NpmLinkCommand extends Command<typeof options, void> {
         maxTraversal: unknown;
         excludes: unknown;
         include: unknown;
+        packages: unknown;
+        mainPackagePath: unknown;
         operation: unknown;
     }): Promise<void>;
 }

package/lib/types/cli/commands/npm-token.d.cts

@@ -14,6 +14,7 @@ declare const options: {
 };
 export declare class NpmTokenCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         maxTraversal: unknown;
         tokenFiles: unknown;

package/lib/types/cli/commands/npm-token.d.mts

@@ -14,6 +14,7 @@ declare const options: {
 };
 export declare class NpmTokenCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         maxTraversal: unknown;
         tokenFiles: unknown;

package/lib/types/cli/commands/release-chain.d.cts

@@ -53,10 +53,12 @@ type ReleaseChainAnswerMap = {
 };
 export declare class ReleaseChainCommand extends Command<CommandOptions<typeof releaseChainArgs>, void> {
     constructor();
+    protected help(): void;
     protected run(options: LoggingConfig & typeof DefaultCommandValues & ReleaseChainAnswerMap): Promise<void>;
 }
 export declare class ReleaseChainDispatchCommand extends Command<CommandOptions<typeof releaseChainArgs>, void> {
     constructor();
+    protected help(): void;
     protected run(options: LoggingConfig & typeof DefaultCommandValues & ReleaseChainAnswerMap): Promise<void>;
 }
 export {};

package/lib/types/cli/commands/release-chain.d.mts

@@ -53,10 +53,12 @@ type ReleaseChainAnswerMap = {
 };
 export declare class ReleaseChainCommand extends Command<CommandOptions<typeof releaseChainArgs>, void> {
     constructor();
+    protected help(): void;
     protected run(options: LoggingConfig & typeof DefaultCommandValues & ReleaseChainAnswerMap): Promise<void>;
 }
 export declare class ReleaseChainDispatchCommand extends Command<CommandOptions<typeof releaseChainArgs>, void> {
     constructor();
+    protected help(): void;
     protected run(options: LoggingConfig & typeof DefaultCommandValues & ReleaseChainAnswerMap): Promise<void>;
 }
 export {};

package/lib/types/cli/commands/run-all.d.cts

@@ -13,6 +13,7 @@ declare const options: {
 };
 export declare class RunAllCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         basePath: unknown;
         command: unknown;

package/lib/types/cli/commands/run-all.d.mts

@@ -13,6 +13,7 @@ declare const options: {
 };
 export declare class RunAllCommand extends Command<typeof options, void> {
     constructor();
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         basePath: unknown;
         command: unknown;

package/lib/types/cli/commands/tag-release-shell.d.cts

@@ -42,6 +42,7 @@ export declare class TagReleaseCommand extends Command<typeof options, void> {
     private prepareMessage;
     private hasToken;
     private readToken;
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         public: unknown;
         private: unknown;

package/lib/types/cli/commands/tag-release-shell.d.mts

@@ -42,6 +42,7 @@ export declare class TagReleaseCommand extends Command<typeof options, void> {
     private prepareMessage;
     private hasToken;
     private readToken;
+    protected help(): void;
     protected run(answers: LoggingConfig & typeof DefaultCommandValues & {
         public: unknown;
         private: unknown;

package/lib/types/cli/commands/tag-release.d.cts

@@ -68,6 +68,7 @@ export declare class ReleaseScript extends Command<typeof options, void> {
      * @returns {Promise<string>} The prepared release message
      */
     prepareMessage(message?: string): Promise<string>;
+    protected help(): void;
     /**
      * @description Runs the release script.
      * @summary This method orchestrates the entire release process, including version preparation, message creation,

package/lib/types/cli/commands/tag-release.d.mts

@@ -68,6 +68,7 @@ export declare class ReleaseScript extends Command<typeof options, void> {
      * @returns {Promise<string>} The prepared release message
      */
     prepareMessage(message?: string): Promise<string>;
+    protected help(): void;
     /**
      * @description Runs the release script.
      * @summary This method orchestrates the entire release process, including version preparation, message creation,

package/lib/types/index.d.cts

@@ -27,12 +27,28 @@ export * from "./release-chain/index.d.cts";
  * @const VERSION
  * @memberOf module:utils
  */
-export declare const VERSION = "1.5.0";
+export declare const VERSION = "1.5.2";
+/**
+ * @description Represents the current commit hash of the module build.
+ * @summary Stores the current git commit hash for the @decaf-ts/utils package.
+ * The build replaces the placeholder with the actual commit hash at publish time.
+ * @const COMMIT
+ * @memberOf module:utils
+ */
+export declare const COMMIT = "bd18c64";
+/**
+ * @description Represents the full version string of the module.
+ * @summary Stores the semver version and commit hash for the @decaf-ts/utils package.
+ * The build replaces the placeholder with the actual `<version>-<commit>` value at publish time.
+ * @const FULL_VERSION
+ * @memberOf module:utils
+ */
+export declare const FULL_VERSION = "1.5.2-bd18c64";
 /**
  * @description Represents the current version of the module.
- * @summary Stores the version for the @decaf-ts/utils package. The build replaces
- * the placeholder with the actual version number at publish time.
- * @const VERSION
+ * @summary Stores the package name for the @decaf-ts/utils package. The build replaces
+ * the placeholder with the actual package name at publish time.
+ * @const PACKAGE_NAME
  * @memberOf module:utils
  */
 export declare const PACKAGE_NAME = "@decaf-ts/utils";

package/lib/types/index.d.mts

@@ -27,12 +27,28 @@ export * from "./release-chain/index.d.mts";
  * @const VERSION
  * @memberOf module:utils
  */
-export declare const VERSION = "1.5.0";
+export declare const VERSION = "1.5.2";
+/**
+ * @description Represents the current commit hash of the module build.
+ * @summary Stores the current git commit hash for the @decaf-ts/utils package.
+ * The build replaces the placeholder with the actual commit hash at publish time.
+ * @const COMMIT
+ * @memberOf module:utils
+ */
+export declare const COMMIT = "bd18c64";
+/**
+ * @description Represents the full version string of the module.
+ * @summary Stores the semver version and commit hash for the @decaf-ts/utils package.
+ * The build replaces the placeholder with the actual `<version>-<commit>` value at publish time.
+ * @const FULL_VERSION
+ * @memberOf module:utils
+ */
+export declare const FULL_VERSION = "1.5.2-bd18c64";
 /**
  * @description Represents the current version of the module.
- * @summary Stores the version for the @decaf-ts/utils package. The build replaces
- * the placeholder with the actual version number at publish time.
- * @const VERSION
+ * @summary Stores the package name for the @decaf-ts/utils package. The build replaces
+ * the placeholder with the actual package name at publish time.
+ * @const PACKAGE_NAME
  * @memberOf module:utils
  */
 export declare const PACKAGE_NAME = "@decaf-ts/utils";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/utils",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "module management utils for decaf-ts",
   "type": "module",
   "exports": {