tyrion

提利昂

关于工具

为什么要使用此工具

我们以“ 3S质量因子”为代码以Theodo质量定义：

• ？稳定：没有错误，代码易于维护
• 速度：快速可扩展（尺度上的速度）
• 安全：已确保

我们认为团队需要以下内容才能提供高质量的代码：

• ？有足够的时间
• ？知道如何做质量
• 有正确的工具
• ？能够衡量质量

提利昂的目标是在最后一点帮助您“？能够衡量质量”。

监视技术债务

我们将技术债务定义为防止质量的每条代码或架构。通过各种实验，我们看到，当我们监视技术债务的演变时，更有可能阻止其增加。过去，我们尝试了不同的方法来管理和测量它（Trello卡，Google Docs，Post-it，..），但是我们从未找到一种无痛的解决方案，可以让我们：

• ？
• 迅速获得概述和债务的演变
• ？‍？对债务有简单的优先级

所以我们创建了提利昂。您现在可以：

• 用特定的注释（？）在代码中直接记录并直接在代码中更新债务
• 自动获取图表和帕累托斯，可帮助您确定下一个代码的哪一部分（，？‍？）

安装：

您需要将Tyrion与节点V12或V14一起使用。它目前不使用卓越版本，主要是因为使用主要工具的问题：Nodegit。

全球安装Tyrion： npm i -g tyrionl （是的，最终l的tyrionl ，不是错字）。

用法：

使用以下选项运行tyrion

  -p, --path [scanDirectory]  The path of the directory you want to analyse
  -e, --evolution [days]      Get the evolution of the debt since X days
  -b, --branch [days]         Specify the branch used for the evolution analysis. (Default to master)
  -n, --nobrowser [browser]   Don't open the report after being generated
  -c, --csv [csv]             export the debt data into a csv file
  -d, --devs [devs]           Get information about who is contributing the most to quality (Beta)
  -h, --help                  output usage information

例子：

• tyrion -p ./src -c获得当前的债务评分并创建CSV报告
• tyrion --evolution 28 -p .从上一项提交开始，要在28天内获得债务的演变。
• tyrion --evolution 28 -b prod -p .从POR分支机构的最后一个提交开始，要在28天内获得债务的演变。

写债务评论

您可以将以下债务标签用于相同的结果： @debt ， TODO ， FIXME 。

提利昂（Tyrion）解析了以下约定遵循的评论的文件：

 /**
 * @debt DEBT_TYPE:SUB_TYPE
 */

以下债务有默认分数：

• 建筑学
• 漏洞
• 错误风险
• 安全
• 安全风险
• 质量
• 测试
• Doc
• CI
• 部署
• dev-env

您不需要指定sub_type，因此最少的示例可以是：

 /**
 * @debt quality
 */

您可以添加评论，以遵循此公约：

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

一个完整的例子可能是：

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

解析器将寻找包含“ @debt”的所有行，并以*或#开始，该行应涵盖大多数Web编程语言。

覆盖并设定每种类型的价格

您可以通过在项目的根目录中创建.tyrion-config.json文件来覆盖债务项目的默认定价。您甚至可以创建自己的类型。这是默认一个：

 {
  "pricer": {
    "bug": 100,
    "architecture": 100,
    "bugRisk": 5,
    "security": 100,
    "securityRisk": 10,
    "quality": 5,
    "test": 5,
    "doc": 3,
    "ci": 30,
    "deploy": 10,
    "devEnv": 10,
    "outdated": 5
  },
  "standard": 100,
  "ignorePath": [
    "node_modules",
    "README.md"
  ],
  "debtTags": [
    "@debt",
    "TODO",
    "FIXME"
  ]
}

编写良好的实践例子

您还可以将某些文件标记为“ joconde”一个文件，该文件完美地遵循了代码质量的标准。您可以将以下标签用于相同结果： @best ， @standard ， JOCONDE 。

示例： // JOCONDE React:component "The standard can be find here: http....."

忽略路径

您可以通过在配置文件中使用"ignorePath"选项来忽略包含某些字符串的文件：

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

更改默认债务标签

您可以更改用于检测哪个评论行的默认债务标签，应将其视为提利昂的债务评论。 debtTags .tyrion-config.json

  "debtTags": [
    "@debt",
    "TODO",
    "FIXME"
  ]

过滤[删除]

此功能不再使用，因为它没有使用。

您可以通过所需的任何类型的债务过滤结果--filter滤波器。它将比较过滤器后作为参数所传递的类型和字符串。

示例： tyrion -p ./src --filter bug