Identify common style and maintainability issues in your JavaScript code.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
lib
test
.editorconfig
.eslintrc
.gitattributes
.gitignore
.vile.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
LICENSE
README.md
coffeelint.json
package-lock.json
package.json

README.md

vile-eslint CircleCI score-badge coverage-badge dependency-badge

A Vile plugin for identifying common style and maintainability issues in your JavaScript code (via ESLint).

Requirements

Installation

npm i -D vile vile-eslint

Usage

If you don't have an ESLint config file create one first:

npx eslint --init

Then:

npx vile a -p eslint

Or:

npx vile a -p eslint some/file.js some/path

Ignoring Files

Along with any ignore patterns in .eslintignore, vile.ignore and eslint.ignore data will be added to the CLIEngine call.

Example:

eslint:
  ignore:
    - .test

Allowing Files

You can set vile.allow or eslint.allow to allow certain files.

Example:

eslint:
  allow:
    - src

TypeScript Support

If you are using something like typescript-eslint-parser, you might not see any issues reported unless you add a glob pattern to your src path.

An example .vile.yml (taken from vile's):

eslint:
  allow:
    - src/*
  ignore:
    - lib

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

Developing

cd vile-eslint
npm install