chore(repo): require exports entry

nrwl · Dec 18, 2024 · cc6251a · cc6251a
1 parent 6bf9063
commit cc6251a
Show file tree

Hide file tree

Showing 3 changed files with 86 additions and 11 deletions.
diff --git a/nx.json b/nx.json
@@ -251,7 +251,38 @@
   "conformance": {
     "rules": [
       {
-        "rule": "@nx/workspace-plugin/conformance-rules/project-package-json"
+        "rule": "@nx/workspace-plugin/conformance-rules/project-package-json",
+        "projects": [
+          "!.",
+          "!create-nx-*",
+          "!cypress",
+          "!detox",
+          "!devkit",
+          "!esbuild",
+          "!eslint-plugin",
+          "!eslint",
+          "!expo",
+          "!express",
+          "!jest",
+          "!js",
+          "!module-federation",
+          "!nest",
+          "!next",
+          "!node",
+          "!nuxt",
+          "!packages/nx/**",
+          "!plugin",
+          "!react-native",
+          "!react",
+          "!rollup",
+          "!rsbuild",
+          "!rspack",
+          "!storybook",
+          "!vue",
+          "!web",
+          "!webpack",
+          "!workspace"
+        ]
       }
     ]
   }

diff --git a/tools/workspace-plugin/src/conformance-rules/project-package-json/index.spec.ts b/tools/workspace-plugin/src/conformance-rules/project-package-json/index.spec.ts
@@ -13,6 +13,9 @@ const VALID_PACKAGE_JSON_BASE = {
   publishConfig: {
     access: 'public',
   },
+  exports: {
+    './package.json': './package.json',
+  },
 };
 
 describe('project-package-json', () => {
@@ -257,5 +260,30 @@ describe('project-package-json', () => {
         ]
       `);
     });
+
+    it('should return a violation if the project does not specify an exports object in the package.json', () => {
+      const sourceProject = 'test-project';
+      const sourceProjectRoot = '/path/to/test-project';
+
+      expect(
+        validateProjectPackageJson(
+          {
+            ...VALID_PACKAGE_JSON_BASE,
+            exports: undefined,
+          },
+          sourceProject,
+          sourceProjectRoot,
+          `${sourceProjectRoot}/package.json`
+        )
+      ).toMatchInlineSnapshot(`
+        [
+          {
+            "file": "/path/to/test-project/package.json",
+            "message": "The project package.json should have an "exports" object specified",
+            "sourceProject": "test-project",
+          },
+        ]
+      `);
+    });
   });
 });
diff --git a/tools/workspace-plugin/src/conformance-rules/project-package-json/index.ts b/tools/workspace-plugin/src/conformance-rules/project-package-json/index.ts
@@ -51,6 +51,11 @@ export function validateProjectPackageJson(
 ): ProjectFilesViolation[] {
   const violations: ProjectFilesViolation[] = [];
 
+  // Private packages are exempt from this rule
+  if (projectPackageJson.private === true) {
+    return [];
+  }
+
   if (typeof projectPackageJson.name !== 'string') {
     violations.push({
       message: 'The project package.json should have a "name" field',
@@ -71,16 +76,14 @@ export function validateProjectPackageJson(
     }
   }
 
-  // Public packages
-  if (!projectPackageJson.private) {
-    if ((projectPackageJson.publishConfig as any)?.access !== 'public') {
-      violations.push({
-        message:
-          'Public packages should have "publishConfig": { "access": "public" } set in their package.json',
-        sourceProject,
-        file: projectPackageJsonPath,
-      });
-    }
+  // Publish config
+  if ((projectPackageJson.publishConfig as any)?.access !== 'public') {
+    violations.push({
+      message:
+        'Public packages should have "publishConfig": { "access": "public" } set in their package.json',
+      sourceProject,
+      file: projectPackageJsonPath,
+    });
   }
 
   // Nx config properties
@@ -105,5 +108,18 @@ export function validateProjectPackageJson(
     }
   }
 
+  const hasExportsEntries =
+    typeof projectPackageJson.exports === 'object' &&
+    Object.keys(projectPackageJson.exports ?? {}).length > 0;
+
+  if (!hasExportsEntries) {
+    violations.push({
+      message:
+        'The project package.json should have an "exports" object specified',
+      sourceProject,
+      file: projectPackageJsonPath,
+    });
+  }
+
   return violations;
 }