https://github.com/kennethlarsen/lannister

💸 A Lannister always pays his technical debt
https://github.com/kennethlarsen/lannister

automated-analysis static-analysis static-code-analysis technical-debt

Last synced: about 17 hours ago
JSON representation

💸 A Lannister always pays his technical debt

• Host: GitHub
• URL: https://github.com/kennethlarsen/lannister
• Owner: kennethlarsen
• License: mit
• Created: 2017-12-13T11:33:14.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-16T09:35:42.000Z (over 7 years ago)
• Last Synced: 2025-10-11T20:29:09.013Z (14 days ago)
• Topics: automated-analysis, static-analysis, static-code-analysis, technical-debt
• Language: JavaScript
• Homepage: https://kennethlarsen.github.io/lannister
• Size: 462 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

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