Make scopes configurable

Author: Tobias Lengsholz

lib/rules/no-cross-imports.js

@@ -26,34 +26,59 @@ module.exports.meta = {
             },
           ],
         },
+        scopes: {
+          anyOf: [
+            { type: 'boolean', additionalProperties: false },
+            {
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                enable: { type: 'boolean' },
+                folderName: { type: 'string' },
+              },
+            },
+          ],
+        },
       },
     },
   ],
 };
 
-const filterSharedPackagesInCurrentScope = ({ location: currentLocation }) => ({
-  location,
-}) => {
+const filterSharedPackagesInCurrentScope = (
+  { location: currentLocation },
+  scopedEnabled,
+  scopedSharingFolderName,
+) => ({ location }) => {
+  if (!scopedEnabled) return true;
   const locationArray = location.split('/');
   const forbiddenPackageParent = locationArray.slice(0, -1).join('/');
   if (!isSubPath(forbiddenPackageParent, currentLocation)) {
     return true;
   }
 
-  return locationArray[locationArray.length - 1] !== 'shared';
+  return locationArray[locationArray.length - 1] !== scopedSharingFolderName;
 };
 
 module.exports.create = (context) => {
   const {
-    options: [{ allow = [] } = {}],
+    options: [{ allow = [], scopes = { enable: false } } = {}],
   } = context;
 
   const allowed = typeof allow === 'string' ? [allow] : allow;
+  const scopedEnabled = scopes === true || !!scopes.enable;
+  const scopedSharingFolderName = scopes.folderName || 'shared';
+
   const forbidden = packages.filter(({ name }) => !allowed.includes(name));
 
   return getImport(context, ({ node, value, path, currentPackage }) => {
     forbidden
-      .filter(filterSharedPackagesInCurrentScope(currentPackage))
+      .filter(
+        filterSharedPackagesInCurrentScope(
+          currentPackage,
+          scopedEnabled,
+          scopedSharingFolderName,
+        ),
+      )
       .forEach(({ name, location }) => {
         if (
           name !== currentPackage.name &&

tests/rules/no-cross-imports.js

@@ -39,6 +39,17 @@ ruleTester.run('no-cross-imports', rule, {
       code: "import '@test/workspace';",
     },
     {
+      options: [{ scopes: true }],
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-in-scope';",
+    },
+    {
+      options: [{ scopes: { enable: true } }],
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-in-scope';",
+    },
+    {
+      options: [{ scopes: { enable: true, folderName: 'shared' } }],
       filename: '/test/scope/workspace/file.js',
       code: "import '@test/shared-in-scope';",
     },
@@ -189,6 +200,7 @@ ruleTester.run('no-cross-imports', rule, {
       ],
     },
     {
+      options: [{ scopes: true }],
       filename: '/test/scope/workspace/file.js',
       code: "import '@test/shared-outside-scope';",
       errors: [
@@ -198,5 +210,24 @@ ruleTester.run('no-cross-imports', rule, {
         },
       ],
     },
+    {
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-in-scope';",
+      errors: [
+        {
+          message: 'Import from package "@test/shared-in-scope" is not allowed',
+        },
+      ],
+    },
+    {
+      options: [{ scopes: { enable: true, folderName: 'something-else' } }],
+      filename: '/test/scope/workspace/file.js',
+      code: "import '@test/shared-in-scope';",
+      errors: [
+        {
+          message: 'Import from package "@test/shared-in-scope" is not allowed',
+        },
+      ],
+    },
   ],
 });