Feature request: Option to exclude dynamic imports about dependency-cruiser HOT 7 CLOSED

I tested it out. Works exactly as expected for our use case. Thank you very much!

from dependency-cruiser.

Awesome! I've merged the PR and published it as part of [email protected]

from dependency-cruiser.

hi @fongandrew thanks for this suggestion - there's currently indeed no elegant way to distinguish dynamic imports in rules, and there should be. Especially when dependency-cruiser will start recognizing dynamic imports with arguments that can only be determined at runtime (which is on the backlog )

They way I'm thinking to do this is to flag dynamic dependencies so they can be used in rules e.g. something like this:

{
  forbidden: [
    {
      name: "no-circular",
      from: {
      },
      to {
        dynamicImport: false, //
        circular: true
      }
  ]

from dependency-cruiser.

Ooh, that rule syntax would be perfect. Looking forward to it!

from dependency-cruiser.

hi @fongandrew - it's taken some time to address this issue; had to get #142 out the door first...

I've implemented my proposal above. It works, but it I realised it likely won't resolve the issue you have (see below) unless all the dependencies in a circle are dynamic ones (see background below).

The dynamic attribute is probably going to stay because it's useful for other things, but I'm looking into a different solution for this issue (several ideas; including the followDynamic switch you proposed above - will ping you with one(s?) that works out).

background below

Given this dependency-graph...

...with a rule that forbids circular dependencies, except for dynamic ones ...

module.exports = { 
    forbidden: [{
            name: 'no-circular',
            severity: 'warn',
            from: {}, 
            to: {
                circular: true,
                dynamic: false
            }
    }]
}

... the result would be:

Close. No cigar ...

from dependency-cruiser.

Oh, that's unfortunate, but I appreciate you taking the time to figure this out!

from dependency-cruiser.

hi @fongandrew so here's another stab, that works better in your use case - it excludes all dependencies that are dynamic:

module.exports = {
  forbidden: [{
    name: 'no-circular',
    from: {},
    to: {
      circular: true
    }
  }],
  options: {
    exclude: {
      dynamic: true
    }
  }
}

This now works in [email protected], so if you want to you can give it a spin you can. I'll be interested in your findings!

from dependency-cruiser.