在项目开发中统计代码行数的6种方式

这篇具有很好参考价值的文章主要介绍了在项目开发中统计代码行数的6种方式。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。


上一篇文章介绍了,如何使用工具检测项目中的代码重复度,可见博文 使用jscpd统计代码重复度。
本文将探索下,如何在前端项目统计代码的行数,目前博主所知的较方便的方式大概有6种,每种方式都对应的是不同的使用场景,下面将一一为大家介绍。

一、使用find和wc命令统计代码行数

直接在项目文件目录下使用命令行进行统计,是比较方便的,能统计所有的代码总行数、以及每个文件的行数、进行条件过滤统计等等,比如 findwc
findwc 两个命令是 LinuxUnix 系统中的常用命令,而在Windows系统下,如果安装了 Git,可以调出 Git Bash 工具,使用 findwc 命令统计代码行数。

Git Bash 可以在Windows系统中提供类似于 Unix shell 的命令行环境,包含了 GitUnix 工具常用的命令,方便管理、提高效率。

当前一般前端项目,核心业务代码基本都在 src 目录下,我们进入该目录,直接执行以下命令:

find . -type f -print | xargs wc -l

该命令,可以直接读取到所有的文件,并显示每个文件的代码行数,以及所有文件的总行数,如下图所示。

在项目开发中统计代码行数的6种方式
这是简单的文件读取,还可以通过各种条件过滤。

进行参数的过滤筛选

如进行文件格式过滤,以下命令只读取 .js.ts 格式的文件:

find . "(" -name "*.js" -or -name "*.ts" ")" -print | xargs wc -l

过滤代码文件中的空行,使用 grep -v "^$"

find . "(" -name "*.js" -or -name "*.ts" ")" -print | xargs | grep -v "^$" | wc -l

进行目录过滤,比如不统计 node_modules 目录:

find . -name "*.js" | grep -v "node_modules"  | xargs wc -l

命令参数简要说明

find:在给定路下寻找匹配的文件,-name表示文件名,-type文件类型
wc:统计文件中的文件行数、字数和字符数,-l统计文件的行数
grep:逐行搜索,找出匹配的内容,-v表示不匹配

在Windows下,还可以使用 PowerShell 命令行工具来统计项目的代码行数。

二、PowerShell工具统计代码行数

在项目的 src 目录下,我们只需要在该目录下运行 PowerShell 工具,打开命令行窗口,输入以下命令:

(Get-ChildItem -Recurse -File | Get-Content | Measure-Object).Count
## 63240

通过该命令,可以输出 src 目录下所有文件的行数总和,如果要过滤空行,可以使用 -Line 参数选项:

(Get-ChildItem -Recurse -File | Get-Content | Measure-Object -Line).Lines
## 58691

这里输出的就是不包含空行的代码行数。

条件过滤

如果要过滤文件格式,可以使用通配符:

(Get-ChildItem -Recurse "*.ts","*.js" | Get-Content | Measure-Object).Count

上面的格式过滤方式,无法使用路径,所以也可以使用 Where-Object 命令来过滤文件格式,可以限定路径为 .\src,如下所示:

(Get-ChildItem .\src -Recurse | Where-Object {$_.Name -like "*.ts" -or $_.Name -like "*.js"} | Get-Content | Measure-Object).Count

输出所有文件的行数

如果要输出每个文件的行数:

Get-ChildItem -Recurse -File | ForEach-Object {Write-Output $_.FullName $(Get-Content $_.FullName | Measure-Object).Count}

在项目开发中统计代码行数的6种方式

PowerShell相关命令的简要说明

Get-ChildItem:获取指定目录中的文件和子目录的列表。在 PowerShell 中还可以使用 dir 命令,效果差不多。
-Recurse:命令参数,用于在搜索目录时递归子目录。
Get-Content:读取文本文件的内容,包含文件行数、字符、字节等数据。
Measure-Object:用于对一组对象进行测量和计算,如进行求和。
Where-Object:根据指定条件筛选过滤对象集合的数据。
ForEach-Object:迭代命令,对于输入的对象组中的每个对象进行指定操作,可用于遍历文件。
Write-Output:将指定的字符串或值输出到 PowerShell 控制台。

三、git命令

除了以上两种命令行统计方案以外,还可以使用git命令来统计代码行数,命令也很简单,主要使用到以下两个命令:

  • git ls-files:列出项目中所有的文件,可用于查看项目中文件的代码行数和总代码行数。
  • git log:获取所有提交的历史记录,通过记录,统计分支下的修改代码的行数。

git ls-files

如下,统计项目中所有文件的总代码行数:

git ls-files | xargs cat | wc -l
## 58927

但需要注意的是:如果使用git统计,需要代码已经提交入库到git仓库,否则,统计命令会报错:

git ls-files | xargs cat | wc -l
## fatal: not a git repository (or any of the parent directories): .git

统计每个文件的代码行数,命令如下:

git ls-files | xargs wc -l

在项目开发中统计代码行数的6种方式
显示文件的行数以及总代码行数。

从上面命令可看出,使用 git ls-files 和前文提到的 find 较相似,也可以对它的结果进行过滤。

git ls-files '*.tsx' '*.js' | grep -v 'src/assets' | xargs wc -l

以上命令,统计文件格式为 .tsx.js 的文件,并且会过滤掉 src/assets 目录下的文件,可以通过这种方式进行自定义的筛选。

git log

也可以使用git log命令,统计对应分支下的修改代码的行数。

git log --no-merges --pretty=tformat: --numstat | awk '{ add += $1; subs += $2; loc += $1 - $2 } END { printf "added lines: %s, removed lines: %s, total lines: %s\n", add, subs, loc }'

这里统计了当前分支下的代码行数,包含增加的行数、删除的行数、以及代码总行数,如下图所示:

在项目开发中统计代码行数的6种方式
也可以增加一些参数,通过这些参数进行条件过滤:

–no-merges:是去除该提交中merges的代码,因为开发人员有可能会merge其他分支的代码,此时应该去除
–since= --until=:是要统计修改记录的开始和结束时间,当统计某个迭代,就是迭代开始时间和结束时间
–author:是指修改代码的人 过滤多人时使用 | 分开
–pretty=:控制显示的记录格式
–numstat:对增加和删除的行数进行统计 第一列显示的是增加的行数 第二列显示的是删除的行数

git log master --no-merges --since=2023-03-01 --until=2023-3-26 --author="zuozhe" --pretty=tformat: --numstat | awk '{ add += $1 ; subs += $2 ; loc += $1 - $2 } END { printf "added lines: %s removed lines : %s total lines: %s\n",add,subs,loc }'
## added lines: 28750 removed lines : 7767 total lines: 20983

如上命令所示,统计了 master 分支下,时间从 2023-03-012023-3-26之间,提交人为 zuozhe 的所有修改过的代码行数。

四、代码编辑器插件

现在的代码编辑器也有提供一些插件,用于统计代码行数,比如博主使用的 VS Code,就很方便。
这里介绍 VS Code Counter 插件,它能统计项目代码行数、注释行数、以及空行,并且还会展示每个文件的行数以及分不同格式的文件显示。

首先,在插件中心安装该插件,然后使用快捷键 ctrl + shift + p,在输入框选择 VSCodeCounter: Count lines in directory,接着会出现项目目录输入框,默认是当前工作目录,可以更改。

在项目开发中统计代码行数的6种方式
在项目开发中统计代码行数的6种方式
确定好项目路径以后,回车就会显示已选路径下的项目文件代码的统计行数,以 .md 文件的形式展示出来,如下图:

在项目开发中统计代码行数的6种方式
该插件会在当前目录下,生成一个名为 .VSCodeCounter 的目录,里面放置生成的各种代码统计数据,可以自行查询。

五、jscpd

前文提到上一篇博文有介绍如何统计代码重复度,使用了 jscpd 工具库,它当然也有统计项目代码行数的能力。
如下图所示,会显示整个项目总的代码行数,Total 行,更多的使用可查看上篇博文。

在项目开发中统计代码行数的6种方式

六、自己实现一个

除了使用以上5种方式以外,我们也可以自己动手,实现一个读取项目代码行数的工具。
而要想实现一个简单的代码行数的统计工具,只需要以下三个步骤:

  1. 迭代遍历项目目录下的所有文件
  2. 读取文件的内容,行数使用换行符 \n 进行判断即可
  3. 计算所有的代码行数

对于前端同学,使用 nodejs 可以很好的完成这个事情,如迭代文件,代码如下:

// 可以通过执行命令传入目录参数
const params = process.argv.splice(2)
const root = params[0]

// 遍历读取文件
let stat = fs.statSync(root)
if (stat.isDirectory()) {
  let files = fs.readdirSync(root)
  for (let file of files) {
    file = `${root}/${file}`
    const dirStat = fs.statSync(file)
    if (dirStat.isDirectory()) {
      queryAllFiles(file)
    } else {
      // 读取文件行数
    }
  }
} else {
  // 读取文件行数
}

下面是,读取文件内容和行数:

// 读取文件内容,通过 `\n` 换行符分割内容后,统计长度,即行数
let fileContent = fs.readFileSync(path)  
fileContent = fileContent.toString()
const fileLines = fileContent.split('\n')
const lines = fileLines.length
console.log(path + ' ' + lines)

读取了每一个文件的行数,我们只需要对它们进行累加就可以统计出总的代码行数。

注释和空行

还可以统计代码注释,这里以前端的JS代码为示例,使用正则表达式,判断一行代码是否注释:

const reg = new RegExp('^(//|/\\*|\\*|\\*/)', 'g')
const commentLines = fileLines.filter(line => reg.test(line.trimStart())).length

注意,这里注释的判断,使用的JS代码相关的注释方式:///***/,TS代码也一样适用。
如果是使用其他注释方式的代码,需要定义对应的过滤。

空行的判断,也很简单,只需要判断一行没有内容即可:

const blankLines = fileLines.filter(line => line.trim() === '').length

忽略目录和文件

如果还要加条件进行过滤筛选,也比较方便,只需要在循环迭代送文件时进行过滤。
比如我们需要忽略掉 'node_modules''dist'等目录:

// 定义过滤的目录,也可以使用配置文件、命令参数等方式
const ignores = ['node_modules', 'dist']

// 文件迭代时,忽略相应目录
for (let file of files) {
  const isNotIgnore = ignores.indexOf(file) > -1
  if (isNotIgnore) {
    continue
  }
  // ...
}

筛选文件和目录的方式较类似,使用不同的比较方式而已。

文件格式的过滤:

// 只统计 js 和 ts 的代码文件
const formats = ['.js', '.ts']
if (stat.isFile()) {
  let ext = path.extname(file)
  if (formats.indexOf(ext) !== -1) {
    // 读取文件内容和行数
    // ...
  }
}

看看简单的执行结果,如下图所示:

在项目开发中统计代码行数的6种方式

总结

六种不同的方式,都能方便的统计代码行数,但也各有特点。
find 命令行适用不同系统,而 PowerShell 在Windows系统下可用;jscpd 统计代码行数和重复度。
安装了 Git 工具的,可以使用 git log 统计代码的修改行数、不同人员和时间段的各种提交修改等。
代码编辑器,有各种插件工具,除了统计代码行数,还能区分文件格式、注释行数、空行,也比较直观方便。
自己实现一个统计工具,能够实现更多的功能,并进行定制化处理,或者集成到构建工具中等等,满足更多需求。文章来源地址https://www.toymoban.com/news/detail-419518.html

到了这里,关于在项目开发中统计代码行数的6种方式的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • FineBI实战项目一(20):不同支付方式订单笔数分析开发

    点击新建组件,创建不同支付方式订单笔数组件。 选择线图,拖拽total_cnt到纵轴,拖拽pay_type到横轴,修改连线样式为雷达图。 修改横轴和纵轴的显示文字 添加组件到仪表板。 效果如下:

    2024年01月15日
    浏览(44)
  • 项目开发合并代码的流程(git的使用)

    1. 先 git add .   和   git commit -m \\\'xxxx\\\'   提交代码 保证本地代码已全部提交 2. 切换到 develop 分支 , 因为开发的时候 需要在develop分支下再创建一个分支 所以需要从自己写代码的分支切换到develop分支去    git checkout develop  3. git pull   拉取远程仓库的最新代码 4. 检查vscode等编

    2024年02月07日
    浏览(39)
  • (十四)devops持续集成开发——jenkins流水线使用pipeline方式发布项目

    本节内容我们使用另外一种方式pipeline实现项目的流水线部署发布,Jenkins Pipeline是一种允许以代码方式定义持续集成和持续交付流水线的工具。通过Jenkins Pipeline,可以将整个项目的构建、测试和部署过程以脚本的形式写入Jenkinsfile中,实现对整个流程的可视化管理和控制。在

    2024年02月21日
    浏览(60)
  • 鸿蒙开发实战项目(六十七):常见组件和容器低代码开发示例(ArkTS)

    本文 详细代码 需订阅下面专栏获取(订阅后私信邮箱+项目名): https://blog.csdn.net/m0_68036862/category_12333038.html 目录 介绍 环境搭建 代码结构解读 创建低代码工程

    2024年02月21日
    浏览(44)
  • 阿里低代码引擎使用 - 项目启动 & 本地物料开发

    最近开始折腾低代码平台,用了阿里的低代码框架。整体体验还行,但是坑也不少,特别是物料描述这一块,官方文档虽然不少内容,但是一些小东西还是缺了不少。所以想把整个过程记录下来分享给大家。 我打算是利用这个引擎做一个比较全面的定制化改造的,目前进度推

    2024年02月04日
    浏览(46)
  • 最全微信小程序源码项目开发代码合集

    小程序源码是用PHP和Java编程语言编写的程序,可以包含在HTML页面中,就像图像包含在页面中一样。您在本教程中构建的应用程序向您展示了如何在IDE中构建和部署微信小程序源码。 源码:y.wxlbyx.icu 创建或导入Applet源文件 在本节中,您将创建您的第一个小程序。您可能已经

    2024年02月09日
    浏览(43)
  • 【python】Flask网页开发——论坛项目实战(完整代码)

    笔记为自我总结整理的学习笔记,若有错误欢迎指出哟~ 【论坛项目实战】 【python】Flask网页开发——论坛项目实战(完整代码) 【python】Flask网页开发——论坛项目实战(1.导航条实现) 【python】Flask网页开发——论坛项目实战(2.登录与注册) 【python】Flask网页开发——论

    2024年04月28日
    浏览(46)
  • 低代码赋能| 智慧园区项目开发痛点及解决方案

    智慧园区是一个综合体,集技术开发、产业发展和学术研究于一体。作为未来智慧城市建设的核心,智慧园区充当着“产业大脑”和“指挥中心”的角色。它通过整合园区内的制造资源和第三方服务能力,实现园区各组成部分的协调运作、良性循环和相互促进。这进而提升了

    2024年02月10日
    浏览(38)
  • 【开源项目】低代码数据可视化开发平台-Datav

    Datav是一个Vue3搭建的低代码数据可视化开发平台,将图表或页面元素封装为基础组件,无需编写代码即可完成业务需求。 它的技术栈为:Vue3 + TypeScript4 + Vite2 + ECharts5 + Axios + Pinia2 预览地址: https://datav.pengxiaotian.com/ https://gitee.com/pengxiaotian/datav-vue 💪 Vue 3.0+ ⚡ Vite 3.0+ 🍍 Pini

    2024年02月15日
    浏览(84)
  • AUTOSAR 项目和代码详解(一)----AUTOSAR开发工具链

    AUTOSAR开发工具链介绍 软件名版本 功能说明等 资源情况及指导文件 安装情况 备注 集成编译环境 CW for MPC55xx and MPC56xx 2.10 针对MPC55xx和MPC56xx系列,32位芯片。 FSLFlexLM,CW2.10和CW5.1的license管理器,需绑定真实的MAC地址 CWS12v5.1 针对S12系列,16位芯片。若需G64,则要安装补丁包《

    2024年02月16日
    浏览(53)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包