We defined at Theodo quality by the fact that the code:

• 🐛 has no bugs
• 🚧 is easy to maintain / make evolutions
• 🚀 is fast
• ⚙️ is scalable
• 🔒 is secured

To be able to deliver code of high quality, a team needs to:

• 📆 Have enough time
• 🗹 Know how to do quality
• 🛠️ Have the right tools
• 📈 Be able to measure quality

The goal of tyrion is to help you on the last point "📈 Be able to measure quality".

We defined technical debt as every piece of code or architecture that prevent quality. Our strong hypothesis is that monitoring the technical debt is the best way to prevent it to explode. At Theodo, we tried different ways of managing and measuring it in the past (Trello cards, google docs, post-it, ..) but we never find a simple solution that would allow us to:

• 🗺️ Discover and map the debt while coding
• 📈 Quickly get a measure of the current debt
• ♻️ Update or remove the debt item when it has changed or been removed
• ⏭ Know and prioritize what is the best next debt item the team should tackle down

Tyrion will help you at least for the first three points by suggesting you to put the debt information of your project right into the code and providing you a tool that will then calculate the total debt of your project for you. As the information will be directly in the code, it will be very easy to add, update and delete each item. Then calculate it with Tyrion is done in an instant.

Install Tyrion globally: npm i -g tyrionl (yes, tyrionl with a final l, it's not a typo).

Run tyrion with the following options

  -p, --path [scanDirectory]  The path of the directory you want to analyse
  -e, --evolution [days]      Get the evolution of the debt since X days
  -f, --filter [type]         filter by a particular debt type
  -n, --nobrowser [type]      Don't open the report after being generated
  -h, --help                  output usage information

Example:

• tyrion -p ./src to get the current debt score
• tyrion --evolution 28 -p . to get the evolution of the debt during 28 days starting from the last commit.

You can use either the following debt tag for the same result: @debt, TODO, FIXME.

Tyrion parses the files looking for comments that follows the following convention:

/**
 * @debt DEBT_TYPE:SUB_TYPE
 */

There is a default score for the following DEBT_TYPE:

• architecture
• bug
• bug-risk
• security
• security-risk
• quality
• test
• doc
• ci
• deploy
• dev-env

You don't need to specify a SUB_TYPE, so a minimum example can be:

/**
 * @debt quality
 */

You can add a comment to provide more details about the debt item by following this convention:

/**
 * @debt DEBT_TYPE:SUB_TYPE "Author: comment"
 */

A complete example could be:

/**
 * @debt security:sql-injection "Maximet: The request is not escaped when being called from the command"
 */

The parser will look for all lines containing '@debt' and starting either by * or # which should cover most web programing languages.

You can override the default pricing of debt items by creating a .tyrion-config.json file in the root directory of your project. You can even create your own types. Here is the default one:

{
  "pricer": {
    "bug": "100",
    "architecture": "100",
    "bug-risk": "5",
    "security": "100",
    "security-risk": "10",
    "quality": "5",
    "test": "5",
    "doc": "3",
    "ci": "30",
    "deploy": "10",
    "dev-env": "10",
    "outdated": "5"
  },
    "standard": 1000,
    "ignorePath": [
      "node_modules",
      "README.md"
    ]
}

You can also mark some files as being "Joconde" a file that follows perfectly the standard of code quality. You can use either the following tag for the same result: @best, @standard, JOCONDE.

Example: // JOCONDE React:component "The standard can be find here: http....."

You can filter the result by any type of debt you want with the option --filter. It will compare the type and the string you pass as an argument after filter.

Example: tyrion -p ./src --filter bug

You can ignore files containing certain strings by using the "ignorePath" option in the config file:

"ignorePath": [
  "node_modules",
  "README.md"
]

Todo: add capability for multiple ignore paths in array (currently only takes singular string)

1. Install the dependencies npm i
2. Run npm start during development to see your last changes in action.