eslint-disable-bot

A GitHub App built with probot that comments on pull requests that try to disable eslint rules.

Usage

Simply install the app and the bot will keep 👀 on PRs that have eslint-disable comments.

How it works

When a PR is opened or updated, the ESLint Disable Watcher will scan through the diffs of JavaScript files and comment if the PR is adding any strings containing eslint-disable.

Configuration

You don't need any configuration for this to work in your project but you can customize a few things to fit your needs. You can create a .github/eslint-disable-bot.yml file:

# Change this to set the number of comments the watcher should comment on a given PR.
commentLimit: 10
# The message the bot will post on any lines containing a eslint disable comment.
commentMessage: Please don't disable eslint rules :pray:
# A optional regular expression that will match against the branch name and not comment on it if it matches.
skipBranchMatching: null

If you need more configuration, please let me know in a new issue.

Development setup

# Install dependencies
npm install

# Run the bot
npm start