jenseng / eslint-plugin-batman-requires

batman-requires

eslint plugin to prevent requireing modules from parent directories. no parents. get it?

installation

npm install eslint-plugin-batman-requires --save-dev

usage

and then in your .eslintrc:

{
  "plugins": [
    "batman-requires"
  ],
  "rules": {
    "batman-requires/no-parents": 2
  }
}

whitelisting files

sometimes you do actually want to require parents. like if you put tests in a __tests__ directory right next to the modules, and each test file requires its subject. rather than putting a custom .eslintrc in every __tests__ dir or putting eslint comments everywhere, you can just specify some whitelist globs (minimatch-style) in your rule config, e.g.

{
  "rules": {
    "batman-requires/no-parents": [2, "**/__tests__/*", "moar", "patterns", "here/*"]
  }
}

eslint-plugin-batman-requires's Issues

need to be able to go up one

Reports/components/Foo.js needs to be able to require
Reports/stores/Something.js

not sure how to allow this but prevent other things ...