背景
命令行工具对于我们来说非常的熟悉,一些命令行的操作也极大的简化了我们的日常工作。本文就基于我写的一个Node命令行代码计数器来进行展开。
相信熟悉linux系统的,对于一些ps,grep,cp,mv…等命令用起来应该爱不释手,这也是我想要开发一个便捷命令行的初衷,其次就是记录一个完整开源小玩具的全过程。
命令行的特点:
- 操作简便
- 可视性强
看了一下当前的一些命令行有以下问题
- 种类少 https://github.com/Towtow10/line-count
- 颜值不够 https://github.com/AlDanial/cloc
- 统计不太方便 https://github.com/ryanfowler/lines
因此这一款高颜值方便的统计工具诞生。
高颜图
玩具源码
https://github.com/hua1995116/linec
准备
第三方库
- cli-table
- colors
- commander
- ignore
dev库(用来测试)
- chai
- mocha
- codecov
- istanbu
Node兼容性
- babel
静态文件
- 语言映射库
- 颜色库
思路
通过commander来获取用户的一些自定义配置
Node遍历文件,每种语言行数信息
ignore过滤输出到cache
遍历cache,统计max-line,进行colors
cli-table 输出展示
改进
loading
对于多文件目录,提供loading
创建了一个实现loading的类。主要用到readline中的处理方法,详见https://nodejs.org/dist/latest-v8.x/docs/api/readline.html#readlinereadlinemovecursorstreamdx_dy
babel
对于低版本node的兼容
package.json
测试用例
chai,mocha
用来测试遍历文件是否正确
运行
本项目中还添加了代码覆盖率的测试,因此是这样的
发布
Step1
打开https://www.npmjs.com/signup
注册一个账号
step2
如果有账号直接到这一步
step3
在package.json中介入version
step4
Tip:注意每次发版需要更改package.json 中的version,不然会发版失败哦。
命令行
package.json
本地项目命令行
就可以使用linec 命令,将linec命令软连接到本地,linec这个名字可以自定义。
远端命令行
默认就是包名字,但是如果bin里面定义了一个名字,同上,可以修改名字。也就是包名可以和命令不一致,但是为了更方便的使用,个人建议统一包名和命令。
详情可以参考 http://www.ruanyifeng.com/blog/2015/05/command-line-with-node.html
持续集成测试&覆盖率的自动统计
配置.travis.yml
这个是我的配置,每次你的提交,只要含有npm run test命令,travis会自动调用,自动检测。
travis还有个好处,在别人给你提交pr的时候,可以自动运行测试用例,避免一些低级错误的发生。以下就是效果图。
这是一个统计代码覆盖率的工具,在npm run test中添加他,在pr的时候可以看到覆盖率的统计
安装&使用
基础用法
导出到html
运行完会在当前目录出现一个output.html
功能
- 输出空行,实际行数,总行数
- 支持400+语言
- 显示遍历速度
- 显示多种颜色
- 支持导出html
工具源码(欢迎star) https://github.com/hua1995116/linec
效果图
基础模式
导出后打开html
结尾
以上就是全部内容,可能对于Node工具开发我可能还是处于初出茅庐的阶段,有更规范的操作,欢迎大佬们给我指正。