search

javierbrea / eslint-plugin-boundaries

Eslint plugin checking architecture boundaries between elements
MIT License
506 stars 9 forks source link

Clarify include / exclude precedence #337

Open robw-mercury opened 1 month ago

robw-mercury commented 1 month ago

While reading the docs, I found a sentence that was ambiguous and potentially misleading.

Note: The boundaries/include option has preference over boundaries/ignore. If you define boundaries/include, use boundaries/ignore to ignore subsets of included files.

"boundaries/include has preference" could mean two things:

  1. boundaries/include is applied first, and boundaries/ignore is applied after. boundaries/exclude has precedence.
  2. boundaries/include is preferred. boundaries/include has precedence.

I edited the docs to use the word "precedence", which removes the ambiguousness.