jscpd统计项目中的代码怎么重复使用


本篇内容主要讲解“jscpd统计项目中的代码怎么重复使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“jscpd统计项目中的代码怎么重复使用”吧!jscpd是一个开源的js工具库,用于检测项目的代码重复率,针对复制粘贴的代码尤其有效,支持超过150种的源码文件格式。我们在前端项目中,无论是原生的javascript、css、html代码,还是使用typescript、less、vue、react等代码,都能较好的识别出项目中的重复代码。当然,这里的重复,更多的指代码完全重复,即代码行与代码字符串,都相同。下面,先看下如何使用它。我们先以全局方式,安装该工具库:安装成功后,系统就有一个全局命令 jscpd,可以查看版本号,当前最新版本是 3.5.3,如下所示:安装成功后,我们就可以很方便的使用它。例如,我们需要统计一个文件 app.js,只需要在文件目录执行以下命令:执行成功后,在命令行界面会显示结果,如下图所示:图中的内容,我们下面一一做个说明说明:Clone found (javascript)显示找到的拷贝的重复代码块,这里是javascript文件。
并且会显示重复代码在文件中具体的行数,便于查找。HTML report saved to reporthtml这句话的意思是,会在文件目录下输出对应报告的html页面,一般默认是 reporthtml 目录下,用于在页面中展示结果。Format文件格式,这里是 javascript,还可以是 typescripttsx 等。Files analyzed已分析的文件数量,统计项目中的代码文件数。Total lines所有文件的总行数。
这里只有一个文件,总行数是105行。Total tokens所有的token数量。
这里一般以 标识符/变量等数字字符串空格符号 等等作为一个 token 来统计数量。
一行代码一般包含几个到几十个不等的token数量。Clones found找到拷贝的重复块数量。Duplicated lines重复的代码行数,以及占比。
在表格的 Total 行里,重复代码的占比就是代码行的重复度了,这里是18.1%。Duplicated tokens重复的token数量,以及占比。Found 0 clones找到了1个重复块。Detection time检测耗时。由此可知,./app.js 检测1个文件,发现了1个重复快,在总行数为105行的代码中,共有19行代码完全重复,重复度为 18.1%。以上示例是比较简单的,直接检测单个文件,通过命令行检测单个文件,打印结果,并默认生成report报告的页面。
如果是在当前主流的前端项目中,由于很多文件是辅助工具如依赖包、构建、文档等,并不是有效的代码,需要排除。这种情况下,我们一般使用配置文件的方式,通过选项配置规范 jscpd 的使用场景。jscpd 的配置选项可以通过以下两种方式创建:在项目根目录下创建配置文件 .jscpd.json,然后在该文件中增加具体的配置选项;也可以直接在 package.json 文件中添加如果项目根目录下没有 package.json 文件,可以自行添加一个,然后在该件中个增加对应的配置。无论是Vue还是React项目,使用大致都一样,如下,在 package.json 中增加 jscpd 配置属性:以上是一个常用的配置,具体说明:threshold 表示重复度的阈值,超过这个值,就会打印错误报警。如阈值设为 1,当重复度为18.1%时,会报错:ERROR: jscpd found too many duplicates (18.1%) over threshold (1%)
虽然报错,但代码的检测仍然会正常完成。reporters 表示生成结果检测报告的方式,一般有以下几种:console:控制台打印html:创建可访问的 html 页面json:输出 json 格式的文件报告xml:输出 xml 格式的文件报告csv:输出 csv 格式的文件报告markdown:输出 md 格式的文件报告consoleFull:控制台完整打印重复代码块verbose:控制台输出 debug 信息ignore检测时会忽略的文件目录或文件,用于过滤一些非业务代码,如依赖包、构建或静态文件等format需要进行重复度检测的源代码格式,目前支持150多种,我们常用的如 javascripttypescriptcss 等absolute在检测报告中使用绝对路径除此以外,还有很多配置属性,我们这里不在一一介绍。上面介绍会输出重复度检测报告,我们在项目中设置好配置文件以后,执行以下命令:项目中的业务代码,通常会选择放在 ./src 目录下,所以我们可以直接检测该目录。
-o 'report' 通过命令行参数,输出检测报告到项目根目录下的 report 文件夹中——当然也可以自定义目录,这时候就会生成对应的页面文件:如上所示,本质上是一个本地网页,而且是基于 VUE 框架创建的网页,可以在浏览器访问查看,界面长这样:从上图可知,检测了149个文件,其中存在8块拷贝复制的代码,代码行计算的重复度是 1.18%,非常直观。通过生成本地免费云主机域名网页直接展示所有的检测报告,并且还能查看到重复的代码在哪:上图可以看到,在两个 tsx 组件文件中,存在一段重复的代码,也标识除了这两段代码在文件中具体行数。上面介绍的是单个项目的重复度检测,如果有多个项目,且存在代码的复制粘贴现象,也可以通过jscpd工具进行检测处理。
我们只需要在多个项目的上层目录下新建一个 package.json 文件,设置相应的配置选项,就能根据设置检测这些项目间的重复代码。这里需要注意的是,一般只需要检测业务代码 src,在配置文件中 ignore 属性的忽略目录,需要带上各项目的项目名称。这样,就能快速检测出多个项目中的重复代码,仍然可在命令行输出基本信息,以及对应的report页面报告。当我们使用jscpd执行项目的重复度检测时,由于一些重复代码可能是必要的,不想检测,可以使用代码注释标识的方式,让这部分代码不用检测。
在代码的首尾位置添加相应注释,jscpd:ignore-startjscpd:ignore-end,包裹代码即可。如在js代码中,可以这样使用:在css及各种预处理中,也是与js中的用法一样:如下在html中的使用:通过以上注释标识以后,这部分的代码就不会再被统计为重复代码了。到此,相信大家对“jscpd统计项目中的代码怎么重复使用”有了更深的了解,不妨来实际操作一番吧!这里是百云主机网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

相关推荐: 微信小程序怎么实现九宫格效果

今天小编给大家分享一下微信小程序怎么实现九宫格效果的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。1.九宫格实现示例图:Tips:说明:使用dis…

免责声明:本站发布的图片视频文字,以转载和分享为主,文章观点不代表本站立场,本站不承担相关法律责任;如果涉及侵权请联系邮箱:360163164@qq.com举报,并提供相关证据,经查实将立刻删除涉嫌侵权内容。

Like (0)
Donate 微信扫一扫 微信扫一扫
Previous 06/06 16:13
Next 06/06 18:03

相关推荐