# eslint-config-meteor

This is an [ESLint](https://eslint.org) configuration for [Meteor](https://www.meteor.com) apps which implements the recommendations from the [Meteor Guide](https://guide.meteor.com/)'s section on [Code style](https://guide.meteor.com/code-style.html#eslint).

# Usage

## Install

Install by running:

```sh
meteor npm install --save-dev @meteorjs/eslint-config/meteor
```

> Using `meteor npm` is optional for this package, but best-practice for Meteor
  projects in general.

## Configure

Add the following to your package.json

```json
"eslintConfig": {
  "extends": "@meteorjs/eslint-config-meteor"
}
```

# Todo

- Figure out peerDependency installation.

# eslint-config-meteor

This is an [ESLint](https://eslint.org) configuration for [Meteor](https://www.meteor.com) apps which implements the recommendations from the [Meteor Guide](https://guide.meteor.com/)'s section on [Code style](https://guide.meteor.com/code-style.html#eslint).

# Usage

## Install

Install by running:

```sh
meteor npm install --save-dev @meteorjs/eslint-config/meteor
```

> Using `meteor npm` is optional for this package, but best-practice for Meteor
  projects in general.

### Peer Dependencies

This package has several `peerDependencies` listed in its `package.json` which
will produce warnings if they are not installed when running the install above.

These should be installed manually, per the [`package.json`](package.json).

## Configure

Add the following to your package.json

```json
"eslintConfig": {
  "extends": "@meteorjs/eslint-config-meteor"
}
```

# Todo

- Figure out peerDependency installation.

Add section on peer dependency requirement.
Add section on peer dependency requirement.

I think a nicer way to do this would be great, but it should be stated
as a requirement for now.
