wheatandcat/leasot-report

# leasot-report

[![npm version](https://badge.fury.io/js/leasot-report.svg)](https://badge.fury.io/js/leasot-report)
[![Build Status](https://travis-ci.org/wheatandcat/leasot-report.svg?branch=master)](https://travis-ci.org/wheatandcat/leasot-report)
[![Code Climate](https://codeclimate.com/github/wheatandcat/leasot-report/badges/gpa.svg)](https://codeclimate.com/github/wheatandcat/leasot-report)
[![Test Coverage](https://codeclimate.com/github/wheatandcat/leasot-report/badges/coverage.svg)](https://codeclimate.com/github/wheatandcat/leasot-report/coverage)
[![Issue Count](https://codeclimate.com/github/wheatandcat/leasot-report/badges/issue_count.svg)](https://codeclimate.com/github/wheatandcat/leasot-report)
[![Dependency Status](https://gemnasium.com/badges/github.com/wheatandcat/leasot-report.svg)](https://gemnasium.com/github.com/wheatandcat/leasot-report)

leasot-report is a command line tool that uses [leasot](https://github.com/pgilad/leasot) to output TODOs and FIXMEs in your code

![image](./doc/summary.png)

![image](./doc/source.png)

## Usage


```sh
npm i -g leasot-report

 or

npm i --save-dev leasot-report
```

Run the output reports
```sh
$ leasot-report src

$ ls leasot-reports/
 example        index.html

```

## Supported extensions
".js", ".jsx", ".css", ".sass", ".java", ".go", ".php", ".rb"

## Demos

### example
https://wheatandcat.github.io/examples-pages/leasot-reports/index.html

### storybook
https://wheatandcat.github.io/leasot-report/