《Node.js在CLI下的工程化体系实践》成都OSC源创会分享总结

背景: 随着开发团队规模不断发展壮大,在人员增加的同时也带来了协作成本的增加,业务项目越来越多,类型也各不相同。常见的类型有组件类、活动类、基于React+redux的业务项目、RN项目、Node.js项目等等。如果想要对每个项目进行一些规范的约束比如Git提交规范、Javascript规范简直难于登天。所有的这些,只因为缺少一个好用的工程化工具。从项目创建、开发、构建、代码规范检查到最终项目上线,通过CLI可以提升效率,同时保障开发规范的实施。

Node.js实现CLI的基本原理

关键点在于package.json里面的bin字段。模块全局安装,对于类unix系统,在/usr/local/bin目录创建软链接;对于windows系统,在C:\Users\username\AppData\Roaming\npm目录创建软链接。 模块局部安装,会在项目内的./node_modules/.bin目录创建软链接。

现代化web工程的生命周期

随着前端工程的不断演进,一方面工程变得日趋复杂,同时对规范和质量的诉求在不断增加。现代化web工程应该包含以下几个阶段:初始化、开发、构建、检查、发布。如下图所示:

痛点1:项目拷贝

项目拷贝存在的问题显而易见,大致有以下三个方面:

  • 容易出错;一旦某个关键文件拷贝丢失或者错误,很可能需要耗费半天到一天的时间排查环境问题。
  • 不同场景下对目录结构要求不同;平时开发过程中,工程通常会分为运营活动、Hybrid业务、入口级别的项目(对性能和体验有极致和苛刻的要求)。需要基于RN或者Node.js的首屏直出,还有常用的业务组件等的开发。
  • 新的Feature和BugFix难以同步;某个同学开发过程中增加的新方法或者解决的bug很难传递给其它同学并且沉淀成经验积累下来。

社区里面提供了完美的Yeoman解决方案,它是为了自动化项目的创建而生。Yeoman创建项目包括以下几个阶段:

  • initializing: 初始化一些状态之类的,通常是和用户输入的 options 或者 arguments 打交道
  • prompting: 和用户交互的时候(命令行问答之类的)调用
  • configuring: 保存配置文件(如 .babelrc 等)
  • writing: 生成模板文件
  • install: 安装依赖
  • end: 结束部分,初始代码自动提交

我们只需要继承Yeoman的Generator类做模板定制化,基于Yeoman的脚手架设计思路应该如下图所示:

首先,开发者会和CLI进行交互,开发者会告诉CLI需要创建哪一种类型的项目,CLI收到命令后。从本地已经安装的Yeoman脚手架里面选择某种类型的模板。然后,CLI会调用Gitlab API在远程创建仓库并且授予开发者master权限。接下来,会根据实际业务场景需要,自动化申请一些打点信息,常见的如离线包id,监控告警id等等。之后,在本地目录生成代码并且安装项目依赖的npm包,最后将本次初始化生成的所有代码自动提交到远程Git仓库。

痛点2:运营配置频繁修改

基于React+redux组件化开发方式中,一个页面或者webapp是由多个容器组件拼装后渲染而成。

某个组件通常是由:模板、cgi数据和事件组成。理想情况下,开发和产品和平共处,你可以把一个组件写成下面这个样子,比如规则组件:

咋一看,上面的写法没什么问题。实际确很可能是7、8次的文案修改,甚至对外入口开放后仍然要修改文案或者图片等静态数据。然后,你需要走代码发布流程。

更好的解决思路是:在开发某个业务组件之前,结合以往的经验,分析哪些静态数据很可能是需要高频次的修改。将这些高频次修改的静态数据抽离出来,对于万年不变的数据则没有必要抽出来。那么,如何将静态数据动态化呢?

答案是: Schema First , 开发组件之前先设计Schema,通过schema生成一个form表单,达到静态数据和模板分离。如果使用React开发,可以基于react-jsonschema-form定制。静态数据和模板分离之后应该如下图:

痛点3:缺少协作规范

此处以Git commit规范为例子进行相关改进介绍。

良好的Git commit规范有以下优势:

  • 加快Review的流程
  • 根据Commit元数据生成Changelog
  • 后续维护者可以知道feature被添加的原因

此处采用Google angular项目的提交作为参考,整理出Git commit的解决方案:

具体的提交格式要求如下:

对格式的说明如下:

  • type代表某次提交的类型,比如是修复一个bug还是增加一个新的feature。所有的type类型如下:
  • feat: 新增feature
  • fix: 修复bug
  • docs: 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等
  • style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑
  • refactor: 代码重构,没有加新功能或者修复bug
  • perf: 优化相关,比如提升性能、体验
  • test: 测试用例,包括单元测试、集成测试等
  • chore: 改变构建流程、或者增加依赖库、工具等
  • revert: 回滚到上一个版本

一键生成Changelog版本日志:

痛点4: 缺少代码规范

一次血淋淋的生产环境事故:2017年4月13日,腾讯高级工程师小圣在做充值业务时,修改了苹果iap支付配置,将JSON配置增加了重复的key。代码发布后,有小部分使用了vivo手机的用户反馈充值页面白屏,无法在Now app内进行充值。最后问题定位是:vivo手机使用了系统自带的webview而没有使用X5内核,解析JSON时遇到重复key报错,导致页面白屏。

分析:现代化的浏览器对于JSON里面的重复key会做兼容处理,但是某些老旧的浏览器内核并不会,比如此处的vivo手机,导致代码直接出错。那么,如何避免类似问题再次出现呢?

此处不得不提及ESLint,ESLint于2013年6月推出最新版本v4.6.0,是一款适用于Javascript和JSX的代码规范检查工具,相比JSLint和JSHint而言,它更加灵活,支持自定义配置、插件扩展和配置错误级别。虽然接入ESLint会给团队的同学增加不少代码修改的成本,但是从长远来看,收益肯定是大于付出的。

Javascript规范制定的原则:

  • 不重复造轮子,基于eslint:recommend 配置并改进
  • 能够帮助发现代码错误的规则,全部开启
  • 配置不应该依赖于某个具体项目,而应尽可能的合理
  • 帮助保持团队的代码风格统一,而不是限制开发体验
  • 有对应的解释文档

为了更好的定制和维护Javascript规范,我们创建了eslint的shareable config。一方面,我们觉得eslint:recommend 里面的部分配置定义的错误级别过于严格,比如代码里面出现了console会导致校验错误,另一方面,它没有包含ESLint的最佳实践和其它规则。我们定义的部分规则解释如下:

规则名称

错误级别

说明

for-direction

error

for 循环的方向要求必须正确

getter-return

error

getter必须有返回值,并且禁止返回值为undefined, 比如 return;

no-await-in-loop

off

允许在循环里面使用await

no-console

off

允许在代码里面使用console

no-prototype-builtins

warn

直接调用对象原型链上的方法

valid-jsdoc

off

函数注释一定要遵守jsdoc规则

no-template-curly-in-string

warn

在字符串里面出现{和}进行警告

accessor-pairs

warn

getter和setter没有成对出现时给出警告

array-callback-return

error

对于数据相关操作函数比如reduce, map, filter等,callback必须有return

block-scoped-var

error

把var关键字看成块级作用域,防止变量提升导致的bug

class-methods-use-this

error

要求在Class里面合理使用this,如果某个方法没有使用this,则应该申明为静态方法

complexity

off

关闭代码复杂度限制

default-case

error

switch case语句里面一定需要default分支

ESLint的执行可以接入到PUSH hook里面,步骤如下:

CLI设计

CLI的作用是将工程开发过程中遇到的一系列痛点问题连接起来,提升开发效率,同时保障规范的实施。

插件设计

插件实现原理

这里有一个非常巧妙的设计,通过使用node提供的module和vm模块,可以通注入feflow全局变量来访问到cli的实例。从而能够访问cli上的各种属性,比如config, log和一些helper等。

命令注册:

命令需要以feflow.cmd.register进行注册,比如:

说明:

  • register有3个参数,第一个是子命令名称,第二个是命令描述说明信息,第三个是对应的子命令执行逻辑函数。
  • feflow会将命令行参数args解析成Object对象,传递给插件处理函数。

配置

可以通过feflow.version获取当前feflow的版本,feflow.baseDir 获取feflow跟目录(在用户目录下的.feflow),通过feflow.pluginDir 获取插件目录。

日志

通过feflow.log来进行相关命令行日志输出。

原文作者:ivweb 程柳锋

原文链接:https://ivweb.io/topic/59c91a6929990029be3d986d

原文发布于微信公众号 - 腾讯NEXT学位(NextDegree)

原文发表时间:2018-05-31

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏编程

Instagram 开源用于 Python 3的MonkeyType 工具

Instagram 宣布将其 MonkeyType 工具开源。它是通过运行时跟踪类型自动将类型注释添加到您的 Python 3 代码的工具。 授权协议:BSD ...

1649
来自专栏零基础使用Django2.0.1打造在线教育网站

零基础使用Django2.0.1打造在线教育网站(二十):课程相关页面配置

努力与运动兼备~~~有任何问题可以加我好友或者关注微信公众号,欢迎交流,我们一起进步!

461
来自专栏大数据钻研

大福利!献给网页开发者的20款Firefox插件

毫无疑问,比起其他浏览器,谷歌浏览器虽有着明显的优势,但是它的劲敌火狐却是很多前端攻城师和研发人员的挚爱,为了尽可能地提高用户体验,火狐浏览器的社区在插件开发和...

41711
来自专栏iOSDevLog

如何在50行以下的Python代码中创建Web爬虫

有兴趣了解Google,Bing或Yahoo的工作方式吗?想知道抓取网络需要什么,以及简单的网络抓取工具是什么样的?在不到50行的Python(版本3)代码中,...

632
来自专栏美丽应用

易剪:小巧高效的文字剪藏工具

551
来自专栏finleyMa

(转) 网站统计中的数据收集原理及实现

原文地址:http://blog.codinglabs.org/articles/how-web-analytics-data-collection-syste...

641
来自专栏DeveWork

WeApp-Workflow: 基于Gulp 的微信小程序前端开发工作流

WeApp-Workflow 是Jeff 在开发个人微信小程序“DeveWork极客” 过程中积累总结而来的一个基于Gulp4 的,专门用于开发微信小程序的前端...

34510
来自专栏BestSDK

微信、美团的APP“404页面”居然是这样的

大多数App都要与服务器进行数据的交换,App向服务器发出数据请求,服务器接收到请求之后向App传输相应数据,App接收成功后显示数据内容,没有接收成功则反馈数...

3259
来自专栏finleyMa

封装一个超级简单的vue分享组件

更新: 2018-5月起 jiathis关闭分享功能,请使用 http://sharesdk.mob.com/ 或搜索其他社会化分享类库

1703
来自专栏phodal

前端写一个月的原生 Android 是怎样一种体验?

一个前端程序员的一个月原生 Android 开发体验。自从我写了 Android 应用后,上知乎的时间变得更长了。 自从我写了 Android 应用后,上知乎的...

20310

扫码关注云+社区