Possibility to define barrel file

[rainerhahnekamp]

index.ts is the name of the file representing a module.

It should be possible to go with another one. For example, the Angular CLI calls it public-api.ts.

@mikezks: You want to give it a try?

[bradley-carestia-jbh]

Would love to see this fixed to allow Sherriff to handle cross-entry-point dependencies without having to rename all my public-api files

[KvikullSigurdur]

I second this Idea but for different reasons. I am working on a large project with a lot of preexisting index.ts files (that don't respect module boundaries) that prevents me from incrementally applying sheriff.

Would be nice to create some barrelIndex.ts that interacts with sheriff while i am cleaning up my codebase.

[rainerhahnekamp]

@KvikullSigurdur just to avoid a misunderstanding. You can have both barrel modules (with an index.tx) and barrel-less in a project.

If you now say that those barrel modules are breaking encapsulation the whole time, then I'd first try to fix that.

---

That said, I think i don't quite catch the idea of the barrelIndex.ts. What is that one supposed to do? What that be placed next to the index.tsand be used for the "real encapsulation"?

If yes, sheriff.config.ts has a property barrelFileName. Set that one to barrelIndex.ts and Sheriff would ignore index.ts.

Let me know if that works for you

[rainerhahnekamp]

@bradley-carestia-jbh, same goes for you. Just set barrelFileName in sheriff.config.ts to public-api.ts and you're done.

[KvikullSigurdur]

If you now say that those barrel modules are breaking encapsulation the whole time, then I'd first try to fix that.

Yep that is the goal :) Jump wanted to know if I could somehow enable the warning incrimentally. barrelFileName works perfectly. Thank you very much!

[bradley-carestia-jbh]

Awesome, I'll give that a try next time I'm looking at this.