@decaf-ts/cli 0.3.2 → 0.3.6

package/lib/utils.d.ts

@@ -1,49 +1,70 @@
 import { Command } from "commander";
 import { CliModule } from "./types";
 /**
- * @description util class to retrieve versions and other information
+ * @description Utility class for CLI operations
+ * @summary A static utility class that provides methods for loading modules, retrieving package information, and initializing CLI commands
+ *
+ * @example
+ * // Initialize a Command object with package information
+ * const command = new Command();
+ * CLIUtils.initialize(command, './path/to/package');
+ *
+ * // Load a CLI module from a file
+ * const module = await CLIUtils.loadFromFile('./path/to/cli-module.js');
  *
  * @class CLIUtils
- * @static
  */
 export declare class CLIUtils {
     /**
-     * @description Dynamically imports a cjs file into a decaf module
-     * @param {string} path
-     * @static
+     * @description Dynamically imports a module file
+     * @summary Loads a JavaScript file and returns it as a CliModule, handling both ESM and CommonJS formats
+     *
+     * @param {string} path The file path to the module to load
+     * @return {Promise<CliModule>} A promise that resolves to the loaded CliModule
      */
     static loadFromFile(path: string): Promise<CliModule>;
     /**
-     * @description allows safe dynamic imports
-     * @summary property imports JS files regardless of esm status
+     * @description Normalizes module imports to handle both ESM and CommonJS formats
+     * @summary Properly imports JavaScript files regardless of their module format by handling the ESM wrapper for CommonJS modules
      *
-     * @typeParam T
-     * @param {Promise} importPromise
+     * @template T The type of the imported module
+     * @param {Promise<T>} importPromise The promise returned by the dynamic import
+     * @return {Promise<T>} A promise that resolves to the normalized module
      * @private
      */
     static normalizeImport<T>(importPromise: Promise<T>): Promise<T>;
     /**
-     * @description initializes the Cli object
+     * @description Initializes a Command object with package information
+     * @summary Sets up a Commander Command object with the package name, description, and version from the package.json file
      *
-     * @param {Command} command
-     * @param {string} [basePath] defaults to the current working directory
+     * @param {Command} command The Command object to initialize
+     * @param {string} [basePath] The base path where the package.json file is located, defaults to the current working directory
+     * @return {void}
      */
     static initialize(command: Command, basePath: string): void;
     /**
-     * @description retrieves and parses the package.json file
+     * @description Retrieves and parses the package.json file
+     * @summary Reads the package.json file from the specified path and parses it into a JavaScript object
      *
-     * @param {string} basePath
+     * @param {string} basePath The base path where the package.json file is located
+     * @return {Record<string, unknown>} The parsed package.json content as an object
      * @private
      */
     private static getPackage;
     /**
-     * @description returns the package version
-     * @param {string} [basePath] defaults to current working dir
+     * @description Returns the version from package.json
+     * @summary Retrieves the version field from the package.json file at the specified path
+     *
+     * @param {string} basePath The base path where the package.json file is located
+     * @return {string} The package version string
      */
     static packageVersion(basePath: string): string;
     /**
-     * @description returns the package name
-     * @param {string} [basePath] defaults to current working dir
+     * @description Returns the name from package.json
+     * @summary Retrieves the name field from the package.json file at the specified path and extracts the package name without the scope
+     *
+     * @param {string} basePath The base path where the package.json file is located
+     * @return {string} The package name without the scope (e.g., "cli" from "@decaf-ts/cli")
      */
     static packageName(basePath: string): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/cli",
-  "version": "0.3.2",
+  "version": "0.3.6",
   "description": "cli for decaf-ts projects",
   "type": "module",
   "exports": {
@@ -29,6 +29,7 @@
     "coverage": "rimraf ./workdocs/reports/data/*.json && npm run test:all -- --coverage --config=./workdocs/reports/jest.coverage.config.ts",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
+    "prepare-pr": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
     "prepare-release": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
     "release": "./bin/tag-release.sh",
     "clean-publish": "npx clean-publish",
@@ -68,7 +69,7 @@
     "ts"
   ],
   "author": "Tiago Venceslau",
-  "license": "LGPL-3.0-or-later",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/decaf-ts/cli/issues"
   },