Add a rule to enforce using React component index modules only for re-exporting

[tambeta]

From the README:

reexporting-index-modules

Detect React index modules matching the regular expression
[A-Z]\w+/index\.js$ and only allow these to only contain import declarations
importing from its containing directory and export declarations re-exporting
previously imported symbols.

This rule enforces using index.js modules only for collecting imports from within its containing directory and re-exporting these. This ensures that editors, PRs, diffs etc. are not littered with indistinguishable index.js files.

Testing

In your project, temporarily modify ESLint configuration so that plugins includes "voog" and rules contains only

"voog/reexporting-index-modules": ["error"]

Then clone eslint-voog, link it to your project and run ESLint over the codebase to inspect the results. Execute yarn test to run the test suite.

$ git clone git@github.com:Voog/eslint-voog.git
$ cd eslint-voog
$ git checkout rule_react_index_modules
$ yarn test
$ yarn link
$ cd /my/project
$ yarn link eslint-plugin-voog
$ npx eslint -- 'app/assets/javascripts/**/*.js'

[tanelj]

Nice!

[pxska]

Looks good! 👍🏻