@frsource/release-it-config 1.1.0 → 1.3.0

package/README.md

@@ -0,0 +1,3 @@
+# @frsource/release-it-config
+
+Release-it configuration files used across the FRSOURCE organization.

package/{version-plugin.mjs → cross-deps-version-plugin.mjs}

@@ -1,10 +1,10 @@
-import { Plugin } from "release-it";
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-import { tmpdir, EOL } from "node:os";
+import { Plugin } from 'release-it';
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { tmpdir, EOL } from 'node:os';
 
-const VERSION_BUMP_INFO_PATH = join(tmpdir(), "FRSOURCE_VERSION_BUMP");
-const docs = "https://git.io/release-it-git";
+const VERSION_BUMP_INFO_PATH = join(tmpdir(), 'FRSOURCE_VERSION_BUMP');
+const docs = 'https://git.io/release-it-git';
 
 const toUnique = (array) => [...new Set(array)];
 const flattenDependencies = (infoObj, result = []) => {
@@ -18,20 +18,20 @@ const flattenDependencies = (infoObj, result = []) => {
 };
 const e = (message, docs, fail = true) => {
   const error = new Error(
-    docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message
+    docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message,
   );
   error.code = fail ? 1 : 0;
   return error;
 };
 
-export default class FRSVersionPlugin extends Plugin {
+export default class CrossDepsVersionPlugin extends Plugin {
   async getLatestVersion() {
-    this.log.log("Reading version file from:", VERSION_BUMP_INFO_PATH);
+    this.log.log('Reading version file from:', VERSION_BUMP_INFO_PATH);
     const gitOptions = this.config.getContext()?.git ?? {};
 
     const shouldBeIncremented = await this.shouldBeIncremented();
     const commitsSinceLatestTag = await this.getCommitsSinceLatestTag(
-      gitOptions.commitsPath
+      gitOptions.commitsPath,
     );
 
     // check commit requirement only when package doesn't need to be bumped because of workspace cross-dependencies
@@ -39,7 +39,7 @@ export default class FRSVersionPlugin extends Plugin {
       throw e(
         `There are no commits since the latest tag.`,
         docs,
-        gitOptions.requireCommitsFail
+        gitOptions.requireCommitsFail,
       );
     }
   }
@@ -47,10 +47,8 @@ export default class FRSVersionPlugin extends Plugin {
   afterRelease() {
     writeFileSync(
       VERSION_BUMP_INFO_PATH,
-      `${this.config.getContext("name")}\n`,
-      {
-        flag: "as",
-      }
+      `${this.config.getContext('name')}\n`,
+      { flag: 'as' },
     );
   }
 
@@ -61,14 +59,14 @@ export default class FRSVersionPlugin extends Plugin {
     this.debug({ recentlyBumpedPackages, workspaceDependencies });
 
     return workspaceDependencies.some((depName) =>
-      recentlyBumpedPackages.includes(depName)
+      recentlyBumpedPackages.includes(depName),
     );
   }
 
   async getWorkspaceDependencies() {
     const packageInfoRaw = await this.exec(
-      "pnpm list --only-projects --depth Infinity --json -P",
-      { options: { write: false } }
+      'pnpm list --only-projects --depth Infinity --json -P',
+      { options: { write: false } },
     );
     const packageInfo = toUnique(JSON.parse(packageInfoRaw));
     return flattenDependencies(packageInfo?.[0]);
@@ -77,16 +75,16 @@ export default class FRSVersionPlugin extends Plugin {
   getRecentlyBumpedPackages() {
     if (!existsSync(VERSION_BUMP_INFO_PATH)) return [];
     return toUnique(
-      readFileSync(VERSION_BUMP_INFO_PATH, "utf-8")
-        .split("\n")
+      readFileSync(VERSION_BUMP_INFO_PATH, 'utf-8')
+        .split('\n')
         .slice(1)
-        .filter(Boolean)
+        .filter(Boolean),
     );
   }
 
-  async getCommitsSinceLatestTag(commitsPath = "") {
+  async getCommitsSinceLatestTag(commitsPath = '') {
     const { latestTag } = this.config.getContext();
-    const ref = latestTag ? `${latestTag}..HEAD` : "HEAD";
+    const ref = latestTag ? `${latestTag}..HEAD` : 'HEAD';
     return this.exec(`git rev-list ${ref} --count ${commitsPath}`, {
       options: { write: false },
     }).then(Number);

package/index.cjs

@@ -1,3 +1,5 @@
+const monorepoIndependent = require('./monorepoIndependent.cjs');
+
 module.exports = {
-  monorepoIndependent: require("./monorepoIndependent.cjs"),
+  monorepoIndependent,
 };

package/index.d.cts

@@ -0,0 +1,2 @@
+export { monorepoIndependent };
+import monorepoIndependent = require("./monorepoIndependent.cjs");

package/monorepoIndependent.cjs

@@ -1,39 +1,29 @@
-const path = require("path");
-
 /**
  * Configuration for independent package in monorepo workspace
  * @param {Object} options
  * @param {string} options.pkgName name of the package in the monorepo, e.g. `@frsource/my-package`
- * @param {string} [options.path=`packages/${options.pkgName}`] path of the package relative to the monorepo root, without starting slash. Always use "/" as delimiter. Will default to `packages/${options.pkgName}` (package scope in `options.pkgName` will be omitted)
  * @param {string} [options.buildCmd="pnpm build"] command that should be used to build the package, defaults to `pnpm build`
+ * @param {string} [options.pluginsPath=""] (for internal usage only)
  */
 module.exports = ({
   pkgName,
-  path: pkgPath = `packages/${pkgName.substring(pkgName.lastIndexOf("/") + 1)}`,
-  buildCmd = "pnpm build",
-  /**
-   * @private (for internal usage)
-   */
-  pluginsPath = "@frsource/release-it-config",
+  buildCmd = 'pnpm build',
+  pluginsPath = '@frsource/release-it-config',
 }) => {
-  if (pkgPath.startsWith("/")) pkgPath = pkgPath.substring(1);
-  const nestingLevel = pkgPath.split("/").length;
-  if (path.sep !== "/") pkgPath = pkgPath.replaceAll("/", path.sep);
-
   return {
     npm: {
-      publishPath: "*.tgz",
+      publishPath: '*.tgz',
       publish: true,
     },
     git: {
-      requireBranch: "main",
+      requireBranch: 'main',
       requireCommits: false,
       requireCommitsFail: false, // if there are no new commits release-it will stop the release process, but without throwing and error
       requireCleanWorkingDir: true,
-      commitsPath: ".",
-      commitMessage: "chore(release): ${npm.name} v${version}",
-      tagName: "${npm.name}-v${version}",
-      tagMatch: "${npm.name}-v[0-9]*.[0-9]*.[0-9]*",
+      commitsPath: '.',
+      commitMessage: 'chore(release): ${npm.name} v${version}',
+      tagName: '${npm.name}-v${version}',
+      tagMatch: '${npm.name}-v[0-9]*.[0-9]*.[0-9]*',
       getLatestTagFromAllRefs: false, // https://github.com/release-it/release-it/blob/main/docs/git.md#use-all-refs-to-determine-latest-tag
     },
     github: {
@@ -43,28 +33,24 @@ module.exports = ({
         submit: false, // hitting the secondary rate limit issues, see:
         // https://github.com/FRSOURCE/toolkit/actions/runs/8730568392/job/23954615077#step:8:38
         issue:
-          ":rocket: _This issue has been resolved in [${releaseName} (click for release notes)](${releaseUrl})._",
-        pr: ":rocket: _This pull request is included in [${releaseName} (click for release notes)](${releaseUrl})._",
+          ':rocket: _This issue has been resolved in [${releaseName} (click for release notes)](${releaseUrl})._',
+        pr: ':rocket: _This pull request is included in [${releaseName} (click for release notes)](${releaseUrl})._',
       },
     },
     plugins: {
-      "@release-it/conventional-changelog": {
+      '@release-it/conventional-changelog': {
         gitRawCommitsOpts: {
-          path: ".",
+          path: '.',
         },
-        preset: "angular",
-        infile: "CHANGELOG.md",
+        preset: 'angular',
+        infile: 'CHANGELOG.md',
       },
-      [`${pluginsPath}/version-plugin.mjs`]: {},
+      [`${pluginsPath}/cross-deps-version-plugin.mjs`]: {},
     },
     hooks: {
-      "before:bump": buildCmd,
-      "after:bump": [
-        "pnpm install",
-        `git add ${"../".repeat(nestingLevel)}pnpm-lock.yaml`,
-      ],
-      "before:npm:release": "pnpm pack",
-      "after:npm:release": "rm *.tgz",
+      'before:bump': buildCmd,
+      'before:npm:release': 'pnpm pack',
+      'after:npm:release': 'rm *.tgz',
     },
   };
 };

package/monorepoIndependent.d.cts

@@ -0,0 +1,56 @@
+declare function _exports({ pkgName, buildCmd, pluginsPath, }: {
+    pkgName: string;
+    buildCmd?: string;
+    pluginsPath?: string;
+}): {
+    npm: {
+        publishPath: string;
+        publish: boolean;
+    };
+    git: {
+        requireBranch: string;
+        requireCommits: boolean;
+        requireCommitsFail: boolean;
+        requireCleanWorkingDir: boolean;
+        commitsPath: string;
+        commitMessage: string;
+        tagName: string;
+        tagMatch: string;
+        getLatestTagFromAllRefs: boolean;
+    };
+    github: {
+        release: boolean;
+        releaseName: string;
+        comments: {
+            submit: boolean;
+            issue: string;
+            pr: string;
+        };
+    };
+    plugins: {
+        [x: string]: {
+            gitRawCommitsOpts: {
+                path: string;
+            };
+            preset: string;
+            infile: string;
+        } | {
+            gitRawCommitsOpts?: undefined;
+            preset?: undefined;
+            infile?: undefined;
+        };
+        '@release-it/conventional-changelog': {
+            gitRawCommitsOpts: {
+                path: string;
+            };
+            preset: string;
+            infile: string;
+        };
+    };
+    hooks: {
+        'before:bump': string;
+        'before:npm:release': string;
+        'after:npm:release': string;
+    };
+};
+export = _exports;

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@frsource/release-it-config",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "main": "index.cjs",
+  "types": "index.d.cts",
   "type": "module",
   "dependencies": {
     "@release-it/conventional-changelog": "^8.0.1"
   },
   "devDependencies": {
-    "release-it": "^17.2.0"
+    "globals": "^15.0.0",
+    "release-it": "^17.2.0",
+    "typescript": "^5.4.5",
+    "@frsource/eslint-config": "1.2.0",
+    "@frsource/prettier-config": "1.2.0"
   },
   "peerDependencies": {
     "release-it": ">= 17"
@@ -31,7 +36,13 @@
     "release-it",
     "release-it config"
   ],
+  "funding": "https://buymeacoffee.com/frsource",
   "scripts": {
-    "release": "release-it"
+    "build": "tsc index.cjs --declaration --emitDeclarationOnly --allowJs --moduleResolution bundler --target esnext",
+    "release": "release-it",
+    "eslint": "eslint .",
+    "prettier": "prettier . --check",
+    "lint": "pnpm eslint && pnpm prettier",
+    "fix": "pnpm eslint --fix && prettier . --write"
   }
 }

package/version-file-plugin.mjs

@@ -0,0 +1,43 @@
+import { Plugin } from 'release-it';
+import fs from 'node:fs';
+import path from 'node:path';
+import { EOL } from 'node:os';
+
+// based on https://github.com/release-it/release-it/blob/679bd0e2480d2e04aea4f8d5ecc00183dbd60c05/docs/recipes/my-version.md
+
+const e = (message, docs, fail = true) => {
+  const error = new Error(
+    docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message,
+  );
+  error.code = fail ? 1 : 0;
+  return error;
+};
+
+class VersionFilePlugin extends Plugin {
+  constructor(...args) {
+    super(...args);
+    this.setContext({ versionFile: path.resolve('./VERSION') });
+  }
+  static isEnabled() {
+    try {
+      fs.accessSync(this.getContext('versionFile'));
+      return true;
+    } catch {
+      throw e('Skipping release: VERSION file not present.', false);
+    }
+  }
+  init() {
+    const data = fs.readFileSync(this.getContext('versionFile'));
+    const latestVersion = data.toString().trim();
+    this.setContext({ latestVersion });
+  }
+  getLatestVersion() {
+    return this.getContext('latestVersion');
+  }
+  bump(version) {
+    this.setContext({ version });
+    fs.unlinkSync(this.getContext('versionFile'));
+  }
+}
+
+export default VersionFilePlugin;

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-
-
-# [1.1.0](https://github.com/FRSOURCE/toolkit/compare/@frsource/release-it-config-v1.0.2...${npm.name}-v1.1.0) (2024-04-19)
-
-
-### Features
-
-* **release-it-config:** fix and test the feature release ([991ed9f](https://github.com/FRSOURCE/toolkit/commit/991ed9f2c8a0bbbd23057c6353b6890a0be8929b))
-
-## [1.0.2](https://github.com/FRSOURCE/toolkit/compare/@frsource/release-it-config-v1.0.1...${npm.name}-v1.0.2) (2024-04-19)
-
-## [1.0.1](https://github.com/FRSOURCE/toolkit/compare/@frsource/release-it-config-v1.0.0...${npm.name}-v1.0.1) (2024-04-18)
-
-# 1.0.0 (2024-04-18)