https://github.com/koddsson/eslint-disable-probot
🤖 A bot that comments on PRs that try to disable certain eslint rules
https://github.com/koddsson/eslint-disable-probot
eslint eslint-rules probot probot-app
Last synced: 3 months ago
JSON representation
🤖 A bot that comments on PRs that try to disable certain eslint rules
- Host: GitHub
- URL: https://github.com/koddsson/eslint-disable-probot
- Owner: koddsson
- License: isc
- Created: 2018-02-26T20:48:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-30T18:12:45.000Z (over 6 years ago)
- Last Synced: 2025-01-30T19:13:07.171Z (3 months ago)
- Topics: eslint, eslint-rules, probot, probot-app
- Language: JavaScript
- Homepage:
- Size: 141 KB
- Stars: 44
- Watchers: 1
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# eslint-disable-bot
> A GitHub App built with [probot](https://github.com/probot/probot) that comments on pull requests that try to disable eslint rules.
## Usage
Simply [install the app](https://github.com/apps/eslint-disable-watcher) 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:
```yml
# 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](https://github.com/koddsson/eslint-disable-probot/issues/new?title=[Config]&body=Can%20you%20please%20add%20the%20___%20config%20option).
## Development setup
```
# Install dependencies
npm install
# Run the bot
npm start
```