aberlaas-release 2.21.1 → 2.22.0

package/lib/ensureCorrectPublishedFiles.js

@@ -0,0 +1,106 @@
+import path from 'node:path';
+import { _, pMap } from 'golgoth';
+import { consoleInfo, firostError, run as firostRun } from 'firost';
+
+export let __;
+
+/**
+ * Ensures that all packages in the release have the correct files that will be published
+ * @param {object} releaseData - The release data containing package information
+ * @param {Array} releaseData.allPackages - Array of all packages to be released
+ * @returns {boolean} True when all packages have been verified
+ */
+export async function ensureCorrectPublishedFiles(releaseData) {
+  const { allPackages } = releaseData;
+  __.consoleInfo('Checking files to publish...');
+  await pMap(allPackages, __.ensureSameFilesPublishedWithYarnOrNpm, {
+    concurrency: 5,
+  });
+  return true;
+}
+
+__ = {
+  async ensureSameFilesPublishedWithYarnOrNpm(packageData) {
+    const packageName = packageData.content.name;
+    const npmFiles = await __.getNpmPublishedFiles(packageData);
+    const yarnFiles = await __.getYarnPublishedFiles(packageData);
+
+    if (_.isEqual(npmFiles, yarnFiles)) {
+      return true;
+    }
+
+    const onlyInNpm = _.difference(npmFiles, yarnFiles);
+    const onlyInYarn = _.difference(yarnFiles, npmFiles);
+    const message = [
+      `[${packageName}] Files published by npm and yarn will be different:\n`,
+    ];
+    if (!_.isEmpty(onlyInNpm)) {
+      message.push('Only in npm:');
+      message.push(' - ' + onlyInNpm.join('\n - '));
+      message.push('');
+    }
+    if (!_.isEmpty(onlyInYarn)) {
+      message.push('Only in yarn:');
+      message.push(' - ' + onlyInYarn.join('\n - '));
+    }
+    message.push('\nPlease check your .files key in package.json');
+    throw firostError(
+      'ABERLAAS_RELEASE_NPM_YARN_DIFFERENT_PUBLISHED_FILES',
+      message.join('\n'),
+    );
+  },
+
+  /**
+   * Gets the list of files that would be published to npm for a given package
+   * @param {object} packageData - Package data object containing filepath and content
+   * @param {string} packageData.filepath - Path to the package.json file
+   * @returns {string[]} Sorted array of file paths that would be published
+   */
+  async getNpmPublishedFiles(packageData) {
+    const packageJsonPath = packageData.filepath;
+    const packageJsonDir = path.dirname(packageJsonPath);
+    const { stdout } = await __.firostRun('npm publish --dry-run --json', {
+      cwd: packageJsonDir,
+      stdout: false,
+      stderr: false,
+    });
+
+    return __.parseNpmPublishOutput(stdout);
+  },
+  parseNpmPublishOutput(stdout) {
+    const parsedOutput = JSON.parse(stdout);
+
+    // Output either contains directly an object with all info, or the object
+    // itself is in a key with the name of the package (in case of workspaces)
+    const keys = _.keys(parsedOutput);
+    const root = keys.length === 1 ? parsedOutput[keys[0]] : parsedOutput;
+
+    return _.chain(root).get('files').map('path').sort().value();
+  },
+  /**
+   * Gets the list of files that would be published to npm for a package using yarn
+   * @param {object} packageData - Package data object containing file information
+   * @param {string} packageData.filepath - Path to the package.json file
+   * @returns {string[]} Sorted array of file paths that would be published
+   */
+  async getYarnPublishedFiles(packageData) {
+    const packageJsonPath = packageData.filepath;
+    const packageJsonDir = path.dirname(packageJsonPath);
+    const { stdout } = await __.firostRun('yarn npm publish --dry-run --json', {
+      cwd: packageJsonDir,
+      stdout: false,
+      stderr: false,
+    });
+
+    return _.chain(stdout)
+      .split('\n')
+      .last()
+      .thru(JSON.parse)
+      .get('files')
+      .sort()
+      .value();
+  },
+
+  consoleInfo,
+  firostRun,
+};

package/lib/main.js

@@ -1,4 +1,5 @@
 import { consoleInfo, run as firostRun } from 'firost';
+import { ensureCorrectPublishedFiles } from './ensureCorrectPublishedFiles.js';
 import { ensureValidSetup } from './ensureValidSetup.js';
 import { getReleaseData } from './getReleaseData.js';
 import { publishToNpm } from './publishToNpm.js';
@@ -15,6 +16,8 @@ export async function run(cliArgs = {}) {
   await __.ensureValidSetup(cliArgs);
 
   const releaseData = await __.getReleaseData(cliArgs);
+  await __.ensureCorrectPublishedFiles(releaseData);
+
   __.consoleInfo(`Release new version ${releaseData.newVersion}`);
 
   await __.updateGitRepo(releaseData);
@@ -24,6 +27,7 @@ export async function run(cliArgs = {}) {
 
 __ = {
   ensureValidSetup,
+  ensureCorrectPublishedFiles,
   getReleaseData,
   publishToNpm,
   updateGitRepo,

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "aberlaas-release",
+  "version": "2.22.0",
   "type": "module",
-  "sideEffects": false,
   "description": "aberlaas release command: Release and publish new versions",
-  "version": "2.21.1",
-  "repository": "pixelastic/aberlaas",
+  "author": "Tim Carry <tim@pixelastic.com>",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
-  "author": "Tim Carry (@pixelastic)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pixelastic/aberlaas"
+  },
+  "sideEffects": false,
   "license": "MIT",
   "files": [
     "lib/*.js"
@@ -15,13 +18,10 @@
     ".": "./lib/main.js"
   },
   "main": "./lib/main.js",
-  "engines": {
-    "node": ">=18.18.0"
-  },
   "dependencies": {
-    "aberlaas-helper": "2.21.1",
-    "aberlaas-lint": "2.21.1",
-    "aberlaas-test": "2.21.1",
+    "aberlaas-helper": "2.22.0",
+    "aberlaas-lint": "2.22.0",
+    "aberlaas-test": "2.22.0",
     "changelogen": "0.6.2",
     "cli-markdown": "3.5.1",
     "envfile": "7.1.0",
@@ -34,13 +34,13 @@
     "build": "cd ../docs && yarn run build",
     "build:prod": "cd ../docs && yarn run build:prod",
     "cms": "cd ../docs && yarn run cms",
-    "serve": "cd ../docs && yarn run serve",
-    "release": "cd ../.. && ./scripts/release",
-    "test:meta": "cd ../.. && ./scripts/test-meta",
-    "test": "cd ../.. && ./scripts/test",
-    "test:watch": "cd ../.. && ./scripts/test-watch",
     "compress": "cd ../.. && ./scripts/compress",
     "lint": "cd ../.. && ./scripts/lint",
-    "lint:fix": "cd ../.. && ./scripts/lint-fix"
+    "lint:fix": "cd ../.. && ./scripts/lint-fix",
+    "release": "cd ../.. && ./scripts/release",
+    "serve": "cd ../docs && yarn run serve",
+    "test": "cd ../.. && ./scripts/test",
+    "test:meta": "cd ../.. && ./scripts/test-meta",
+    "test:watch": "cd ../.. && ./scripts/test-watch"
   }
 }