https://github.com/wheatandcat/leasot-report

Generate leasot reports in HTML
https://github.com/wheatandcat/leasot-report

fixme todo

Last synced: about 1 month ago
JSON representation

Generate leasot reports in HTML

• Host: GitHub
• URL: https://github.com/wheatandcat/leasot-report
• Owner: wheatandcat
• License: mit
• Created: 2017-09-26T16:04:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-03T08:34:27.000Z (over 7 years ago)
• Last Synced: 2024-04-25T05:42:45.475Z (about 1 year ago)
• Topics: fixme, todo
• Language: JavaScript
• Homepage:
• Size: 974 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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/