chore: add Yarn constraints

Author: Saadnajmi

.github/workflows/microsoft-pr.yml

@@ -63,3 +63,19 @@ jobs:
         run: |
           echo "Target branch: ${{ github.base_ref }}"
           yarn nx release --dry-run --verbose
+  yarn-constraints:
+    name: "Check Yarn Constraints"
+    permissions: {}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          filter: blob:none
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      - name: Install dependencies
+        run: yarn
+      - name: Check constraints
+        run: yarn constraints

package.json

@@ -56,6 +56,7 @@
     "@tsconfig/node18": "1.0.1",
     "@types/react": "^18.2.6",
     "@typescript-eslint/parser": "^7.1.1",
+    "@yarnpkg/types": "^4.0.1",
     "ansi-styles": "^4.2.1",
     "babel-plugin-minify-dead-code-elimination": "^0.5.2",
     "babel-plugin-syntax-hermes-parser": "0.23.1",

yarn.config.cjs

@@ -0,0 +1,107 @@
+// @ts-check
+
+/** @type {import('@yarnpkg/types')} */
+const {defineConfig} = require('@yarnpkg/types');
+
+/**
+ * @typedef {import('@yarnpkg/types').Yarn.Constraints.Context} Context
+ * @typedef {import('@yarnpkg/types').Yarn.Constraints.Workspace} Workspace
+ * @typedef {import('@yarnpkg/types').Yarn.Constraints.Dependency} Dependency
+ */
+
+/**
+ * Enforce that react-native-macos declares a peer dependency on react-native on release branches,
+ * except on the main branch, where there is no published version of React Native to align to.
+ * @param {Context} context
+ */
+function expectReactNativePeerDependency({Yarn}) {
+    const rnmWorkspace = Yarn.workspace({ident: 'react-native-macos'});
+    if (!rnmWorkspace) {
+        // Report error on root workspace since react-native-macos doesn't exist
+        Yarn.workspace().error('react-native-macos workspace must exist in the monorepo');
+        return;
+    }
+
+    // Check if react-native-macos version is 1000.0.0 - implying we are on the main branch
+    const isMainBranch = rnmWorkspace.pkg.version === '1000.0.0';
+    if (!isMainBranch) {
+        const rnPeerDependency = rnmWorkspace.pkg.peerDependencies.get('react-native');
+        if (!rnPeerDependency) {
+            rnmWorkspace.error('react-native-macos must declare a peer dependency on react-native on release branches');
+        }
+    }
+}
+
+/**
+ * Enforce that all @react-native/ scoped packages use the same version
+ * as the react-native peer dependency declared in react-native-macos.
+ * On the main branch, enforce that we use workspace:* for @react-native/ packages.
+ * @param {Context} context
+ */
+function enforceReactNativeVersionConsistency({Yarn}) {
+    const rnmWorkspace = Yarn.workspace({ident: 'react-native-macos'});
+    if (!rnmWorkspace) {
+        // Report error on root workspace since react-native-macos doesn't exist
+        Yarn.workspace().error('react-native-macos workspace must exist in the monorepo');
+        return;
+    }
+
+    // Check if react-native-macos version is 1000.0.0 - implying we are on the main branch
+    const isMainBranch = rnmWorkspace.pkg.version === '1000.0.0';
+    
+    let targetVersion;
+    if (isMainBranch) {
+        // On main branch, use workspace:* for @react-native/ packages
+        targetVersion = 'workspace:*';
+    } else {
+        const rnPeerDependency = rnmWorkspace.pkg.peerDependencies.get('react-native');
+        if (!rnPeerDependency) {
+            rnmWorkspace.error('react-native-macos must declare a peer dependency on react-native on release branches');
+            return;
+        }
+        targetVersion = rnPeerDependency;
+    }    // Enforce this version on all @react-native/ scoped packages across all workspaces
+    for (const dependency of Yarn.dependencies()) {
+        if (dependency.ident.startsWith('@react-native/')) {
+            dependency.update(targetVersion);
+        }
+    }
+}
+
+/**
+ * Enforce that all @react-native-macos/ scoped packages use the same version
+ * as react-native-macos, but only for non-private packages.
+ * @param {Context} context
+ */
+function enforceReactNativeMacosVersionConsistency({Yarn}) {
+    const rnmWorkspace = Yarn.workspace({ident: 'react-native-macos'});
+    if (!rnmWorkspace) {
+        // Report error on root workspace since react-native-macos doesn't exist
+        Yarn.workspace().error('react-native-macos workspace must exist in the monorepo');
+        return;
+    }
+
+    const targetVersion = rnmWorkspace.pkg.version;
+    if (!targetVersion) {
+        rnmWorkspace.error('react-native-macos must have a version');
+        return;
+    }
+
+    // Enforce this version on all non-private @react-native-macos/ scoped packages
+    for (const workspace of Yarn.workspaces()) {
+        const isReactNativeMacosScoped = workspace.ident && workspace.ident.startsWith('@react-native-macos/');
+        const isPrivate = workspace.manifest.private;
+        
+        if (isReactNativeMacosScoped && !isPrivate) {
+            workspace.set('version', targetVersion);
+        }
+    }
+}
+
+module.exports = defineConfig({
+  constraints: async ctx => {
+    expectReactNativePeerDependency(ctx);
+    enforceReactNativeVersionConsistency(ctx);
+    enforceReactNativeMacosVersionConsistency(ctx);
+  },
+});

yarn.lock

@@ -3363,6 +3363,7 @@ __metadata:
     "@tsconfig/node18": "npm:1.0.1"
     "@types/react": "npm:^18.2.6"
     "@typescript-eslint/parser": "npm:^7.1.1"
+    "@yarnpkg/types": "npm:^4.0.1"
     ansi-styles: "npm:^4.2.1"
     babel-plugin-minify-dead-code-elimination: "npm:^0.5.2"
     babel-plugin-syntax-hermes-parser: "npm:0.23.1"
@@ -4658,6 +4659,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@yarnpkg/types@npm:^4.0.1":
+  version: 4.0.1
+  resolution: "@yarnpkg/types@npm:4.0.1"
+  dependencies:
+    tslib: "npm:^2.4.0"
+  checksum: 10c0/90226789475680ba599833571dd76c0718dd5b4c5022481263ef309d6a628f6246671cd6ca86e49c966ddefa7aca6ccef82240dc1476d2cea702ea5bee2a6b72
+  languageName: node
+  linkType: hard
+
 "@zkochan/js-yaml@npm:0.0.7":
   version: 0.0.7
   resolution: "@zkochan/js-yaml@npm:0.0.7"