kennethlarsen / lannister

💸 A Lannister always pays his technical debt

lannister

A Lannister always pays his technical debt

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 Issues

Add support for arrow functions

Currently the function-validator only supports function name() syntax.

Check line length

Add a warning if a line is more than 80, 100 or 120 characters longs.
Maybe also add the line number in there?

Add line numbers to report lines

It would be neat to see which line number that Lannister is reporting issues on.

So
- [x] dummy-files/file.js has TODO comment. Consider refactor. (todo-comment)

Becomes
- [x] dummy-files/file.js has TODO comment on line 34. Consider refactor. (todo-comment)

Add testing

So far there is nothing.

Allow to pick output dir

With the flag -o

Check for console.(log/error/info etc.)

Linters such as eslint can already report for log's.
But would it be an idea to also do a check for this?

Uncommunicative Names

Inspired by reek we should add similar functionality to lannister: https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Name.md

Check for TODO comments

Nothing says techical debt more than

// TODO: ...

Add a warning if this is found.

Nested walking

Lannister should be able to check all JS files of sub folders in the root folder provided in lannister dir/

Remove "dummy-files" from source

The "dummy-files" folder made good sense prior to having tests, but now that we have that, I think we should remove the folder.

If such a folder is needed, it should be kept outside the Lannister repo.

Update license in package.json

Noticed that you added the MIT license to source, but the license in package.json is still set to "ISC".

It skips first file in dir

Right now it starts at index 1 in the file array. This means it skips the first file in the directory.

Bug when a function with no params are found

Shit hits the fan when a line like below is found

function someFunc() { // TODO: Figure out what to do about the dragons }

Add possibility to use a custom config

Allow users to customize rules

Only check for .js

Right now we look for everything