开发一个Node命令行小玩具全过程--高颜统计工具

简介: 命令行工具对于我们来说非常的熟悉,一些命令行的操作也极大的简化了我们的日常工作。本文就基于我写的一个Node命令行代码计数器来进行展开。

背景



命令行工具对于我们来说非常的熟悉,一些命令行的操作也极大的简化了我们的日常工作。本文就基于我写的一个Node命令行代码计数器来进行展开。


相信熟悉linux系统的,对于一些ps,grep,cp,mv…等命令用起来应该爱不释手,这也是我想要开发一个便捷命令行的初衷,其次就是记录一个完整开源小玩具的全过程。


命令行的特点:


  • 操作简便
  • 可视性强


看了一下当前的一些命令行有以下问题



因此这一款高颜值方便的统计工具诞生。


image.png


高颜图


image.png


玩具源码


https://github.com/hua1995116/linec


准备



第三方库


  • cli-table
  • colors
  • commander
  • ignore


dev库(用来测试)


  • chai
  • mocha
  • codecov
  • istanbu


Node兼容性


  • babel


静态文件


  • 语言映射库
  • 颜色库


思路



image.png


通过commander来获取用户的一些自定义配置


image.png


Node遍历文件,每种语言行数信息


image.png


ignore过滤输出到cache


image.png


遍历cache,统计max-line,进行colors


image.png


cli-table 输出展示


image.png


改进



loading


对于多文件目录,提供loading


image.png


创建了一个实现loading的类。主要用到readline中的处理方法,详见https://nodejs.org/dist/latest-v8.x/docs/api/readline.html#readlinereadlinemovecursorstreamdx_dy


babel


对于低版本node的兼容


image.png


package.json


image.png


测试用例



chai,mocha


用来测试遍历文件是否正确


image.png


运行


image.png


本项目中还添加了代码覆盖率的测试,因此是这样的


image.png

image.png


发布



Step1


打开https://www.npmjs.com/signup


image.png


注册一个账号


step2


如果有账号直接到这一步


image.png


step3


在package.json中介入version


image.png


step4


image.png


Tip:注意每次发版需要更改package.json 中的version,不然会发版失败哦。


命令行



package.json


image.png


本地项目命令行


image.png


就可以使用linec 命令,将linec命令软连接到本地,linec这个名字可以自定义。


远端命令行


默认就是包名字,但是如果bin里面定义了一个名字,同上,可以修改名字。也就是包名可以和命令不一致,但是为了更方便的使用,个人建议统一包名和命令。


详情可以参考 http://www.ruanyifeng.com/blog/2015/05/command-line-with-node.html


持续集成测试&覆盖率的自动统计



https://travis-ci.org/


配置.travis.yml


image.png


这个是我的配置,每次你的提交,只要含有npm run test命令,travis会自动调用,自动检测。


travis还有个好处,在别人给你提交pr的时候,可以自动运行测试用例,避免一些低级错误的发生。以下就是效果图。


image.png


https://codecov.io/gh


这是一个统计代码覆盖率的工具,在npm run test中添加他,在pr的时候可以看到覆盖率的统计


image.png


安装&使用



image.png


基础用法


image.png


导出到html


image.png


运行完会在当前目录出现一个output.html


功能



  • 输出空行,实际行数,总行数
  • 支持400+语言
  • 显示遍历速度
  • 显示多种颜色
  • 支持导出html


工具源码(欢迎star) https://github.com/hua1995116/linec


效果图



基础模式


image.png


导出后打开html


image.png


结尾



以上就是全部内容,可能对于Node工具开发我可能还是处于初出茅庐的阶段,有更规范的操作,欢迎大佬们给我指正。

相关文章
|
5天前
|
JavaScript 前端开发 网络协议
如何快速搭建一个 Node.JS 项目并进入开发?
如何快速搭建一个 Node.JS 项目并进入开发?
|
15天前
|
JavaScript 网络协议
Node.js 工具模块
Node.js 工具模块
23 0
|
18天前
|
存储 JavaScript 前端开发
Node.js 常用工具
Node.js 常用工具
10 1
|
2月前
|
JSON JavaScript API
使用 Node.js 开发一个简单的 web 服务器响应 HTTP post 请求
使用 Node.js 开发一个简单的 web 服务器响应 HTTP post 请求
|
2月前
|
JSON JavaScript 中间件
使用 Node.js 开发一个简单的 web 服务器响应 HTTP get 请求
使用 Node.js 开发一个简单的 web 服务器响应 HTTP get 请求
|
2月前
|
存储 JSON JavaScript
Node.js 上开发一个 HTTP 服务器,监听某个端口,接收 HTTP POST 请求并处理传入的数据
Node.js 上开发一个 HTTP 服务器,监听某个端口,接收 HTTP POST 请求并处理传入的数据
|
2月前
|
JavaScript 前端开发 API
在Node.js上使用dojo库进行面向对象web应用开发
请注意,虽然这个例子在Node.js环境中使用了Dojo,但Dojo的许多功能(例如DOM操作和AJAX请求)在Node.js环境中可能无法正常工作。因此,如果你打算在Node.js环境中使用Dojo,你可能需要查找一些适用于服务器端JavaScript的替代方案。
32 0
|
2月前
|
JavaScript 前端开发
Node.js新手必备:超实用命令行入门教程
Node.js新手必备:超实用命令行入门教程
26 0
|
2月前
|
JavaScript 前端开发 IDE
【TypeScript技术专栏】TypeScript与Node.js后端开发
【4月更文挑战第30天】TypeScript在Node.js后端开发中日益重要,作为JavaScript超集,它提供静态类型检查和面向对象编程,增强代码可靠性和维护性。集成TypeScript能带来类型安全、更好的IDE体验、易于维护的代码以及增强工具支持。通过安装TypeScript编译器、编写TypeScript文件、配置TSconfig,开发者可以在Node.js项目中利用其高级特性,提高代码质量和开发效率。实践案例显示,TypeScript能确保路由处理器的类型正确,降低错误率。随着社区发展,TypeScript成为提升Node.js开发体验的推荐选择。
|
2月前
|
JavaScript 前端开发 开发者
Node.js的包管理和npm工具深度解析
【4月更文挑战第30天】本文深入解析Node.js的包管理和npm工具。包管理促进代码复用和社区协作,包包含元数据描述文件`package.json`和入口文件。npm提供搜索、安装、发布等功能,通过命令行进行操作,如`install`、`search`、`uninstall`。npm支持版本控制、全局安装、脚本定义及私有仓库。理解和熟练运用npm能提升Node.js开发效率。