Enable imports from workspaces in a "shared" folder if it shares a parent

Author: Tobias Lengsholz

lib/rules/no-cross-imports.js

@@ -31,6 +31,18 @@ module.exports.meta = {
   ],
 };
 
+const filterSharedPackagesInCurrentScope = ({ location: currentLocation }) => ({
+  location,
+}) => {
+  const locationArray = location.split('/');
+  const forbiddenPackageParent = locationArray.slice(0, -1).join('/');
+  if (!isSubPath(forbiddenPackageParent, currentLocation)) {
+    return true;
+  }
+
+  return locationArray[locationArray.length - 1] !== 'shared';
+};
+
 module.exports.create = (context) => {
   const {
     options: [{ allow = [] } = {}],
@@ -40,17 +52,19 @@ module.exports.create = (context) => {
   const forbidden = packages.filter(({ name }) => !allowed.includes(name));
 
   return getImport(context, ({ node, value, path, currentPackage }) => {
-    forbidden.forEach(({ name, location }) => {
-      if (
-        name !== currentPackage.name &&
-        (isSubPath(name, value) || isSubPath(location, path))
-      ) {
-        context.report({
-          node,
-          message: 'Import from package "{{name}}" is not allowed',
-          data: { name },
-        });
-      }
-    });
+    forbidden
+      .filter(filterSharedPackagesInCurrentScope(currentPackage))
+      .forEach(({ name, location }) => {
+        if (
+          name !== currentPackage.name &&
+          (isSubPath(name, value) || isSubPath(location, path))
+        ) {
+          context.report({
+            node,
+            message: 'Import from package "{{name}}" is not allowed',
+            data: { name },
+          });
+        }
+      });
   });
 };

tests/rules/no-cross-imports.js

@@ -38,6 +38,10 @@ ruleTester.run('no-cross-imports', rule, {
       filename: '/some/file.js',
       code: "import '@test/workspace';",
     },
+    {
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-in-scope';",
+    },
   ],
 
   invalid: [
@@ -184,5 +188,15 @@ ruleTester.run('no-cross-imports', rule, {
         },
       ],
     },
+    {
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-outside-scope';",
+      errors: [
+        {
+          message:
+            'Import from package "@test/shared-outside-scope" is not allowed',
+        },
+      ],
+    },
   ],
 });

tests/setup.js

@@ -22,4 +22,22 @@ mock('get-monorepo-packages', () => [
       name: '@test/third-workspace',
     },
   },
+  {
+    location: '/test/scope/shared',
+    package: {
+      name: '@test/shared-in-scope',
+    },
+  },
+  {
+    location: '/test/other-scope/shared',
+    package: {
+      name: '@test/shared-outside-scope',
+    },
+  },
+  {
+    location: '/test/scope/workspace',
+    package: {
+      name: '@test/scoped-workspace',
+    },
+  },
 ]);