Skip to content
This repository has been archived by the owner on Jul 10, 2021. It is now read-only.

probot/linter

Repository files navigation

Linter

a GitHub App built with probot that lints and fixes code in Pull Requests.

screen shot 2017-07-25 at 10 08 38 pm

screen shot 2017-07-25 at 10 10 53 pm

Usage

  1. Install the bot on the intended repositories. The plugin requires the following Permissions and Events:
  • Repository Contents: Read & Write
    • check the box for Push events
  1. Optionally, you can add a .github/linter.yml file that contains the following optionally editable fields:
# Configuration for linter - https://github.com/probot/linter

# a list of files the linter will NOT be applied to
exclude:
  - index.js
  - config.js

# Options to be passed into the javascript standard linter
# More documentation on what is acceptable here can be found in the standard docs here: https://github.com/standard/standard#standardlinttexttext-opts-callback
globals: []  # custom global variables to declare
plugins: []  # custom eslint plugins
envs: []     # custom eslint environment

Setup

# Install dependencies
npm install

# Run the bot
npm start

See docs/deploy.md if you would like to run your own instance of this plugin.