test: add package compatibility tests using publint

.github/workflows/prbot.yml

@@ -70,6 +70,14 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
       - uses: ./.github/actions/setup
       - run: npm test
+  package-compatibility:
+    name: 'Verify compatibility of packages'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - uses: ./.github/actions/setup
+      - run: npm run package-compatibility
   e2e-atomic-csp-test:
     name: 'Run e2e tests on Atomic CSP'
     needs: build

package.json

@@ -11,6 +11,7 @@
     "e2e": "nx run-many --target=e2e",
     "lint:check": "eslint . && cspell **/*.md --no-progress --show-suggestions --show-context && prettier --check '**/*.{css,pcss,html,md,yml,ts,tsx,js,mjs,json}'",
     "lint:fix": "eslint --fix . && prettier --write '**/*.{css,pcss,html,md,yml,ts,tsx,js,mjs,json}'",
+    "package-compatibility": "node ./scripts/ci/package-compatibility.mjs",
     "pr:report": "node ./scripts/reports/pr-report.mjs",
     "report:bundle-size:time-series": "node ./scripts/reports/bundle-size/time-series.mjs",
     "commit": "git-cz",
@@ -83,6 +84,7 @@
     "patch-package": "8.0.0",
     "prettier": "3.3.3",
     "prettier-plugin-tailwindcss": "0.6.5",
+    "publint": "0.2.11",
     "react-syntax-highlighter": "15.5.0",
     "rimraf": "5.0.9",
     "semver": "7.6.3",

scripts/ci/package-compatibility.mjs

@@ -0,0 +1,73 @@
+import {EOL} from 'os';
+import {publint} from 'publint';
+
+let exitCode = 0;
+
+const pkgDirs = [
+  'packages/atomic',
+  'packages/headless',
+  'packages/atomic-react',
+];
+
+const issues = await Promise.all(
+  pkgDirs.map(async (pkgDir) => {
+    const {messages} = await publint({
+      pkgDir,
+      level: 'suggestion',
+      strict: false,
+    });
+
+    const suggestions = [];
+    const warnings = [];
+    const errors = [];
+
+    for (const message of messages) {
+      switch (message.type) {
+        case 'suggestion':
+          suggestions.push(message);
+          break;
+        case 'warning':
+          warnings.push(message);
+          break;
+        case 'error':
+          errors.push(message);
+          break;
+      }
+    }
+
+    return {
+      pkgDir,
+      suggestions,
+      warnings,
+      errors,
+    };
+  })
+);
+
+function prettyPrintJSON(label, jsonObject, logFunction) {
+  logFunction(`${label}:`, EOL);
+  logFunction(JSON.stringify(jsonObject, null, 2), EOL);
+}
+
+if (issues.length > 0) {
+  console.info('The publint scan detected compatibility issues:\n');
+
+  for (const {errors, warnings, suggestions, pkgDir} of issues) {
+    console.group(`\n********** ${pkgDir} **********\n`);
+    if (errors.length > 0) {
+      exitCode = 1;
+      prettyPrintJSON('Errors', errors, console.error);
+    }
+    if (warnings.length > 0) {
+      prettyPrintJSON('Warnings', warnings, console.warn);
+    }
+    if (suggestions.length > 0) {
+      prettyPrintJSON('Suggestions', suggestions, console.info);
+    }
+    console.groupEnd();
+  }
+} else {
+  console.info('No compatibility issues found by publint.');
+}
+
+process.exit(exitCode);