https://github.com/doasync/eslint-config-airbnb-bundle
ESLint bundled with Airbnb config
https://github.com/doasync/eslint-config-airbnb-bundle
Last synced: 5 months ago
JSON representation
ESLint bundled with Airbnb config
- Host: GitHub
- URL: https://github.com/doasync/eslint-config-airbnb-bundle
- Owner: doasync
- License: mit
- Created: 2017-09-27T12:11:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T19:01:25.000Z (over 2 years ago)
- Last Synced: 2025-10-09T09:54:45.373Z (5 months ago)
- Language: JavaScript
- Size: 215 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eslint with Airbnb style
ESLint bundled with the original Airbnb Style config. Global installation is supported! No struggle with peer dependencies, easily integrates with your code editors.
See [airbnb/javascript] for more information.
See instructions for WebStorm, VSCode, Sublime Text and Atom
[airbnb/javascript]: https://github.com/airbnb/javascript
## Installation
Install it globally:
```bash
npm install --global eslint-config-airbnb-bundle
```
You can install it locally as well:
```bash
npm install --save-dev eslint-config-airbnb-bundle
```
#### Setup your IDE / Editor:
[WebStorm](#user-content-webstorm)
[VSCode](#user-content-vscode)
[Sublime Text 3](#user-content-sublime-text-3)
[Atom](#user-content-atom)
## Usage
You can now run feature packed `eslint` from any directory:
```bash
eslint -v
```
Create `.eslintrc` file in your project. Setup your IDE / Editor. And be smart!
ES6, ES7, React, JSX, async/await - all new features supported by default 👍
## ESLint inside
You shouldn't add `eslint` to your dependencies. It's bundled with this package, just specify the path if you need.
Here is an example for `eslint-loader`:
```javascript
{
loader: 'eslint-loader',
options: {
eslintPath: 'eslint-config-airbnb-bundle/node_modules/eslint',
}
},
```
## WebStorm
File ➤ Settings / Default Settings ➤ Languages and Frameworks ➤ JavaScript ➤ Code Quality Tools ➤ ESLint
Global installation in not necessary for WebStorm, but it is handy for the "Default Settings".
## VSCode
1. Install this package globally (or locally)
2. Go to: *View -> Extension* or press `CTRL + SHIFT + X`
3. Search for [ESLint](https://github.com/Microsoft/vscode-eslint) extension, click it and press "Install" button
4. Press "Reload" button or reopen the editor
5. Go to: *File -> Preferences -> Settings*
Add ESLint path to your workspace settings (do not use `~`):
```json
{
"eslint.nodePath": "/home/username/.nvm/versions/node/v10.5.0/lib/node_modules/eslint-config-airbnb-bundle/node_modules/eslint",
}
```
Relative path for local installation:
```json
{
"eslint.nodePath": "node_modules/eslint-config-airbnb-bundle/node_modules/eslint",
}
```
7. Create `.eslintrc.js` file inside your working project root:
```js
process.chdir(__dirname);
module.exports = {
root: true,
parser: 'babel-eslint',
parserOptions: {
allowImportExportEverywhere: true,
codeFrame: false
},
extends: [
'airbnb-bundle',
],
};
```
## Sublime Text 3
1. Install this package globally
2. Go to: *Preferences -> Package Control -> install package*
3. Install [SublimeLinter](https://packagecontrol.io/packages/SublimeLinter)
4. Install [SublimeLinter-contrib-eslint](https://packagecontrol.io/packages/SublimeLinter-contrib-eslint)
5. Run:
```bash
npm bin -g
```
... and copy the path
6. Go to: *Tools -> SublimeLinter -> Open User Settings*
Paste the path to NodeJS installation folder inside "paths" for your OS and save:
```json
"paths": {
"linux": [
"~/.nvm/versions/node/v8.8.1/bin"
],
"osx": [],
"windows": ["%AppData%\\npm"]
},
```
7. Create `.eslintrc` file inside your working project:
```json
{
"extends": ["airbnb-bundle"]
}
```
8. Restart Sublime Text
9. Go to *Tools -> SublimeLinter -> Lint this view*
10. You can switch to squiggly underline mark style from *Tools*. Have fun!
## Atom
1. Install this package globally
2. Go to: *Edit -> Preferences -> Install*
3. Install [Linter](https://atom.io/packages/linter)
4. Install [linter-eslint](https://atom.io/packages/linter-eslint)
5. Run:
```bash
npm prefix -g
```
... copy the prefix path
6. Go to: *Preferences -> Packages -> linter-eslint -> Settings*
a) Check *"Use global ESLint installation"* option at the bottom
b) Paste the prefix path to the field *"Global Node Installation Path"* and append:
```bash
/lib/node_modules/eslint-config-airbnb-bundle
```
7. Create `.eslintrc` file inside your working project:
```json
{
"extends": ["airbnb-bundle"]
}
```
8. Press *`Ctrl + Shift + P` -> enter "lint" -> click "Linter:Lint"*
## Custom Config
Add your own rules to the `.eslintrc` file in your project folder.