Skip to content

jasonblanchard/eslint-watch

 
 

Repository files navigation

Eslint Watch (Release Notes)

Build Status Build status NPM version Dependancies devDependency Status Code Climate

Join the chat at https://gitter.im/rizowski/eslint-watch

Don't want to import Webpack, Grunt, or some other task package into your project? Then this is the tool for you. Eslint Watch is a simple command line tool that wraps Eslint. Eslint Watch provides file watching and command line improvements to the currently exisiting eslint command line interface. All commands that Eslint offers can be used with the addition of a watch command and a couple new templating views. Don't believe me? Checkout the code or some of the features below!

Requirements

To use this tool we require eslint to be installed on your project. The versions supported are:

  • "eslint": ">=0.19.0 <=2.0.0"

Getting started

To run eslint-watch without the global install, make an npm script.

  • npm install eslint-watch [-g]

Features added

  • Watching
    • Multi-directory watching
    • Runs a full directory lint before the watch
    • Press enter to rerun directory lint while watching
  • Eslint Overrides
    • Default directory linting. A directory is no longer required.
  • Simple formatters
    • simple-detail (default)
    • simple
    • simple-success

Options/Usage

esw [options] [file.js ...] [dir ...]

Options:
  -h, --help                  Show help
  -f, --format String         Use a specific output format - default: simple-detail
  -w, --watch                 Enable file watch
  -c, --config path::String   Use configuration from this file
  --rulesdir [path::String]   Use additional rules from this directory
  -v, --version               Outputs the version number
  --no-eslintrc               Disable use of configuration from .eslintrc
  --env [String]              Specify environments
  --ext [String]              Specify JavaScript file extensions - default: .js
  --plugin [String]           Specify plugins
  --global [String]           Define global variables
  --rule Object               Specify rules
  --ignore-path path::String  Specify path of ignore file
  --no-ignore                 Disable use of .eslintignore
  --ignore-pattern String     Pattern of files to ignore (in addition to those in .eslintignore)
  --no-color                  Disable color in piped output
  -o, --output-file path::String  Specify file to write report to
  --quiet                     Report errors only - default: false
  --stdin                     Lint code provided on <STDIN> - default: false
  --stdin-filename String     Specify filename to process STDIN as
  --init                      Run config initialization wizard - default: false

Functionality

Simple lint and watch

New Formatters

simple simple-success simple-detail

About

ESLint with simple watching capabilities

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%