https://github.com/meteor/eslint-config-meteor
The ESLint configuration recommended by the Meteor Guide http://guide.meteor.com/
https://github.com/meteor/eslint-config-meteor
Last synced: 9 months ago
JSON representation
The ESLint configuration recommended by the Meteor Guide http://guide.meteor.com/
- Host: GitHub
- URL: https://github.com/meteor/eslint-config-meteor
- Owner: meteor
- License: mit
- Archived: true
- Created: 2016-11-16T06:01:23.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-04T07:25:40.000Z (almost 5 years ago)
- Last Synced: 2024-09-25T13:04:45.930Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 7
- Watchers: 7
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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).
> This repository has been merged into Meteor main repository. You can [find it there](https://github.com/meteor/meteor/tree/devel/npm-packages/eslint-config-meteor).
# 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 [peer dependencies](https://nodejs.org/en/blog/npm/peer-dependencies/) listed in its [`package.json`'s `peerDependencies` section](package.json). Warnings will be encountered during the installation step above if the project doesn't already use these modules.
The peer dependencies can be installed manually by following the `package.json` specification and using `meteor npm install --save-dev ` or, alternatively, using an automated tool:
```sh
$ # Install `install-peerdeps` within the current Meteor tool version.
$ meteor npm install --global install-peerdeps
$ # Run the newly installed `install-peerdeps` to install this package and its dependencies.
$ meteor install-peerdeps --dev @meteorjs/eslint-config-meteor
```
## Configure
Add the following to the project's `package.json`:
```json
"eslintConfig": {
"extends": "@meteorjs/eslint-config-meteor"
}
```