chore(root): Prevent multi-level imports for @novu/* packages
#6596
Conversation
| @@ -3,6 +3,7 @@ import { Logger } from '@nestjs/common'; | |||
| import sinon from 'sinon'; | |||
| import { expect } from 'chai'; | |||
| import { ApiServiceLevelEnum } from '@novu/shared'; | |||
| // eslint-disable-next-line no-restricted-imports | |||
There was a problem hiding this comment.
I didn't want to raise an EE PR for these, so they are ignored for now.
| */ | ||
|
|
||
| /** | ||
| * This rule ensures that "multi-level" imports are not used for `@novu/*` packages. |
There was a problem hiding this comment.
I'm wondering if we should approach this from a different direction, specifically by not allowing the @novu domain libraries to have the /src suffix. @novu/**/src For example: @novu/framework/src, @novu/dal/src, @novu/ee/3rd-party/something/src, @novu/novui/src. I believe that, for now, this approach will be more beneficial and won't limit us in potential future implementations.
let me know what you think :)
There was a problem hiding this comment.
For packages under our control, I'm of the opinion that we should only allow imports from known exports values in the package.json. This benefits us by:
- keeping module imports clean
- creating a clear module boundary
- ensuring that public package consumers can import the same things that we do, allowing us to dogfood
This PR introduces a pattern for exceptions of the rule, namely for multiple entry-point packages. That same pattern can be extended to handle other exceptions we might like to add in the future. I think the benefits of a "by exception" approach outweigh the cons of allowing any multi-level imports right now.
commit: |
❌ Deploy Preview for novu-stg-vite-dashboard-poc failed. Why did it fail? →
|
What changed? Why was the change needed?
@novu/*packagesScreenshots
Expand for optional sections
Related enterprise PR
Special notes for your reviewer