Skip to content

A Yeoman generator to help with ESLint development

License

Notifications You must be signed in to change notification settings

iancmyers/generator-eslint

 
 

Repository files navigation

generator-eslint Build Status

The ESLint generator for Yeoman. This generator is intended to aid development within the ESLint project. It is designed to work within the top-level eslint directory.

Installation

First and foremost, you must have Node.js and npm installed. If you don't have Node.js installed, please download and install the latest version.

With Node.js installed, you can run this command:

npm i -g generator-eslint

Usage

The Yeoman generator currently supports the following commands:

eslint:plugin

If you want to create a new ESLint plugin, make sure you're in the top-level directory where you want the plugin to be created and type:

$ yo eslint:plugin

You'll be prompted for information about your plugin and it will generate a package.json file, README, and source code for a stub plugin.

eslint:rule

If you want to create a new ESLint rule, make sure you're in the top-level directory of an ESLint repo clone or an ESLint plugin and type:

$ yo eslint:rule

You'll be prompted for some information and then it will generate the files necessary for a new rule, including the source file, a test file, and a documentation file.

License and Copyright

Copyright 2014-2015 Nicholas C. Zakas. All rights reserved.

MIT License

About

A Yeoman generator to help with ESLint development

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%