2.4 KiB
Setup Development Environment
This document describes how developers can contribute by adding rules for ESLint-plugin-Meteor. Before implementing a rule, create an issue to discuss the proposed rule. After getting some feedback, you can develop the rule. Every rule must have adequate tests and documentation. Reading the ESLint developer guide is a good start.
Run the following commands to set up ESLint-plugin-Meteor in development mode.
# clone repository
$ git clone git@github.com:dferber90/eslint-plugin-meteor.git
# install dependencies
$ npm install
Development Setup
This plugin uses ES2015 which is transpiled to ES5 by Babel. All files in lib/ are transpiled to dist/.
# start transpiling continuously
$ npm run build:w
# make some changes to the code
# run tests
$ npm run unit-test
Linking
npm can link packages. This makes version set up for development available in other projects. It enables testing new rules on real projects. To be able to link this package to another project, that one has to be set up correctly first.
# Make this package available globally
$ npm link
# In a project using this plugin, install the linked version
$ npm link eslint-plugin-meteor
Read more about linking here.
Creating rules
Creating rules for ESLint-plugin-Meteor is best done by using the scaffolding tool.
$ npm run rule
This will scaffold all required files for the new rule. Add the implementation, tests and description of your rule to these files.
After implementation, the rule has to be exported from lib/index.js.
Recommended options for the rule should be set as well (also in lib/index.js).
Give back
After making sure all tests pass and the test-coverage is at 100%, please send a PR to dferber90/eslint-plugin-meteor. Git commits messages must follow the conventional changelog format.
Essential Development Resources
These specs and tools help enormously when developing new rules.