eslint-config-aha/README.md

Aha! ESLint config

[![npm version](https://badge.fury.io/js/eslint-config-aha.svg)](https://badge.fury.io/js/eslint-config-aha)

# eslint-config-aha

Common ESLint configuration for [Aha!](https://www.aha.io) projects, based on [JavaScript Standard Style](https://standardjs.com) with some modifications.

## Installation

Install from npm:

```
# with yarn
yarn add eslint-config-aha --dev

# without yarn
npm install eslint-config-aha --save-dev
```

The package has a number of peer dependencies; to install everything at once:

```
# with yarn
yarn add eslint eslint-config-aha eslint-config-standard eslint-config-standard-jsx eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-react eslint-plugin-standard eslint-plugin-you-dont-need-lodash-underscore --dev

# without yarn
npm install eslint eslint-config-aha eslint-config-standard eslint-config-standard-jsx eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-react eslint-plugin-standard eslint-plugin-you-dont-need-lodash-underscore --save-dev
```

## Usage

Add to your `.eslintrc` file:

```
{
  "extends": "aha"
}
```

(The `eslint-config-` prefix is automatically assumed by ESLint).

## Development

After checking out the repo, run `yarn install` to install dependencies.

There are a few simple tests to ensure the rules are a valid ESLint configuration; run `yarn test` to execute them.

## Contributing

We are unlikely to accept external contributions to change configuration rules. You are welcome to fork or extend for your own purposes if you like the baseline but disagree with some of our settings. :)

## Credits

This package uses [JavaScript Standard Style](https://standardjs.com) as a baseline (and also mimics a lot of the [eslint-config-standard](https://github.com/standard/eslint-config-standard) package structure).