https://github.com/gitbookio/eslint-config-gitbook

GitBook's ESLint config, following our styleguide
https://github.com/gitbookio/eslint-config-gitbook

Last synced: 9 months ago
JSON representation

GitBook's ESLint config, following our styleguide

• Host: GitHub
• URL: https://github.com/gitbookio/eslint-config-gitbook
• Owner: GitbookIO
• License: apache-2.0
• Created: 2016-08-29T17:35:29.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T21:17:12.000Z (over 2 years ago)
• Last Synced: 2025-04-13T20:41:07.130Z (9 months ago)
• Language: JavaScript
• Size: 223 KB
• Stars: 10
• Watchers: 3
• Forks: 7
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# eslint-config-gitbook

[![NPM version](https://badge.fury.io/js/eslint-config-gitbook.svg)](http://badge.fury.io/js/eslint-config-gitbook)

[![Build Status](https://travis-ci.org/GitbookIO/eslint-config-gitbook.svg?branch=master)](https://travis-ci.org/GitbookIO/eslint-config-gitbook)

This package provides GitBook's .eslintrc as an extensible shared config. It is mostly based on [airbnb styleguide](https://github.com/airbnb/javascript) and setup with [prettier](https://github.com/prettier/prettier) to code format with `eslint --fix`.

### Installation

```

npm install eslint-config-gitbook --save-dev

```

With npm 5+, you can now install the package along with its peer dependencies easily:

```

npx install-peerdeps --dev eslint-config-gitbook

```

### Usage

Add to your `.eslintrc`:

```js

{

    "extends": "gitbook"

}

```