README.md

vile-hlint

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

Requirements

• Node.js
• Haskell
• cabal-install

Installation

Currently, you need to have hlint installed manually.

Example:

npm i -D vile vile-hlint
cabal install hlint

Config

hlint:
  config:
    path: "custom hintfile path"

Allowing Files

If no vile.allow or hlint.allow is set, . is used.

hlint:
  allow:
    - src

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

• Brent Lintner - @brentlintner

Architecture

This project is currently written in JavaScript. HLint provides a JSON CLI output that is currently used until a more ideal IPC option is implemented.

• bin houses any shell based scripts
• src is es6+ syntax compiled with babel
• lib generated js library

Developing

cd vile-hlint
npm install
cabal install hlint
npm run dev
npm test