CONTRIBUTING.md

Contributing

Contributions are welcome! See something that could be improved, feel free to create a pull request 👍

Useful resources

• Working with Plugins - ESLint docs section about plugins

• AST Explore - Tool to visualize ASTs. Can create and test ESLint rules in the browser

• Yeoman generator-eslint - Yeoman template for ESLint rules. Was used to bootstrap this repository

Development

Fork and clone the repo

git clone https://github.com/{username}/eslint-plugin-module-resolver
cd eslint-plugin-module-resolver
yarn

Running tests

Run tests:

yarn test

Collect code coverage after test run:

yarn test:coverage

Run tests on file save:

yarn test:watch

Building

Transpile lib to dist folder:

yarn build

Rebuild on changes in lib:

yarn build:watch

Using local changes in an existing project

In eslint-plugin-module-resolver repository run:

yarn link

then in the project using the package run:

yarn link "eslint-plugin-module-resolver"

Opening a pull request

• Fork the repo
• Branch off master
• Make sure all tests pass and create new ones if needed
• Reference any open issues that relate to the PR in the description