https://github.com/smashingboxes/eslint-config-smashing-boxes

https://github.com/smashingboxes/eslint-config-smashing-boxes

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/smashingboxes/eslint-config-smashing-boxes
• Owner: smashingboxes
• License: mit
• Created: 2016-12-20T18:54:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-02T21:55:30.000Z (over 8 years ago)
• Last Synced: 2024-10-16T02:06:24.904Z (over 1 year ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 1
• Watchers: 7
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# eslint-config-smashing-boxes [![npm](https://img.shields.io/npm/v/eslint-config-smashing-boxes.svg)](https://www.npmjs.com/package/eslint-config-smashing-boxes)

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for Smashing Boxes' JavaScript Style Guide

## Installation

```

npm install --save-dev eslint eslint-config-smashing-boxes

```

## Usage

Once the `eslint-config-smashing-boxes` package is installed, you can use it by specifying `smashing-boxes` or `eslint-config-smashing-boxes` in the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) section of your [ESLint configuration](http://eslint.org/docs/user-guide/configuring).

```js

{

  "extends": "smashing-boxes", // Or "eslint-config-smashing-boxes"

  "rules": {

    /**

     * Additional, per-project rules can go here.

     * These rules will override the rules in

     * "eslint-config-smashing-boxes"

     */

  }

}

```

### React

For usage in a React project you will need to install the `eslint-plugin-react`:

```

npm install --save-dev eslint-plugin-react

```

Change the `"extends"` value to `"extends": "smashing-boxes/react"` or `"extends": "eslint-config-smashing-boxes/react"`

```js

{

  "extends": "smashing-boxes/react", // Or "eslint-config-smashing-boxes/react"

  "rules": {

    /**

     * Additional, per-project rules can go here.

     * These rules will override the rules in

     * "eslint-config-smashing-boxes"

     */

```

## License

MIT