aberlaas-release 2.20.1 → 2.21.1

package/lib/ensureNpmLogin.js

@@ -3,66 +3,49 @@ import {
   consoleInfo,
   consoleWarn,
   env,
-  firostError,
+  exists,
   prompt,
+  read,
   readJson,
   run,
   sleep,
-  wrap,
   write,
 } from 'firost';
 import { hostGitPath, hostPackagePath } from 'aberlaas-helper';
+import { parse as parseEnvrc, stringify as stringifyEnvrc } from 'envfile';
 
-export const __ = {
-  /**
-   * Ensures the user is logged in to npm by checking authentication status and prompting for login if needed.
-   * @returns {boolean|undefined} Returns true if already logged in, undefined if login was required and completed
-   * @throws {Error} Throws error if npm authentication fails for reasons other than E401 unauthorized
-   */
-  async ensureNpmLogin() {
-    try {
-      await __.npmRun('whoami');
-      return true;
-    } catch (err) {
-      if (err.code == 'ABERLAAS_RELEASE_NPM_ERROR_E401') {
-        await __.waitForNpmLogin();
-        return;
-      }
-      throw err;
-    }
-  },
+export let __;
+
+/**
+ * Ensures the user is logged in to npm by checking authentication status and prompting for login if needed.
+ * @returns {boolean|undefined} Returns true if already logged in, undefined if login was required and completed
+ * @throws {Error} Throws error if npm authentication fails for reasons other than E401 unauthorized
+ */
+export async function ensureNpmLogin() {
+  if (await __.isAuthenticated()) {
+    return true;
+  }
 
+  await __.waitForNpmLogin();
+}
+
+__ = {
+  ensureNpmLogin,
   /**
-   * Executes an npm command and returns its output
-   * @param {string} command - The npm command to execute (without 'npm' prefix)
-   * @returns {string} The stdout output from the npm command
-   * @throws {Error} Throws a formatted error if the npm command fails
+   * Checks if the user is authenticated with npm by running 'yarn npm whoami' command
+   * @returns {Promise<boolean>} Promise that resolves to true if authenticated, false otherwise
    */
-  async npmRun(command) {
+  async isAuthenticated() {
     try {
-      const { stdout } = await __.run(`npm ${command}`, {
-        stdout: false,
+      await __.run('yarn npm whoami', {
         stderr: false,
+        stdout: false,
       });
-      return stdout;
-    } catch ({ stderr }) {
-      const errorLines = _.split(stderr, '\n');
-
-      // Identify known npm errors
-      if (_.startsWith(errorLines[0], 'npm error code')) {
-        const npmErrorCode = _.replace(errorLines[0], 'npm error code ', '');
-        const npmErrorMessage = _.chain(errorLines).slice(1).join('\n').value();
-        throw firostError(
-          `ABERLAAS_RELEASE_NPM_ERROR_${npmErrorCode}`,
-          npmErrorMessage,
-        );
-      }
-
-      // Throw unknown errors up
-      throw firostError('ABERLAAS_RELEASE_NPM_UNKNOWN_ERROR', stderr);
+      return true;
+    } catch (_err) {
+      return false;
     }
   },
-
   /**
    * Prompts the user to create and configure an npm authentication token when not logged in.
    * Opens the npm token creation page in browser, guides user through token setup,
@@ -83,9 +66,8 @@ export const __ = {
    * Displays login instructions to the user
    */
   async displayLoginInstructions() {
-    const rootPackage = await readJson(hostPackagePath('package.json'));
-    const packageName = rootPackage.name;
-    const tokenName = __.generateTokenName(packageName);
+    const packageJson = await readJson(hostPackagePath('package.json'));
+    const tokenName = __.generateTokenName(packageJson);
 
     __.consoleInfo('');
     __.consoleInfo('Your npm token page will open.');
@@ -97,7 +79,7 @@ export const __ = {
     __.consoleInfo('');
     __.consoleInfo('PACKAGE AND SCOPES');
     __.consoleInfo('Permissions: Read and write');
-    __.consoleInfo(`🔘 Only select packages and scopes: ${packageName}`);
+    __.consoleInfo('🔘 All packages');
     __.consoleInfo('');
     __.consoleInfo('EXPIRATION');
     __.consoleInfo('Expiration date: 90 days');
@@ -105,15 +87,25 @@ export const __ = {
   },
 
   /**
-   * Generates a suggested token name from package name
-   * @param {string} packageName - The package name
+   * Generates a suggested token name from package.json data
+   * @param {object} packageJson - The package.json content
    * @returns {string} The suggested token name
    */
-  generateTokenName(packageName) {
+  generateTokenName(packageJson) {
+    let packageName = packageJson.name;
+
+    // For workspace roots (monorepo/libdocs), strip suffixes
+    if (packageJson.workspaces) {
+      packageName = _.chain(packageName)
+        .replace(/-monorepo$/, '')
+        .replace(/-root$/, '')
+        .value();
+    }
+
     const cleanPackageName = _.chain(packageName)
-      .replace('-', '_')
-      .replace('@', '')
-      .replace('/', '_')
+      .replaceAll('-', '_')
+      .replaceAll('@', '')
+      .replaceAll('/', '_')
       .toUpper()
       .value();
     return `ABERLAAS_RELEASE_${cleanPackageName}`;
@@ -151,13 +143,19 @@ export const __ = {
   },
 
   /**
-   * Saves the npm token to .npmrc file
+   * Saves the npm token to .envrc file
    */
   async saveNpmToken() {
+    // TODO: replace with keyleth
+    const envrcPath = hostGitPath('.envrc');
+    const envrcAsJson = (await exists(envrcPath))
+      ? parseEnvrc(await read(envrcPath))
+      : {};
+
     const npmToken = await __.prompt('Enter you new token here:');
-    const npmrcContent = `//registry.npmjs.org/:_authToken=${npmToken}`;
-    const npmrcPath = hostGitPath('.npmrc');
-    await write(npmrcContent, npmrcPath);
+    envrcAsJson.ABERLAAS_RELEASE_NPM_AUTH_TOKEN = npmToken;
+
+    await write(stringifyEnvrc(envrcAsJson), envrcPath);
   },
   run,
   env,
@@ -166,5 +164,3 @@ export const __ = {
   consoleInfo,
   sleep,
 };
-
-export const ensureNpmLogin = wrap(__, 'ensureNpmLogin');

package/lib/ensureValidSetup.js

@@ -4,7 +4,44 @@ import { hostGitRoot, yarnRun } from 'aberlaas-helper';
 import Gilmore from 'gilmore';
 import { ensureNpmLogin } from './ensureNpmLogin.js';
 
-export const __ = {
+export let __;
+
+/**
+ * Validate all pre-conditions before starting the release
+ * @param {object} cliArgs Release options
+ * @param {boolean} [cliArgs.test=true] Run test execution
+ * @param {boolean} [cliArgs.lint=true] Run lint execution
+ * @returns {Promise<void>}
+ */
+export async function ensureValidSetup(cliArgs = {}) {
+  // Default options: test and lint enabled unless explicitly disabled via CLI
+  const options = {
+    test: true,
+    lint: true,
+    ...cliArgs,
+  };
+
+  __.ensureCorrectBumpType(cliArgs);
+
+  const repo = new Gilmore(hostGitRoot());
+
+  // Need to be on branch main
+  await __.ensureCorrectBranch(repo);
+
+  // Need to have a clean directory
+  await __.ensureCleanRepository(repo);
+
+  // Check npm login
+  await __.ensureNpmLogin();
+
+  // Check tests are passing
+  await __.ensureTestsArePassing(options);
+
+  // Check lint is passing
+  await __.ensureLintIsPassing(options);
+}
+
+__ = {
   /**
    * Validates that the provided bump type is one of the accepted semantic
    * versioning types, or empty for auto-detection.
@@ -67,11 +104,12 @@ export const __ = {
 
   /**
    * Ensures that all tests are passing before proceeding with a release
-   * @param {object} cliArgs Release options
+   * @param {object} options Release options
+   * @param {boolean} [options.test=true] Run tests
    * @returns {Promise<void>} A promise that resolves if tests pass, rejects with ABERLAAS_RELEASE_TESTS_FAILING error if tests fail
    */
-  async ensureTestsArePassing(cliArgs = {}) {
-    if (cliArgs['skip-test']) {
+  async ensureTestsArePassing(options = {}) {
+    if (!options.test) {
       return false;
     }
     __.consoleInfo('Running tests...');
@@ -85,12 +123,13 @@ export const __ = {
 
   /**
    * Ensures that linting passes by running the lint process and throwing an error if it fails
-   * @param {object} cliArgs Release options
+   * @param {object} options Release options
+   * @param {boolean} [options.lint=true] Run lint
    * @returns {Promise<void>} A promise that resolves if linting passes
    * @throws {Error} Throws ABERLAAS_RELEASE_LINT_FAILING error if linting fails
    */
-  async ensureLintIsPassing(cliArgs = {}) {
-    if (cliArgs['skip-lint']) {
+  async ensureLintIsPassing(options = {}) {
+    if (!options.lint) {
       return false;
     }
     __.consoleInfo('Running lint...');
@@ -107,31 +146,3 @@ export const __ = {
   firostRun,
   yarnRun,
 };
-
-/**
- * Validate all pre-conditions before starting the release
- * @param {object} cliArgs Release options
- * @param {boolean} cliArgs.skipTest Skip test execution
- * @param {boolean} cliArgs.skipLint Skip lint execution
- * @returns {Promise<void>}
- */
-export async function ensureValidSetup(cliArgs = {}) {
-  __.ensureCorrectBumpType(cliArgs);
-
-  const repo = new Gilmore(hostGitRoot());
-
-  // Need to be on branch main
-  await __.ensureCorrectBranch(repo);
-
-  // Need to have a clean directory
-  await __.ensureCleanRepository(repo);
-
-  // Check npm login
-  await __.ensureNpmLogin();
-
-  // Check tests are passing
-  await __.ensureTestsArePassing(cliArgs);
-
-  // Check lint is passing
-  await __.ensureLintIsPassing(cliArgs);
-}

package/lib/getReleaseData.js

@@ -90,22 +90,27 @@ export const __ = {
 /**
  * Gathers all release information from CLI arguments
  * @param {object} cliArgs - CLI arguments from minimist
- * @returns {object} Release data containing bumpType, allPackages, currentVersion, newVersion, skipChangelog
+ * @returns {object} Release data containing bumpType, allPackages, currentVersion, newVersion, changelog
  */
 export async function getReleaseData(cliArgs) {
+  // Default options: changelog enabled unless explicitly disabled via CLI
+  const options = {
+    changelog: true,
+    ...cliArgs,
+  };
+
   const allPackages = await __.getAllPackagesToRelease();
   const currentVersion = allPackages[0].content.version;
 
   const bumpType = await __.getBumpType(cliArgs, currentVersion);
 
   const newVersion = semver.inc(currentVersion, bumpType);
-  const skipChangelog = !!cliArgs['skip-changelog'];
 
   return {
     bumpType,
     allPackages,
     currentVersion,
     newVersion,
-    skipChangelog,
+    changelog: options.changelog,
   };
 }

package/lib/main.js

@@ -1,8 +1,7 @@
-import path from 'node:path';
-import { pMap } from 'golgoth';
 import { consoleInfo, run as firostRun } from 'firost';
 import { ensureValidSetup } from './ensureValidSetup.js';
 import { getReleaseData } from './getReleaseData.js';
+import { publishToNpm } from './publishToNpm.js';
 import { updateGitRepo } from './updateGitRepo.js';
 
 export let __;
@@ -20,31 +19,14 @@ export async function run(cliArgs = {}) {
 
   await __.updateGitRepo(releaseData);
 
-  await __.publishAllPackagesToNpm(releaseData);
+  await __.publishToNpm(releaseData);
 }
 
 __ = {
-  /**
-   * Publishes all packages to npm
-   * @param {object} releaseData - Release data containing allPackages
-   */
-  async publishAllPackagesToNpm(releaseData) {
-    await pMap(
-      releaseData.allPackages,
-      async ({ filepath, content }) => {
-        const packageName = content.name;
-        __.consoleInfo(`Publishing ${packageName} to npm`);
-
-        const packageDir = path.dirname(filepath);
-        await __.firostRun('npm publish --access public', { cwd: packageDir });
-      },
-      { concurrency: 1 },
-    );
-  },
-
   ensureValidSetup,
-  updateGitRepo,
   getReleaseData,
+  publishToNpm,
+  updateGitRepo,
   consoleInfo,
   firostRun,
 };

package/lib/publishToNpm.js

@@ -0,0 +1,57 @@
+import path from 'node:path';
+import { pMap } from 'golgoth';
+import { firostError, run, spinner } from 'firost';
+
+export let __;
+
+/**
+ * Publishes all packages in the release data to npm with public access
+ * @param {object} releaseData - The release data containing package information
+ * @param {Array<object>} releaseData.allPackages - Array of package objects to publish
+ * @param {string} releaseData.allPackages[].filepath - Path to the package.json file
+ * @param {object} releaseData.allPackages[].content - Package.json content object
+ * @param {string} releaseData.allPackages[].content.name - Name of the package
+ * @returns {Promise<void>} Promise that resolves when all packages are published
+ */
+export async function publishToNpm(releaseData) {
+  const { allPackages, newVersion } = releaseData;
+  const progress = __.spinner(allPackages.length);
+
+  await pMap(
+    allPackages,
+    async (packageData) => {
+      const packageName = packageData.content.name;
+      progress.tick(`Publishing ${packageName}@${newVersion}`);
+
+      await __.publishPackage(packageData);
+    },
+    { concurrency: 5 },
+  );
+  progress.success('All packages published to npm');
+}
+
+__ = {
+  async publishPackage(packageData) {
+    const { filepath, content } = packageData;
+
+    try {
+      // Note:
+      // ✘ npm publish <= Keeps workspace:* in dependencies
+      // ✔ yarn npm publish <= Replaces workspace:* with actual versions
+      await __.run('yarn npm publish --access public', {
+        cwd: path.dirname(filepath),
+        stdout: false,
+        stderr: false,
+      });
+      return true;
+    } catch (err) {
+      const packageName = content.name;
+      throw firostError(
+        'ABERLAAS_RELEASE_NPM_PUBLISH_FAILED',
+        `Failed to publish ${packageName} to npm:\n${err.message}`,
+      );
+    }
+  },
+  run,
+  spinner,
+};

package/lib/updateChangelog.js

@@ -15,7 +15,7 @@ import cliMarkdown from 'cli-markdown';
 export const __ = {
   /**
    * Generate changelog markdown from git commits between two versions
-   * @param {object} releaseData - Release data containing currentVersion, newVersion, and skipChangelog
+   * @param {object} releaseData - Release data containing currentVersion, newVersion, and changeLog
    * @returns {string} Generated changelog markdown
    */
   async generateChangelogFromGit(releaseData) {
@@ -136,10 +136,11 @@ export const __ = {
 
 /**
  * Update the CHANGELOG.md file with new additions
- * @param {object} releaseData - Release data containing currentVersion, newVersion, and skipChangelog
+ * @param {object} releaseData - Release data containing currentVersion, newVersion, and changeLog
+ * @param {boolean} [releaseData.changelog=true] Generate changelog
  */
 export async function updateChangelog(releaseData) {
-  if (releaseData.skipChangelog) {
+  if (!releaseData.changelog) {
     return;
   }
 

package/lib/updateGitRepo.js

@@ -10,10 +10,14 @@ export const __ = {
    * @param {object} releaseData - Release data containing allPackages and newVersion
    */
   async bumpAllPackageVersions(releaseData) {
-    await pMap(releaseData.allPackages, async ({ filepath, content }) => {
+    const { newVersion } = releaseData;
+
+    await pMap(releaseData.allPackages, async (packageData) => {
+      const { filepath, content } = packageData;
       const packageName = content.name;
-      __.consoleInfo(`Updating ${packageName} to ${releaseData.newVersion}`);
-      const newContent = { ...content, version: releaseData.newVersion };
+      __.consoleInfo(`Updating ${packageName} to ${newVersion}`);
+
+      const newContent = { ...content, version: newVersion };
       await writeJson(newContent, filepath, {
         sort: false,
       });

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "sideEffects": false,
   "description": "aberlaas release command: Release and publish new versions",
-  "version": "2.20.1",
+  "version": "2.21.1",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
@@ -19,14 +19,15 @@
     "node": ">=18.18.0"
   },
   "dependencies": {
-    "aberlaas-helper": "workspace:*",
-    "aberlaas-lint": "workspace:*",
-    "aberlaas-test": "workspace:*",
+    "aberlaas-helper": "2.21.1",
+    "aberlaas-lint": "2.21.1",
+    "aberlaas-test": "2.21.1",
     "changelogen": "0.6.2",
     "cli-markdown": "3.5.1",
+    "envfile": "7.1.0",
     "firost": "5.5.1",
     "gilmore": "1.2.0",
-    "golgoth": "3.0.0",
+    "golgoth": "3.1.0",
     "semver": "7.7.3"
   },
   "scripts": {
@@ -42,4 +43,4 @@
     "lint": "cd ../.. && ./scripts/lint",
     "lint:fix": "cd ../.. && ./scripts/lint-fix"
   }
-}
+}