开发一个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工具开发我可能还是处于初出茅庐的阶段,有更规范的操作,欢迎大佬们给我指正。

相关文章
|
4天前
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
【10月更文挑战第36天】本文将引导您探索Node.js的世界,通过实际案例揭示其背后的原理和实践方法。从基础的安装到高级的异步处理,我们将一起构建一个简单的后端服务,并讨论如何优化性能。无论您是新手还是有经验的开发者,这篇文章都将为您提供新的视角和深入的理解。
|
9天前
|
Web App开发 存储 JavaScript
深入浅出Node.js后端开发
【10月更文挑战第31天】本文将引导你进入Node.js的奇妙世界,探索其如何革新后端开发。通过浅显易懂的语言和实际代码示例,我们将一起学习Node.js的核心概念、搭建开发环境,以及实现一个简单但完整的Web应用。无论你是编程新手还是希望拓展技术的开发者,这篇文章都将为你打开一扇通往高效后端开发的大门。
|
10天前
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
【10月更文挑战第30天】本文将通过一个Node.js的简单示例,引导你进入Node.js的世界。我们将从基础概念讲起,然后一步步深入到代码实现,最后总结Node.js在后端开发中的优势和应用场景。无论你是前端开发者还是后端新手,这篇文章都将为你打开一扇了解Node.js的大门。
21 2
|
23天前
|
SQL JavaScript 关系型数据库
node博客小项目:接口开发、连接mysql数据库
【10月更文挑战第14天】node博客小项目:接口开发、连接mysql数据库
|
7天前
|
Web App开发 JavaScript 前端开发
探索后端开发:Node.js与Express的完美结合
【10月更文挑战第33天】本文将带领读者深入了解Node.js和Express的强强联手,通过实际案例揭示它们如何简化后端开发流程,提升应用性能。我们将一起探索这两个技术的核心概念、优势以及它们如何共同作用于现代Web开发中。准备好,让我们一起开启这场技术之旅!
19 0
|
1月前
|
Web App开发 存储 JavaScript
深入浅出Node.js后端开发
【10月更文挑战第7天】本文将带你进入Node.js的世界,从基本概念、环境搭建到实际案例,逐步深入探索Node.js在后端开发中的应用。我们将通过一个简单的在线聊天室项目,学习如何利用Node.js进行网络编程和数据处理,让你对Node.js有更全面的认识。
17 3
|
1月前
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
【10月更文挑战第4天】本文将带你走进Node.js的世界,从基础的搭建到高级的应用,一步步揭示Node.js的强大与便捷。我们将通过实际的代码示例,让你在轻松的氛围中学习并掌握Node.js,开启你的后端开发之旅。
|
1月前
|
存储 JavaScript 前端开发
Node.js 常用工具
10月更文挑战第6天
19 2
|
14天前
|
JavaScript 前端开发 安全
深入浅出Node.js后端开发
【10月更文挑战第26天】在这篇文章中,我们将一起探索Node.js的奇妙世界。不同于传统的Java或Python,Node.js以其异步非阻塞I/O和事件驱动的特性,在后端开发领域独树一帜。无论你是初学者还是资深开发者,这篇文章都将为你提供新的视角和思考。从基础概念到实际应用,我们一步步深入Node.js的世界,让你了解其不仅仅是JavaScript运行环境那么简单。
|
28天前
|
Web App开发 JavaScript 前端开发
Node.js:JavaScript世界的全能工具
Node.js:JavaScript世界的全能工具