"not-reachable" rule

Question (or feature request if it isn’t possible at the moment)

Is it possible to declare an “not-reachable” rule, which is an extension of the “no-orphans” rule, but also checks for modules with outgoing imports. This rule would require to specify a list of “entry points”.

Example

Given

src/index.js       -> src/mod_a.js
src/mod_a.js       -> src/mod_b.js
src/mod_orphan.js  -> src/mod_b.js

Then this rule should report src/mod_orphan.js as “not reachable” (given ["src/index.js"] as “entry point list”).

[ulrichb]

=> I’ve added a comment to the PR.

[sverweij]

hello again @ulrichb. At this moment this is indeed not possible, but it’d be a useful extension of the orphan rule as a ‘dead wood detector’.

I’ll have to mull over what an intuitive interface and a reasonable implementation would be - but it’s likely to be doable.

Kicking around some ideas for a configured rule like that:

{
  forbidden: [{
    name: "only-reachables-from-index",
    from: {
      path: "src/index.ts" // should we limit this to single files or would wildcards yield sensible results?
    },
    to: {
      pathNot: "\\.spec\\.ts$", // we probably want to exclude test specs
      reachable: false // new 'to restriction' property or call it 'notReachable'? What would give the least mental mapping?
    }
  }]
}

and/ or as an allowed rule, which might be slightly more readable

{
  allowed: [{
    from: {
      path: "src/index.ts"
    },
    to: {
      reachable: true 
    }
  }]
}