# lannister

> A Lannister always pays his technical debt. This is a tool to help you do just that.

Latest version **1.4.0** (published 2018-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install lannister
pnpm add lannister
yarn add lannister
bun add lannister
```

Provides the command `lannister`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2018-06-16 |
| First published | 2017-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 181.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kenneth Larsen |
| Maintainers | kennethlarsen |
| Keywords | technical, debt |

## Links

- npm: https://www.npmjs.com/package/lannister
- npm.io page: https://npm.io/package/lannister

## Dependencies (3)

- [ora](https://npm.io/package/ora.md) ^2.0.0
- [meow](https://npm.io/package/meow.md) ^4.0.0
- [globby](https://npm.io/package/globby.md) ^8.0.1

## Recent versions

- 1.4.0 (latest) — 2018-06-16
- 1.3.0 — 2018-04-12
- 1.2.1 — 2018-04-11
- 1.2.0 — 2018-04-10
- 1.1.5 — 2018-01-20
- 1.1.3 — 2017-12-14
- 1.1.2 — 2017-12-14
- 1.1.1 — 2017-12-14
- 1.1.0 — 2017-12-14
- 1.0.0 — 2017-12-14

## README

# lannister
[![Build Status](https://travis-ci.org/kennethlarsen/lannister.svg?branch=master)](https://travis-ci.org/kennethlarsen/lannister)
[![Coverage Status](https://coveralls.io/repos/github/kennethlarsen/lannister/badge.svg?branch=master)](https://coveralls.io/github/kennethlarsen/lannister?branch=master)


A Lannister always pays his technical debt

![Keep calm and alwyas pay your debts](https://boomerandecho.com/wp-content/uploads/2014/04/Keep-Calm.jpg)

This is still in the early stages. Basically, I like the idea of auto generating a list of potential technical debt in a code base. 

## Install
`npm install -g lannister`

## Usage

`lannister src/` runs the the technical debt check on dir src/ and returns a report.md at current path.

If you want to change the path of the report.md you can use the output flag (`-o`) to change this.

`lannister src/ -o reports/`

Do this before your sprint planning sessions and remember to pay your technical debt in every sprint. If not, the Iron Bank will kill you.
 
## Current rules
* too-many-args: more than 4 args in a function
* too-long/file-too-long: file length more than 250 lines
* todo-comment: TODO comment found in code
* console-call: found statements like console.log()
* line-length: code line that is more than 100 characters long

---
_Source: https://npm.io/package/lannister · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._