https://github.com/cantonjs/eslint-config-cantonjs

ESLint shareable config for the Cantonjs JavaScript style guide
https://github.com/cantonjs/eslint-config-cantonjs

eslint eslint-config javascript lint

Last synced: about 1 month ago
JSON representation

ESLint shareable config for the Cantonjs JavaScript style guide

• Host: GitHub
• URL: https://github.com/cantonjs/eslint-config-cantonjs
• Owner: cantonjs
• License: mit
• Created: 2017-12-28T04:49:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-18T04:08:23.000Z (over 6 years ago)
• Last Synced: 2025-02-19T13:27:12.300Z (2 months ago)
• Topics: eslint, eslint-config, javascript, lint
• Language: JavaScript
• Size: 63.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-cantonjs

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

[![Dependencies](https://david-dm.org/cantonjs/eslint-config-cantonjs.svg)](https://david-dm.org/cantonjs/eslint-config-cantonjs)

[![License](https://img.shields.io/badge/license-MIT_License-brightgreen.svg?style=flat)](https://github.com/cantonjs/eslint-config-cantonjs/blob/master/LICENSE)

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for the Cantonjs

## Installation

### NPM

```

$ npm install --save-dev eslint eslint-config-cantonjs eslint-config-standard eslint-plugin-import eslint-plugin-jest eslint-plugin-node eslint-plugin-promise eslint-plugin-react eslint-plugin-standard

```

### Yarn

```

$ yarn add --dev eslint eslint-config-cantonjs eslint-config-standard eslint-plugin-import eslint-plugin-jest eslint-plugin-node eslint-plugin-promise eslint-plugin-react eslint-plugin-standard

```

## Usage

Once the `eslint-config-cantonjs` package is installed, you can use it by specifying `cantonjs` 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": "cantonjs",

  "rules": {

    // Additional, per-project rules...

  }

}

```

## Configures / Extends

* `extends: "cantonjs"` basic usage

* `extends: "cantonjs/base"` the same with `extends: "cantonjs"`

* `extends: "cantonjs/react"` `base` + `react`

## Related Projects

* [eslint-config-cantonjs-resolver](https://github.com/cantonjs/eslint-config-cantonjs-resolver)

## License

MIT © Cantonjs