docs: Add comment explaining flatmap logic in eslint config

novuhq · Sep 30, 2024 · 44b35a4 · 44b35a4
1 parent 4bf4714
commit 44b35a4
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -43,6 +43,7 @@ const noRestrictedImportsMultiLevelNovuPattern = {
   group: [
     '@novu/*/**/*',
     // These packages have legitimate exports 1 path part below the root level
+    // This flatmap logic ignores the path 1 below the root level and prevents deeper imports.
     ...['framework', 'js', 'novui'].flatMap((pkg) => [`!@novu/${pkg}/**/*`, `@novu/${pkg}/*/**/*`]),
   ],
   message: "Please import only from the root package entry point. For example, use 'import { Client } from '@novu/node';' instead of 'import { Client } from '@novu/node/src';'",