https://github.com/pdehaan/eslint-config-fxa

ESLint config file for Firefox Accounts projects
https://github.com/pdehaan/eslint-config-fxa

Last synced: 3 months ago
JSON representation

ESLint config file for Firefox Accounts projects

• Host: GitHub
• URL: https://github.com/pdehaan/eslint-config-fxa
• Owner: pdehaan
• License: mpl-2.0
• Created: 2015-06-11T20:07:09.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-12-15T21:56:51.000Z (about 8 years ago)
• Last Synced: 2024-08-10T22:54:27.837Z (5 months ago)
• Language: JavaScript
• Homepage: http://npm.im/eslint-config-fxa
• Size: 22.5 KB
• Stars: 0
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-fxa

ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs) file for Firefox Accounts projects.

## Installation:

```

$ npm install eslint-config-fxa -D

```

(You'll need to install `eslint` dependency into your project as well.)

## Usage:

1. Create an .eslintrc file in your project's root directory.

2. Add the following content to your project's .eslintrc file: `"extends": "fxa"`.

3. Run `$ eslint .` (if you have ESLint installed globally, or call via `$ ./node_modules/.bin/eslint .` in your Terminal, or simply `eslint .` if you're using an npm `script` task).

## Options:

There are currently three configs:

1. `fxa` (usage: `"extends": "fxa"`) — Includes base ESLint [environments](http://eslint.org/docs/user-guide/configuring#specifying-environments) and [rules](http://eslint.org/docs/rules/).

2. `client` (usage: `"extends": "fxa/client"`) — Overrides base `fxa` config, and adds additional environments for 'amd', 'browser', and 'mocha'.

3. `server` (usage: `"extends": "fxa/server"`) — Overrides base `fxa` config, and disables the [`semi`](http://eslint.org/docs/rules/semi) rule.

## NOTE:

The **eslint-config-fxa@2** module is compatible w/ **eslint@1**.

If you're still using a pre ESLint v1 build, you'll need to stick with **eslint-config-fxa@1**.