0
点赞
收藏
分享

微信扫一扫

检测代码重复率工具

菜菜捞捞 2021-09-30 阅读 165

随着各个项目的迭代更新,项目中不可避免的会出现一些重复的代码,这可能是CTRL C + CTRL V造成的,也有可能是因为不同的项目成员重复造轮子造成的。在《Software Clone Detection and Refactoring》一文中,对重复代码的类型进行了定义:

  • 完全一致的代码或者只修改了空格和评论
  • 结构上和句法上一致的代码,例如只是修改了变量名
  • 插入和删除了部分代码
  • 功能和逻辑上一致的代码,语义上的拷贝

不难看出,越是往后重复的代码就越难被检测出来,所以我们应该尽早对项目进行代码重复率的管控。

检测工具介绍

jsinspect

https://github.com/danielstjules/jsinspect
jsinspect 利用 babylon 对于 JavaScript 或者 JSX 代码构建 AST 语法树,根据不同的 AST 节点类型,譬如 BlockStatement、VariableDeclaration、ObjectExpression 等标记相似结构的代码块。同时还可以自由指定一个阈值,以确定要分析的最小节点子集。

用法:

安装:npm install -g jsinspect
用法:jsinspect [options] <paths ...>
示例:jsinspect -I -L -t 20 --ignore "test" ./path/to/src
意思是检查 ./path/to/src 路径下文件 -I不匹配标识符 -L不匹配文字 -t 20匹配大于20个字节的代码 忽略test文件

Options:

  -h, --help                         output usage information 输出使用信息
  -V, --version                      output the version number 输出版本号
  -t, --threshold <number>           number of nodes (default: 30) 检查字节阀值(默认是30个字节)
  -m, --min-instances <number>       min instances for a match (default: 2) 匹配的最小实例(默认2个字节)
  -c, --config [config]              path to config file (default: .jsinspectrc) 配置文件路径
  -r, --reporter [default|json|pmd]  specify the reporter to use 指定类型使用
  -I, --no-identifiers               do not match identifiers 不匹配标识符
  -L, --no-literals                  do not match literals 不匹配文字
  -C, --no-color                     disable colors 禁用颜色
  --ignore <pattern>                 ignore paths matching a regex 忽略与正则表达式匹配的路径
  --truncate <number>                length to truncate lines (default: 100, off: 0) 截线长度
  --debug                            print debug information 打印调试信息

缺点

  • 仅支持.jsx、.js文件类型(可以把源码下下来改一下loader);
  • 库从17年后作者不再更新维护
  • 展示的结果很不友好


jscpd

https://github.com/kucherenko/jscpd
jscpd采用Rabin-Karp算法,能够在150多种编程语言中检测重复代码。

用法

安装:npm install -g jscpd
用法:jscpd /path/to/code or jscpd --pattern "src/**/*.js"
配置参数:
--min-tokens, -k:代码的最小块大小。小于的代码块min-tokens将被跳过,默认为50;
--min-lines,-l:最小代码行数,默认为5;
--max-lines, -x: 最大代码行数,默认为1000;
--max-size, -z:最大文件大小,单位为kb,默认100;
--threshold, -t:重复级别的阈值,当项目重复级别大于该阈值时报错退出,默认为空;
--ignore,-i:忽略的文件类型;
--reporters,-r:输出类型

  • console -报告要克隆的克隆;
  • consoleFull-报告有关要克隆的克隆的代码块;
  • json-jscpd-report.json具有克隆报告的输出文件为json格式;
  • xml-jscpd-report.xml带有xml格式的克隆报告的输出文件;
  • csv-jscpd-report.csv具有csv格式的克隆报告的输出文件;
  • markdown-输出jscpd-report.md文件,其克隆报告为markdown格式;
  • html-生成html报告到html/文件夹;
  • verbose -向控制台输出大量调试信息;
    --output, -o:报告目录的路径。JSON和XML报告将保存在此处;
    --mode,-m:检测质量的模式;
  • strict -使用所有类型的符号作为标记,仅跳过标记为已忽略的块。
  • mild -跳过标记为已忽略的块以及新行和空符号。
  • weak -跳过标记为已忽略的块以及新行以及空符号和注释。
    也可以把.jscpd.json文件放到项目根目录中:
{
  "threshold": 0,
  "reporters": ["html", "console", "badge"],
  "ignore": ["**/__snapshots__/**"],
  "absolute": true
}

输出:

输出文件:



首页:



重复代码块:

举报

相关推荐

0 条评论