Ensure consistent style in your CoffeeScript 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
.jshintrc
.vile.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
LICENSE
README.md
coffeelint.json
package-lock.json
package.json

README.md

vile-coffeelint Circle CI score-badge coverage-badge dependency-badge

A Vile plugin for ensuring consistent style in your CoffeeScript code (via CoffeeLint).

Requirements

Installation

npm i -D vile vile-coffeelint

Usage

configure CoffeeLint

npx coffeelint --makeconfig > coffeelint.json

run the plugin

npx vile a -p coffeelint

Config

By default, config defaults to coffeelint.json.

You can specify a custom one, instead:

coffeelint:
  config: path/to/cs_config.json

Ignoring Files

vile.ignore is used as a base, but you can add onto it:

coffeelint:
  ignore:
    - some/path/**
    - file
    - dir

Allowing Files

vile.allow is used as a base, but you alternatively specify:

coffeelint:
  allow:
    - dir

Versioning

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-coffeelint
npm install
npm test

To run compile task with file watch in the background:

npm run dev

To run tests with coverage:

npm run test-cov

See package.json for other available scripts.

Architecture

The node library written in basic JavaScript.

The test code is written in CoffeeScript.