NPM module of the week: ESLint-plugin-import
Save yourself some time debugging whether or not you have the correct paths to modules you are importing.
import into your working module.
import React from 'react' import PropTypes from 'prop-types' import MyComponent from '../../components/MyComponent'
Sometimes we just don't get the path to our components right the first time and we end up spending some of our mental energy in tracking them down.
I have found this plugin particularly helpful in saving me time doing any work prior to getting my imports down correctly. In recent discussions, I have been sharing this with other engineers and they have also been finding this helpful in their own work.
Here are some simple examples of
eslint-plugin-import in action. I am using Atom as my editor in these screens.
Validating the import of absolute modules
Validating the import of relative modules
There is a list of additional types of validations that
eslint-plugin-import handles for us and they are worth a study. Some examples are:
Forbidding the use of
require. Great for codebases that are interested in migrating to ES modules. Or if you have a team of engineers that are more accustomed to using Common JS.
Forbidding dynamic requires.
Forbidding webpack loader syntax.
You may take or leave any of these linting rules, but they may be good for you and your team to consider.