Giter Club home page Giter Club logo

lannister's Introduction

lannister

Build Status Coverage Status

A Lannister always pays his technical debt

Keep calm and alwyas pay your debts

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

lannister's People

Contributors

kennethlarsen avatar madsobel avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.