Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,36 @@
## Installation

```sh
$ npm install --save-dev eslint
$ npm install --save-dev eslint-plugin-github
$ npm install --save-dev eslint eslint-plugin-github
```

Run initialization wizard.
## Setup

```sh
$ node_modules/.bin/eslint-github-init
Add `github` to your list of plugins in your ESLint config.

JSON ESLint config example:
```json
{
"plugins": ["github"]
}
```

Set up `npm run lint` script.
Extend the configs you wish to use.

JSON ESLint config example:
```json
{
"private": true,
"scripts": {
"lint": "github-lint"
}
"extends": ["plugin:github/recommended"]
}
```

The `github-lint` command will run various checkers and linters depending on your project configuration.
The available configs are:

- `app`
- Rules useful for github applications.
- `browser`
- Useful rules when shipping your app to the browser.
- `recommended`
- Recommended rules for every application.
- `typescript`
- Useful rules when writing TypeScript.
87 changes: 0 additions & 87 deletions bin/eslint-github-init.js

This file was deleted.

66 changes: 0 additions & 66 deletions bin/github-lint.js

This file was deleted.

47 changes: 0 additions & 47 deletions bin/npm-check-github-package-requirements.js

This file was deleted.

27 changes: 0 additions & 27 deletions docs/configs.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/package-requirements.md

This file was deleted.

Loading