@cluerise/tools 4.2.1 → 5.0.0

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

@@ -50,7 +50,7 @@ export default defineConfig([
   },
   {
     name: 'cluerise: typescript-eslint/disable-type-checked',
-    files: ['**/*.html', '**/*.js', '**/*.json', '**/*.jsonc', '**/*.yaml'],
+    files: ['**/*.html', '**/*.js', '**/*.cjs', '**/*.json', '**/*.jsonc', '**/*.yaml'],
     extends: [typescriptEslint.configs.disableTypeChecked]
   },
   {
@@ -118,7 +118,7 @@ export default defineConfig([
   // Import
   {
     name: 'cluerise: eslint/import/js',
-    files: ['**/*.js'],
+    files: ['**/*.js', '**/*.cjs'],
     extends: [eslintPluginImport.flatConfigs.recommended],
     rules: {
       'import/first': 'error',
@@ -152,16 +152,16 @@ export default defineConfig([
     }
   },
   {
-    name: 'cluerise: eslint/import/rules/config.js',
-    files: ['**/*.config.js'],
+    name: 'cluerise: eslint/import/rules/config.js,cjs',
+    files: ['**/*.config.{js,cjs}'],
     rules: {
       '@typescript-eslint/no-require-imports': 'off',
       'import/no-commonjs': 'off'
     }
   },
   {
-    name: 'cluerise: eslint/import/rules/config.js,ts',
-    files: ['**/*.config.{js,ts}'],
+    name: 'cluerise: eslint/import/rules/config.js,cjs,ts',
+    files: ['**/*.config.{js,cjs,ts}'],
     rules: {
       'import/no-default-export': 'off'
     }
@@ -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-cwd.config.cjs

@@ -0,0 +1,26 @@
+const Path = require('node:path');
+
+const modulesNames = Object.keys(require.cache).filter((path) =>
+  Path.posix.normalize(path).endsWith('/git-log-parser/src/index.js')
+);
+
+for (const moduleName of modulesNames) {
+  const { parse, __patched = false } = require.cache[moduleName].exports;
+  if (__patched) {
+    continue;
+  }
+
+  require.cache[moduleName].exports.__patched = true;
+
+  require.cache[moduleName].exports.parse = (config, options) => {
+    if (Array.isArray(config._)) {
+      config._.push(options.cwd);
+    } else if (config._) {
+      config._ = [config._, options.cwd];
+    } else {
+      config._ = options.cwd;
+    }
+
+    return parse(config, options);
+  };
+}

package/dist/configs/release.config.js

@@ -1,3 +1,6 @@
+import Path from 'node:path';
+import Url from 'node:url';
+
 export const defaultReleaseRules = [
   { breaking: true, release: 'major' },
   { type: 'feat', release: 'minor' },
@@ -24,8 +27,9 @@ export const defaultChangelogTypes = [
 const getRepositoryUrl = (path) => {
   const pathSegments = path.split('/');
   const rootSegments = pathSegments.filter((segments) => segments.trim().length > 0).map(() => '..');
+  const rootPath = Path.join(process.cwd(), ...rootSegments);
 
-  return `file://${process.cwd()}/${rootSegments.join('/')}`;
+  return Url.pathToFileURL(rootPath).href;
 };
 
 export const createReleaseConfig = ({
@@ -33,14 +37,16 @@ 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,
-  commitPath: path,
 
   plugins: [
     [

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;
   }