vile-comment

A Vile plugin for keeping track of TODO/HACK style comments in your code.

Requirements

• Node.js

Supported Checks

• TODO
• HACK
• NOTE

Installation

This plugin is already packaged with vile's core lib, but you can also install it manually:

npm i -D vile vile-comment

Usage

vile a -p comment

Config

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

comment:
  ignore: [ "a/**", "b" ]

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

• Brent Lintner - @brentlintner

Architecture

• src is es6+ syntax compiled with Babel
• lib generated js library

Developing

cd vile-comment
npm install
npm run dev
npm test