https://github.com/webex/ciscospark-eslint-config

https://github.com/webex/ciscospark-eslint-config

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/webex/ciscospark-eslint-config
• Owner: webex
• Created: 2017-06-15T17:59:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-11T16:22:21.000Z (over 6 years ago)
• Last Synced: 2024-12-17T02:03:04.199Z (17 days ago)
• Language: JavaScript
• Size: 63.5 KB
• Stars: 0
• Watchers: 6
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @ciscospark/eslint-rules

[![Greenkeeper badge](https://badges.greenkeeper.io/ciscospark/ciscospark-eslint-config.svg)](https://greenkeeper.io/)

See https://ciscospark.github.io/spark-js-sdk/

Common eslint rules used by Cisco Spark

## Installation

Eslint doesn't let us put plugins in shareable configs, so use the following command to install all peer dependencies needed by `@ciscospark/eslint-config`.

```bash

(

  export PKG=@ciscospark/eslint-config

  npm info "$PKG@latest" peerDependencies --json \

    | command sed 's/[\{\},]//g ; s/: /@/g' \

    | xargs npm install --save-dev "$PKG@latest"

)

```

Which produces and runs a command like:

npm install --save-dev @ciscospark/eslint-config eslint@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-mocha@^#.#.# eslint-plugin-react@^#.#.#

## Usage

By default, we export a set of es2015 rules encouraging use of import/export. You can use this ruleset with simply

```yaml

extends: "@ciscospark"

```

Additionally, you may be interested in:

### ES5 Rules

```yaml

extends: "@ciscospark/eslint-config/es5"

root: true

```

### ES2015 rules without import/export

```yaml

extends: "@ciscospark/eslint-config/es2015"

root: true

```

### ES2015 with React additions

```yaml

extends:

- "@ciscospark"

- "@ciscospark/eslint-config/react"

root: true

```

### Mocha preset to avoid committing `.only`

> Note: this does not have a `root:true` so that you can drop in a subdirectory that will otherwise receive config from a higher-level file.

```yaml

extends: "@ciscospark/eslint-config/mocha"

```

### For writing scripts

```yaml

extends:

- "@ciscospark/eslint-config/es2015"

- "@ciscospark/eslint-config/bin"

root: true

```