@justeattakeaway/pie-monorepo-utils 0.5.0 → 0.6.0

package/dist/component-statuses.json

@@ -1,6 +1,7 @@
 {
   "pie-assistive-text": "beta",
-  "pie-breadcrumb": "alpha",
+  "pie-avatar": "alpha",
+  "pie-breadcrumb": "beta",
   "pie-button": "stable",
   "pie-card": "beta",
   "pie-checkbox": "beta",
@@ -11,12 +12,13 @@
   "pie-form-label": "alpha",
   "pie-icon-button": "stable",
   "pie-link": "stable",
+  "pie-list": "alpha",
   "pie-lottie-player": "alpha",
   "pie-modal": "stable",
   "pie-notification": "beta",
   "pie-radio": "beta",
   "pie-radio-group": "beta",
-  "pie-select": "alpha",
+  "pie-select": "beta",
   "pie-spinner": "stable",
   "pie-switch": "stable",
   "pie-tag": "beta",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-monorepo-utils",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Scripts and utilities used by the PIE monorepo",
   "repository": {
     "type": "git",
@@ -11,6 +11,9 @@
   "files": [
     "dist"
   ],
+  "bin": {
+    "detect-webc-major-version": "./webc-major-versioning/detect-webc-major-version.js"
+  },
   "scripts": {
     "generate:component-statuses": "node ./component-statuses/generate-component-statuses.js",
     "lint:scripts": "run -T eslint .",
@@ -21,5 +24,9 @@
   },
   "volta": {
     "extends": "../../../package.json"
+  },
+  "dependencies": {
+    "@changesets/parse": "0.4.1",
+    "chalk": "4.1.2"
   }
 }

package/webc-major-versioning/detect-webc-major-version.js

@@ -0,0 +1,153 @@
+#!/usr/bin/env node
+// CLI tool to check for missing major bump in pie-webc after changeset creation
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const parseChangesetFile = require('@changesets/parse').default;
+const { execSync } = require('child_process');
+const findMonorepoRoot = require('../utils/find-monorepo-root');
+const getPackageVersion = require('../utils/get-package-version');
+const getChangesetFilesInCurrentBranch = require('../utils/get-changeset-files-in-current-branch');
+
+const monorepoRoot = findMonorepoRoot();
+
+function getWebcInternalDependencies () {
+    const packageJsonPath = path.join(monorepoRoot, 'packages/components/pie-webc/package.json');
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+    const dependencies = packageJson.dependencies || {};
+    return Object.keys(dependencies).filter((dep) => dep.startsWith('@justeattakeaway/pie-'));
+}
+
+function getWorkspacePackages (monorepoRoot) {
+    try {
+        const output = execSync('yarn workspaces list --json', { encoding: 'utf-8', cwd: monorepoRoot });
+        return output.split('\n').filter(Boolean).map((line) => JSON.parse(line));
+    } catch (err) {
+        // eslint-disable-next-line no-console
+        console.error(chalk.red(err.message));
+        process.exit(1);
+    }
+    return []; // fallback for linting
+}
+
+function getDepVersionAndStatus (depName, workspacePackages) {
+    const dep = workspacePackages.find((pkg) => pkg.name === depName);
+    if (!dep) {
+        // eslint-disable-next-line no-console
+        console.error(chalk.red(`Could not find location for dependency: ${depName}`));
+        process.exit(1);
+    }
+    const depPkgPath = path.join(monorepoRoot, dep.location, 'package.json');
+    try {
+        const version = getPackageVersion(path.join(monorepoRoot, dep.location));
+        const depPkg = JSON.parse(fs.readFileSync(depPkgPath, 'utf-8'));
+        const status = depPkg.pieMetadata && depPkg.pieMetadata.componentStatus;
+        if (!status) {
+            // eslint-disable-next-line no-console
+            console.error(chalk.red(`No componentStatus found in ${depPkgPath}. Unable to determine if pie-webc needs a major bump.`));
+            process.exit(1);
+        }
+        return { version, status };
+    } catch (err) {
+        // eslint-disable-next-line no-console
+        console.error(`Could not read or parse ${depPkgPath}:`, err.message);
+        process.exit(1);
+    }
+    return { version: null, status: null }; // fallback for linting
+}
+
+function printWebcVersioningWarning ({ title, dependencies }) {
+    if (process.env.GITHUB_ACTIONS) {
+        const depsBlock = dependencies.length > 0
+            ? `**Major changes detected in PIE Webc dependencies:**\n${dependencies.map((dep) => `- ${dep}`).join('\n')}\n`
+            : '';
+        const markdown = `
+## :warning: ${title}
+
+${depsBlock}
+You must also add a **major changeset** for \`@justeattakeaway/pie-webc\` detailing the breaking changes, and a migration path for consumers.
+
+**To fix:**
+1. Run \`yarn changeset\` and select \`@justeattakeaway/pie-webc\` for a major bump.
+2. Commit the new changeset file.
+`;
+        console.error(markdown.trim());
+    } else {
+        let depsBlock = '';
+        if (dependencies.length > 0) {
+            depsBlock = `🦋  Major changes detected in PIE Webc dependencies:\n${
+                dependencies.map((dep) => `🦋    - ${dep}`).join('\n')}\n`;
+        }
+        const terminal =
+            `${chalk.red.bold(`🦋  ${title}`)}\n\n${
+            depsBlock
+            }🦋  You must also add a major changeset for ${chalk.bold('@justeattakeaway/pie-webc')
+            } detailing the breaking changes, and a migration path for consumers\n\n` +
+            '🦋  To fix:\n' +
+            `🦋    1. Run ${chalk.cyan('yarn changeset')} and select ${chalk.bold('@justeattakeaway/pie-webc')} for a major bump.\n` +
+            '🦋    2. Commit the new changeset file.\n';
+        console.error(terminal.trim());
+    }
+}
+
+function checkWebcMajorVersioning () {
+    const webcDependencies = getWebcInternalDependencies();
+    const branchChangesetFiles = getChangesetFilesInCurrentBranch(monorepoRoot);
+    const workspacePackages = getWorkspacePackages(monorepoRoot);
+    let hasWebcMajorBump = false;
+    const webcDependenciesWithMajorBump = [];
+    const pieWebcMajorBumpChangesetFiles = [];
+
+    branchChangesetFiles.forEach((file) => {
+        try {
+            const content = fs.readFileSync(file, 'utf-8');
+            const { releases } = parseChangesetFile(content);
+            releases.forEach(({ name, type }) => {
+                if (name === '@justeattakeaway/pie-webc' && type === 'major') {
+                    hasWebcMajorBump = true;
+                    pieWebcMajorBumpChangesetFiles.push(file);
+                }
+
+                if (webcDependencies.includes(name) && type === 'major') {
+                    const { version, status } = getDepVersionAndStatus(name, workspacePackages);
+
+                    /* Ignore component status promotion.
+                       0.x.x -> 1.x.x is a major bump, but we don't want to require a major bump for pie-webc if the dependency is only being promoted from beta to stable.
+                       0.x.x with 'stable' status will only be possible before the 'Version Packages' PR is merged.
+                    */
+                    if (version && version.startsWith('0.') && (status === 'alpha' || status === 'beta' || status === 'stable')) {
+                        return;
+                    }
+                    webcDependenciesWithMajorBump.push(name);
+                }
+            });
+        } catch (e) {
+            // eslint-disable-next-line no-console
+            console.error(chalk.red(`Error parsing changeset file ${file}:`, e.message));
+            process.exit(1);
+        }
+    });
+
+    if (webcDependenciesWithMajorBump.length > 0 && !hasWebcMajorBump) {
+        printWebcVersioningWarning({
+            title: 'PIE Webc Versioning Warning',
+            dependencies: webcDependenciesWithMajorBump,
+        });
+        process.exit(1);
+    }
+
+    if (webcDependenciesWithMajorBump.length > 0 && hasWebcMajorBump) {
+        // eslint-disable-next-line no-console
+        console.log(chalk.green('🦋  PIE Webc versioning check passed.'));
+        if (pieWebcMajorBumpChangesetFiles.length > 0) {
+            // eslint-disable-next-line no-console
+            console.log(chalk.green('🦋  Major bump for @justeattakeaway/pie-webc found in:'));
+            pieWebcMajorBumpChangesetFiles.forEach((filePath) => {
+                // eslint-disable-next-line no-console
+                console.log(chalk.green(`    - ${filePath}`));
+            });
+        }
+    }
+}
+
+checkWebcMajorVersioning();