@cluerise/tools 4.2.1 → 5.0.0

package/dist/scripts/init/main.js

@@ -11,19 +11,19 @@ import * as Prettier from "prettier";
 class CoreConfig {
   static #packageName = "@cluerise/tools";
   /**
-   * Determines if the application is running in production mode.
+   * Determine if the application is running in production mode.
    *
-   * This is based on the environment variable `import.meta.env.PROD`.
+   * This checks the environment variable `import.meta.env.PROD` to determine the mode.
    *
-   * @returns True if in production mode, false otherwise.
+   * @returns True if running in production mode, otherwise false.
    */
   static get isProd() {
     return true;
   }
   /**
-   * Returns the package and its path to the configuration files.
+   * Get the path to package configuration files in production.
    *
-   * This is used to load configurations from the package in production mode.
+   * Used to load configuration from the package when running in production.
    *
    * @returns The path to the configuration files in the package.
    */
@@ -34,10 +34,9 @@ class CoreConfig {
     return this.isProd ? `./node_modules/${this.#packageName}` : ".";
   }
   /**
-   * Returns the directory where configuration files are stored.
+   * Get the directory path where configuration files are stored.
    *
-   * In production mode, this points to the `dist/configs` directory within the package.
-   * In development mode, it points to the root directory.
+   * In production, this points to `dist/configs` in the package; in development, it points to the root directory.
    *
    * @returns The path to the configuration directory.
    */
@@ -47,13 +46,18 @@ class CoreConfig {
 }
 class ConsoleStatusLogger {
   #command;
+  /**
+   * Create a new logger for a specific command.
+   *
+   * @param command The command name to log.
+   */
   constructor(command) {
     this.#command = command;
   }
   /**
-   * Begins logging for a command with the specified argument.
+   * Log the beginning of a command with the provided argument.
    *
-   * @param argument - The argument for the command.
+   * @param argument The argument for the command.
    *
    * @example
    * const logger = new ConsoleStatusLogger('Linting');
@@ -69,10 +73,10 @@ class ConsoleStatusLogger {
     return exitCode === 0 ? "OK" : "Failed";
   }
   /**
-   * Ends logging for a command with the specified argument and exit code.
+   * Log the end of a command with the provided argument and exit code.
    *
-   * @param argument - The argument for the command.
-   * @param exitCode - The exit code of the command execution. If null, it indicates completion without an error.
+   * @param argument The argument for the command.
+   * @param exitCode The exit code of the command execution. If null, it indicates completion without an error.
    *
    * @example
    * const logger = new ConsoleStatusLogger('Linting');
@@ -91,19 +95,19 @@ class GitProvider {
   static #origins = gitProviderOrigins;
   static #names = Object.keys(this.#origins);
   /**
-   * Checks if the provided name is a valid Git provider name.
+   * Check if the provided name is a valid Git provider name.
    *
-   * @param name - The name of the Git provider to validate.
-   * @returns True if the name is valid, false otherwise.
+   * @param name The name to check.
+   * @returns True if the name is valid, otherwise false.
    */
   static isValidName(name) {
     return this.#names.includes(name);
   }
   /**
-   * Returns a Git provider origin.
+   * Get the origin URL for the given Git provider name.
    *
-   * @param name - The name of the Git provider.
-   * @returns The origin URL of the Git provider.
+   * @param name The Git provider name.
+   * @returns The origin URL.
    */
   static getOrigin(name) {
     return this.#origins[name];
@@ -130,6 +134,13 @@ class PackageJson {
   constructor(data) {
     this.#data = data;
   }
+  /**
+   * Load and parse the `package.json` file, returning a `PackageJson` instance.
+   *
+   * Throws an error if the file is invalid or cannot be parsed.
+   *
+   * @returns A new `PackageJson` instance with parsed data.
+   */
   static async init() {
     const content = await FileSystem.readFile("package.json", { encoding: "utf8" });
     const data = JsonUtils.parse(content);
@@ -142,21 +153,41 @@ class PackageJson {
     return new PackageJson(data);
   }
   /**
-   * Returns the required engines.
+   * Get the package name from `package.json`.
+   *
+   * @returns The package name.
+   */
+  get name() {
+    return this.#data.name;
+  }
+  /**
+   * Get the package version from `package.json`.
+   *
+   * @returns The package version.
+   */
+  get version() {
+    return this.#data.version;
+  }
+  /**
+   * Get the engines field from `package.json`, if present.
+   *
+   * @returns The engines object or undefined.
    */
   get engines() {
     return this.#data.engines;
   }
   /**
-   * Sets the required engines.
+   * Set the engines field in `package.json`.
    *
-   * @param engines - The engines to set.
+   * @param engines The engines object to set.
    */
   set engines(engines) {
     this.#data.engines = engines;
   }
   /**
-   * Returns the repository information.
+   * Get the repository field from `package.json`, if present.
+   *
+   * @returns The repository object or string, or undefined.
    */
   get repository() {
     return this.#data.repository;
@@ -193,9 +224,11 @@ class PackageJson {
     throw new Error("Unsupported repository URL");
   }
   /**
-   * Parses the repository information from package.json.
+   * Parse the repository information from `package.json` and return a `GitRepository` object or null.
+   *
+   * Returns null if no repository is defined or if parsing fails.
    *
-   * @returns The parsed GitRepository or null if no repository is defined.
+   * @returns The parsed `GitRepository`, or null if not available.
    */
   parseGitRepository() {
     if (!this.repository) {
@@ -207,7 +240,7 @@ class PackageJson {
     return this.#parseGitRepository(this.repository.url);
   }
   /**
-   * Saves the package.json file with the current data.
+   * Save the current `package.json` data to disk, formatting it as prettified JSON.
    */
   async save() {
     const content = JsonUtils.prettify(this.#data) + "\n";
@@ -272,7 +305,7 @@ class ToolInitializer {
     this.#configPackage = configPackage;
   }
   /**
-   * Returns the names of all available tools.
+   * Get the names of all available tools.
    *
    * @returns An array of tool names.
    */
@@ -380,9 +413,9 @@ export default createReleaseConfig(${JsonUtils.prettify(configParams)});
     await FileUtils.createFile(settingsPath, settingsContent);
   }
   /**
-   * Initializes the specified tool.
+   * Initialize the specified tool.
    *
-   * @param toolName - The name of the tool to initialize.
+   * @param toolName The name of the tool to initialize.
    * @returns A promise that resolves when the tool is initialized.
    */
   async initTool(toolName) {
@@ -433,9 +466,9 @@ class FileLinter {
     }
   }
   /**
-   * Lints files using `lint-staged` with the provided arguments.
+   * Lint files using `lint-staged` with the provided arguments.
    *
-   * @param args - An array of arguments to pass to `lint-staged`.
+   * @param args An array of arguments to pass to `lint-staged`.
    * @returns The exit status of the `lint-staged` command.
    */
   static lintStaged(args) {
@@ -528,9 +561,9 @@ class FileLinter {
     return results;
   }
   /**
-   * Lints files matching the provided patterns using ESLint and Prettier.
+   * Lint files matching the provided patterns using ESLint and Prettier.
    *
-   * @param patterns - An array of glob patterns to match files against. Defaults to ['**'] which matches all files.
+   * @param patterns An array of glob patterns to match files against. Defaults to ['**'] which matches all files.
    * @returns A promise that resolves to a LintFilesResult indicating the success or failure of the linting process.
    */
   async lint(patterns = ["**"]) {

package/dist/scripts/lint/main.js

@@ -10,19 +10,19 @@ import * as Prettier from "prettier";
 class CoreConfig {
   static #packageName = "@cluerise/tools";
   /**
-   * Determines if the application is running in production mode.
+   * Determine if the application is running in production mode.
    *
-   * This is based on the environment variable `import.meta.env.PROD`.
+   * This checks the environment variable `import.meta.env.PROD` to determine the mode.
    *
-   * @returns True if in production mode, false otherwise.
+   * @returns True if running in production mode, otherwise false.
    */
   static get isProd() {
     return true;
   }
   /**
-   * Returns the package and its path to the configuration files.
+   * Get the path to package configuration files in production.
    *
-   * This is used to load configurations from the package in production mode.
+   * Used to load configuration from the package when running in production.
    *
    * @returns The path to the configuration files in the package.
    */
@@ -33,10 +33,9 @@ class CoreConfig {
     return this.isProd ? `./node_modules/${this.#packageName}` : ".";
   }
   /**
-   * Returns the directory where configuration files are stored.
+   * Get the directory path where configuration files are stored.
    *
-   * In production mode, this points to the `dist/configs` directory within the package.
-   * In development mode, it points to the root directory.
+   * In production, this points to `dist/configs` in the package; in development, it points to the root directory.
    *
    * @returns The path to the configuration directory.
    */
@@ -46,13 +45,18 @@ class CoreConfig {
 }
 class ConsoleStatusLogger {
   #command;
+  /**
+   * Create a new logger for a specific command.
+   *
+   * @param command The command name to log.
+   */
   constructor(command) {
     this.#command = command;
   }
   /**
-   * Begins logging for a command with the specified argument.
+   * Log the beginning of a command with the provided argument.
    *
-   * @param argument - The argument for the command.
+   * @param argument The argument for the command.
    *
    * @example
    * const logger = new ConsoleStatusLogger('Linting');
@@ -68,10 +72,10 @@ class ConsoleStatusLogger {
     return exitCode === 0 ? "OK" : "Failed";
   }
   /**
-   * Ends logging for a command with the specified argument and exit code.
+   * Log the end of a command with the provided argument and exit code.
    *
-   * @param argument - The argument for the command.
-   * @param exitCode - The exit code of the command execution. If null, it indicates completion without an error.
+   * @param argument The argument for the command.
+   * @param exitCode The exit code of the command execution. If null, it indicates completion without an error.
    *
    * @example
    * const logger = new ConsoleStatusLogger('Linting');
@@ -109,10 +113,12 @@ const runMain = (main2) => {
 };
 class StringUtils {
   /**
-   * Capitalizes the first letter of a given string.
+   * Capitalize the first letter of a given string.
    *
-   * @param value - The string to capitalize.
-   * @returns The string with the first letter capitalized.
+   * If the string is empty, it is returned unchanged.
+   *
+   * @param value The string to capitalize.
+   * @returns The string with the first letter capitalized, or the original string if empty.
    */
   static capitalize(value) {
     const [firstLetter] = value;
@@ -128,7 +134,7 @@ class CommitLinter {
     this.#config = config;
   }
   /**
-   * Initializes the CommitLinter with the loaded commitlint configuration.
+   * Initialize the CommitLinter with the loaded commitlint configuration.
    *
    * @returns A Promise that resolves to an instance of CommitLinter.
    */
@@ -137,9 +143,9 @@ class CommitLinter {
     return new CommitLinter(config);
   }
   /**
-   * Lints commit messages using commitlint.
+   * Lint commit messages using commitlint.
    *
-   * @param args - An array of arguments to pass to commitlint.
+   * @param args An array of arguments to pass to commitlint.
    * @returns The exit status of the commitlint command.
    */
   static lint(args) {
@@ -164,9 +170,9 @@ class CommitLinter {
     return this.#isValidEnumValue("scope-enum", scope);
   }
   /**
-   * Parses a semantic branch name into its type and scope.
+   * Parse a semantic branch name into its type and scope.
    *
-   * @param name - The branch name to parse.
+   * @param name The branch name to parse.
    * @returns An object containing the type and scope of the commit message.
    * @throws An error if the branch name is invalid.
    */
@@ -183,12 +189,13 @@ class CommitLinter {
     };
   }
   /**
-   * Returns the prefix of a semantic commit message as a string.
+   * Get the prefix of a semantic commit message as a string.
    *
    * This prefix consists of the type and scope of the commit message.
    * If the scope is not provided, it will only return the type.
-   * @param prefix - An object containing the type and scope of the commit message.
-   * @returns
+   *
+   * @param prefix An object containing the type and scope of the commit message.
+   * @returns The stringified prefix.
    */
   static stringifySemanticCommitMessagePrefix({ type, scope }) {
     return `${type}${scope ? `(${scope})` : ""}`;
@@ -200,9 +207,9 @@ class CommitLinter {
     return { prefix, content };
   }
   /**
-   * Formats a semantic commit message by capitalizing the content after the prefix.
+   * Format a semantic commit message by capitalizing the content after the prefix.
    *
-   * @param message - The commit message to format.
+   * @param message The commit message to format.
    * @returns The formatted commit message.
    */
   static formatSemanticCommitMessage(message) {
@@ -213,20 +220,20 @@ class CommitLinter {
     return `${prefix}: ${StringUtils.capitalize(content)}`;
   }
   /**
-   * Creates a semantic commit message from a prefix and a message.
+   * Create a semantic commit message from a prefix and a message.
    *
-   * @param prefix - The prefix of the commit message, containing type and scope.
-   * @param message - The content of the commit message.
+   * @param prefix The prefix of the commit message, containing type and scope.
+   * @param message The content of the commit message.
    * @returns The formatted semantic commit message.
    */
   static createSemanticCommitMessage(prefix, message) {
     const [subject, ...comments] = message.split("\n#");
     let commitMessage = this.stringifySemanticCommitMessagePrefix(prefix) + ": ";
     if (subject) {
-      commitMessage += StringUtils.capitalize(subject);
+      commitMessage += StringUtils.capitalize(subject.trim());
     }
     if (comments.length > 0) {
-      commitMessage += "\n\n#" + comments.join("\n#");
+      commitMessage += "\n\n#" + comments.map((comment) => comment.trim()).join("\n#");
     }
     return commitMessage;
   }
@@ -248,9 +255,9 @@ class FileLinter {
     }
   }
   /**
-   * Lints files using `lint-staged` with the provided arguments.
+   * Lint files using `lint-staged` with the provided arguments.
    *
-   * @param args - An array of arguments to pass to `lint-staged`.
+   * @param args An array of arguments to pass to `lint-staged`.
    * @returns The exit status of the `lint-staged` command.
    */
   static lintStaged(args) {
@@ -343,9 +350,9 @@ class FileLinter {
     return results;
   }
   /**
-   * Lints files matching the provided patterns using ESLint and Prettier.
+   * Lint files matching the provided patterns using ESLint and Prettier.
    *
-   * @param patterns - An array of glob patterns to match files against. Defaults to ['**'] which matches all files.
+   * @param patterns An array of glob patterns to match files against. Defaults to ['**'] which matches all files.
    * @returns A promise that resolves to a LintFilesResult indicating the success or failure of the linting process.
    */
   async lint(patterns = ["**"]) {