@hygiene/core v0.0.4

hygiene

Keep your TODOs and FIXMEs healthy

Supported languages

hygiene supports any languages not only JavaScript. you can see a list of languages in here.

https://github.com/pgilad/leasot#supported-languages

Install

npm install -g @hygiene/cli

Or you can use hygiene with npx without npx install.

npx @hygiene/cli

Usage

$ npx @hygiene/cli --help
hygiene <command>

Commands:
  hygiene run [glob]

Global Options
  --json            Report as JSON                    [boolean] [default: false]
  --ignore-pattern  Pattern of files to ignore          [string] [default: null]
  --ignore-path     Specify path of ignore file
       [string] [default: "/Users/leko/.ghq/github.com/Leko/hygiene/.gitignore"]
  --ignore          Disable use of ignore files and patterns
                                                       [boolean] [default: true]

Plugin Options: github-url
  --repository  Specify current repository. ex. `owner/repo`
                                              [string] [default: "Leko/hygiene"]

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Examples

Disable ignore feature

hygiene run --no-ignore

Parse non-prefixed issue(ex. #123) as Leko/hygiene

hygiene run --repository Leko/hygiene

Set GitHub access token to fetch issue or pull request

GITHUB_TOKEN=xxx hygiene run --no-ignore

Contribution

1. Fork this repository
2. Write your code
3. Run tests
4. Create pull request to master branch

Development

git clone git@github.com:Leko/hygiene.git
cd hygiene
npm i
npx lerna bootstrap
npm test

License

This package under MIT license.