@cluerise/tools 4.2.2 → 5.0.1

package/README.md

@@ -25,7 +25,7 @@ cluerise-tools lint [all | fix | staged | commit]
 ### Release
 
 ```sh
-cluerise-tools release [create | extract-changelog]
+cluerise-tools release [create | info]
 ```
 
 ### Update Node.js versions

package/dist/configs/.nvmrc

@@ -1 +1 @@
-v24.2.0
+v24.3.0

package/dist/configs/.prettierignore

@@ -18,6 +18,12 @@ worker-configuration.d.ts
 # Dependencies
 node_modules/
 
+# .env, .envrc
+.env
+.env.*
+.envrc
+.envrc.*
+
 # Git
 .git/
 
@@ -35,12 +41,6 @@ yarn.lock
 etc/
 .DS_Store
 
-# Sample of .env file
-.env.example
-.env.sample
-.envrc.example
-.envrc.sample
-
 # Stryker
 .stryker-tmp/
 

package/dist/configs/_gitignore

@@ -9,7 +9,8 @@ dist/
 node_modules/
 
 # .env, .envrc
-.env
+.env.local
+.env.*.local
 .envrc
 
 # Lint Staged

package/dist/configs/eslint.config.js

@@ -285,6 +285,12 @@ export default defineConfig([
       // Dependencies
       '**/node_modules/',
 
+      // .env, .envrc
+      '**/.env',
+      '**/.env.*',
+      '**/.envrc',
+      '**/.envrc.*',
+
       // Fonts
       '**/*.ttf',
       '**/*.woff2',
@@ -322,12 +328,6 @@ export default defineConfig([
       '**/etc/',
       '**/.DS_Store',
 
-      // Sample of .env and .envrc files
-      '**/.env.example',
-      '**/.env.sample',
-      '**/.envrc.example',
-      '**/.envrc.sample',
-
       // Stryker
       '**/.stryker-tmp/',
 

package/dist/configs/release.config.js

@@ -37,12 +37,14 @@ export const createReleaseConfig = ({
   owner,
   repository,
   path = '',
+  tagFormat,
   releaseRules = defaultReleaseRules,
   changelogTypes = defaultChangelogTypes
 }) => ({
   extends: [Path.join(import.meta.dirname, 'release-cwd.config.cjs')],
   branches: ['main'],
   repositoryUrl: getRepositoryUrl(path),
+  tagFormat,
   preset: 'conventionalcommits',
   dryRun: true,
 

package/dist/scripts/check-heroku-node-version/main.js

@@ -9,19 +9,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];
@@ -48,6 +48,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);
@@ -60,21 +67,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;
@@ -111,9 +138,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) {
@@ -125,7 +154,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";
@@ -165,7 +194,7 @@ const herokuNodeReleasesSchema = z.object({
 class Heroku {
   static #nodeReleasesUrl = "https://raw.githubusercontent.com/heroku/heroku-buildpack-nodejs/latest/inventory/node.toml";
   /**
-   * Fetches supported Node.js releases on Heroku.
+   * Fetch supported Node.js releases on Heroku.
    *
    * @returns A promise that resolves to an array of HerokuNodeRelease objects.
    */

package/dist/scripts/create-commit-message/main.js

@@ -31,10 +31,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;
@@ -46,17 +48,21 @@ class StringUtils {
 }
 class Git {
   /**
-   * Returns the current branch name of the git repository.
+   * Get the name of the current branch in the git repository.
+   *
+   * Uses `git symbolic-ref --short HEAD` to determine the branch name.
    *
-   * @returns The name of the current branch.
+   * @returns The current branch name.
    */
   static getBranchName() {
     return ChildProcess.execSync("git symbolic-ref --short HEAD").toString().trim();
   }
   /**
-   * Checks if the repository is currently in a rebase state.
+   * Check if the repository is currently in a rebase state.
    *
-   * @returns True if the repository is rebasing, false otherwise.
+   * Checks for the presence of a rebase directory in the git directory.
+   *
+   * @returns True if rebasing, otherwise false.
    */
   static isRebasing() {
     try {
@@ -73,7 +79,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.
    */
@@ -82,9 +88,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) {
@@ -109,9 +115,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.
    */
@@ -128,12 +134,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})` : ""}`;
@@ -145,9 +152,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) {
@@ -158,20 +165,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;
   }

package/dist/scripts/format-commit-message/main.js

@@ -31,10 +31,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;
@@ -50,7 +52,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.
    */
@@ -59,9 +61,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) {
@@ -86,9 +88,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.
    */
@@ -105,12 +107,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})` : ""}`;
@@ -122,9 +125,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) {
@@ -135,20 +138,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;
   }

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 = ["**"]) {

package/dist/scripts/release/main.js

@@ -9,6 +9,31 @@ import "@commitlint/load";
 import { ESLint } from "eslint";
 import { glob } from "glob";
 import * as Prettier from "prettier";
+const gitProviderOrigins = {
+  github: "https://github.com"
+};
+class GitProvider {
+  static #origins = gitProviderOrigins;
+  static #names = Object.keys(this.#origins);
+  /**
+   * Check if the provided name is a valid Git provider name.
+   *
+   * @param name The name to check.
+   * @returns True if the name is valid, otherwise false.
+   */
+  static isValidName(name) {
+    return this.#names.includes(name);
+  }
+  /**
+   * Get the origin URL for the given Git provider name.
+   *
+   * @param name The Git provider name.
+   * @returns The origin URL.
+   */
+  static getOrigin(name) {
+    return this.#origins[name];
+  }
+}
 const enginesSchema = z.object({
   node: z.string()
 });
@@ -18,13 +43,131 @@ const repositoryObjectSchema = z.object({
   directory: z.ostring()
 });
 const repositorySchema = z.union([z.string(), repositoryObjectSchema]);
-z.object({
+const packageJsonDataSchema = z.object({
   name: z.string(),
   version: z.string(),
   description: z.string(),
   engines: enginesSchema.optional(),
   repository: repositorySchema.optional()
 });
+class PackageJson {
+  #data;
+  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);
+    const parseResult = packageJsonDataSchema.safeParse(data);
+    if (!parseResult.success) {
+      throw new Error("Invalid package.json", {
+        cause: parseResult.error
+      });
+    }
+    return new PackageJson(data);
+  }
+  /**
+   * 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;
+  }
+  /**
+   * Set the engines field in `package.json`.
+   *
+   * @param engines The engines object to set.
+   */
+  set engines(engines) {
+    this.#data.engines = engines;
+  }
+  /**
+   * Get the repository field from `package.json`, if present.
+   *
+   * @returns The repository object or string, or undefined.
+   */
+  get repository() {
+    return this.#data.repository;
+  }
+  #parseGitRepository(urlString) {
+    if (!urlString) {
+      return null;
+    }
+    const urlValue = urlString.includes(":") ? urlString : `https://${urlString}`;
+    const url = new URL(urlValue);
+    const scheme = url.protocol.slice(0, -1);
+    if (GitProvider.isValidName(scheme)) {
+      const [owner, repositoryName] = url.pathname.split("/");
+      if (!owner || !repositoryName) {
+        throw new Error("Unknown owner or repositoryName");
+      }
+      return {
+        origin: GitProvider.getOrigin(scheme),
+        owner,
+        repositoryName
+      };
+    }
+    if (scheme === "https") {
+      const [, owner, repositoryName] = url.pathname.split("/");
+      if (!owner || !repositoryName) {
+        throw new Error("Unknown owner or repositoryName");
+      }
+      return {
+        origin: url.origin,
+        owner,
+        repositoryName: repositoryName.endsWith(".git") ? repositoryName.slice(0, -4) : repositoryName
+      };
+    }
+    throw new Error("Unsupported repository URL");
+  }
+  /**
+   * 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 not available.
+   */
+  parseGitRepository() {
+    if (!this.repository) {
+      return null;
+    }
+    if (typeof this.repository === "string") {
+      return this.#parseGitRepository(this.repository);
+    }
+    return this.#parseGitRepository(this.repository.url);
+  }
+  /**
+   * Save the current `package.json` data to disk, formatting it as prettified JSON.
+   */
+  async save() {
+    const content = JsonUtils.prettify(this.#data) + "\n";
+    await FileSystem.writeFile("package.json", content, { encoding: "utf8" });
+  }
+}
 const runMain = (main2) => {
   Promise.resolve().then(() => main2(process.argv.slice(2))).then((exitCode) => {
     process.exit(exitCode);
@@ -33,6 +176,17 @@ const runMain = (main2) => {
     process.exit(1);
   });
 };
+class JsonUtils {
+  static stringify(value) {
+    return JSON.stringify(value);
+  }
+  static prettify(value) {
+    return JSON.stringify(value, null, 2);
+  }
+  static parse(value) {
+    return JSON.parse(value);
+  }
+}
 class FileLinter {
   #options;
   #eslint;
@@ -50,9 +204,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) {
@@ -145,9 +299,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 = ["**"]) {
@@ -175,13 +329,9 @@ class Releaser {
     this.#changelogPath = changelogPath;
   }
   /**
-   * Initializes a new instance of the Releaser class with the provided configuration.
-   *
-   * The configuration is loaded from a specified file path, and the changelog path is set.
+   * Initialize a new instance of the Releaser class with the provided configuration.
    *
-   * @param options - Options for initializing the releaser, including paths for the config and changelog.
-   * @param options.configPath - The path to the semantic-release configuration file. Defaults to 'release.config.js'.
-   * @param options.changelogPath - The path to the changelog file. Defaults to 'CHANGELOG.md'.
+   * @param options Options for initializing the releaser, including paths for the config and changelog.
    * @returns A new instance of Releaser.
    */
   static async init({
@@ -193,7 +343,7 @@ class Releaser {
     return new Releaser(config, changelogPath);
   }
   /**
-   * Creates a new release based on the semantic-release configuration.
+   * Create a new release based on the semantic-release configuration.
    *
    * It updates the changelog with the new release notes and runs linting on the changelog file.
    *
@@ -212,15 +362,38 @@ class Releaser {
     const linter = new FileLinter({ fix: true });
     await linter.lint([this.#changelogPath]);
     ChildProcess.execFileSync("pnpm", ["version", nextRelease.version, "--no-git-tag-version"]);
-    return nextRelease;
+    const packageJson = await PackageJson.init();
+    return {
+      name: packageJson.name,
+      tag: nextRelease.gitTag,
+      type: nextRelease.type,
+      versions: {
+        from: lastRelease.version,
+        to: nextRelease.version
+      }
+    };
   }
   /**
-   * Extracts the latest release changelog from the changelog file.
+   * Get the latest release information.
    *
-   * @returns The content of the latest release changelog.
+   * @returns The latest release information including name, version, tag, and changelog.
    * @throws If no release is found or if the header is not found in the changelog.
    */
-  async extractLatestReleaseChangelog() {
+  async getLatestReleaseInfo() {
+    const packageJson = await PackageJson.init();
+    const tagFormat = this.#config.tagFormat ?? "v${version}";
+    const tag = tagFormat.replace("${version}", packageJson.version);
+    const latestBranch = tagFormat.replace("v${version}", "latest");
+    const changelog = await this.#getLatestReleaseChangelog();
+    return {
+      name: packageJson.name,
+      version: packageJson.version,
+      tag,
+      latestBranch,
+      changelog
+    };
+  }
+  async #getLatestReleaseChangelog() {
     const contentBuffer = await FileSystem.readFile(this.#changelogPath);
     const content = contentBuffer.toString();
     const [, latestReleaseChangelog] = content.split(Releaser.#releaseSeparator);
@@ -258,7 +431,7 @@ class Releaser {
 ${lastReleaseTitle}`);
   }
 }
-const commandNameArgSchema = z.union([z.literal("create"), z.literal("extract-changelog")]);
+const commandNameArgSchema = z.union([z.literal("create"), z.literal("info")]);
 const parseReleaseArgs = ([commandArg]) => {
   const command = commandNameArgSchema.parse(commandArg);
   return {
@@ -269,23 +442,31 @@ const main = async (args) => {
   try {
     const { command } = parseReleaseArgs(args);
     const releaser = await Releaser.init();
-    if (command === "create") {
-      const release = await releaser.createRelease();
-      if (!release) {
+    switch (command) {
+      case "create": {
+        const release = await releaser.createRelease();
+        if (!release) {
+          return 0;
+        }
+        if (process.env.GITHUB_ACTIONS === "true") {
+          ActionsCore.setOutput("release", release);
+          ActionsCore.setOutput(`release.${release.name}`, release);
+        } else {
+          console.log(JsonUtils.prettify(release));
+        }
         return 0;
       }
-      if (process.env.GITHUB_ACTIONS === "true") {
-        ActionsCore.setOutput("version", release.version);
-      }
-    } else if (command === "extract-changelog") {
-      const changelog = await releaser.extractLatestReleaseChangelog();
-      if (process.env.GITHUB_ACTIONS === "true") {
-        ActionsCore.setOutput("changelog", changelog);
-      } else {
-        console.log(changelog);
+      case "info": {
+        const info = await releaser.getLatestReleaseInfo();
+        if (process.env.GITHUB_ACTIONS === "true") {
+          ActionsCore.setOutput("info", info);
+          ActionsCore.setOutput(`info.${info.name}`, info);
+        } else {
+          console.log(JsonUtils.prettify(info));
+        }
+        return 0;
       }
     }
-    return 0;
   } catch (error) {
     if (error instanceof ZodError) {
       const firstIssue = error.issues[0];

package/dist/scripts/update-node-versions/main.js

@@ -9,19 +9,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];
@@ -48,6 +48,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);
@@ -60,21 +67,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;
@@ -111,9 +138,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) {
@@ -125,7 +154,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";
@@ -176,7 +205,7 @@ const nodeJsReleaseSchema = z.object({
 class NodeJs {
   static #releasesUrl = "https://nodejs.org/dist/index.json";
   /**
-   * Fetches all Node.js releases.
+   * Fetch all Node.js releases.
    *
    * @returns A promise that resolves to an array of NodeJsRelease objects.
    */
@@ -186,7 +215,7 @@ class NodeJs {
     return z.array(nodeJsReleaseSchema).parse(data);
   }
   /**
-   * Fetches the latest Node.js release.
+   * Fetch the latest Node.js release.
    *
    * @returns A promise that resolves to the latest NodeJsRelease object or null if no releases are found.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cluerise/tools",
-  "version": "4.2.2",
+  "version": "5.0.1",
   "description": "Tools for maintaining TypeScript projects.",
   "author": "Branislav Holý <brano@holy.am>",
   "repository": "github:cluerise/tools",
@@ -31,7 +31,7 @@
     "conventional-changelog-conventionalcommits": "9.0.0",
     "eslint": "9.29.0",
     "eslint-config-prettier": "10.1.5",
-    "eslint-import-resolver-typescript": "4.4.3",
+    "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-prettier": "5.5.1",
     "eslint-plugin-simple-import-sort": "12.1.1",
@@ -41,7 +41,7 @@
     "globals": "16.2.0",
     "lint-staged": "16.1.2",
     "prettier": "3.6.1",
-    "prettier-plugin-sh": "0.17.4",
+    "prettier-plugin-sh": "0.18.0",
     "semantic-release": "24.2.5",
     "semver": "7.7.2",
     "smol-toml": "1.3.4",