npm-packages/eslint-config-meteor/README.md
This is an ESLint configuration for Meteor apps which implements the recommendations from the Meteor Guide's section on Code style.
Install by running:
meteor npm install --save-dev @meteorjs/eslint-config-meteor
Using
meteor npmis optional for this package, but best-practice for Meteor projects in general.
This package has several peer dependencies listed in its package.json's peerDependencies section. 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 <package> or, alternatively, using an automated tool:
$ # 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 npx install-peerdeps --dev @meteorjs/eslint-config-meteor
Add the following to the project's package.json:
"eslintConfig": {
"extends": "@meteorjs/eslint-config-meteor"
}