I code it

Code and Life

制作一个更漂亮的svn Diff命令

Code Review

ThoughtWorks,我们几乎每天都会进行一个叫code review或者code diff的活动:每天下午5:00,团队成员围坐在一起,将今天的修改大概过一下,这样做的好处非常明显:

  1. 分享业务知识,了解彼此的工作
  2. 分享技术细节,比如有人使用了某种设计模式
  3. 帮助别人发现问题,比如逻辑错误等,群策群力

经过实践,code reivew可以快速发现问题,而且可以尽可能多的分享知识,是一种ThoughtWorker们喜闻乐见的学习/娱乐形式。

但是随着项目的不同,各个团队使用的版本管理工具都不一样。用惯了git的非常漂亮的diff子命令之后,svndiff简直就是战五渣。没有高亮,没有进度条,就是黑底白字的一些文本,实在无法让人提起兴趣。

这篇文章分享一个简单的方法,可以让你很容易的把svndiff打造成一个漂亮的工具:

svn diff

diff格式

Diff是一种通用的表示文本差异的格式,细节可以看我之前写过一篇关于diff和patch的文章。需要说明的是,它作为一种标准格式,很多编辑器都提供对这种格式的高亮显示,比如现在非常流行的Sublime Text编辑器:

sublime diff

默认的,svn的diff命令会生成这样朴素的输出:

svn diff

命令行的diff高亮显示

在Mac下,可以通过brew来安装一个命令行工具,这个工具可以将Diff格式高亮显示:

1
$ brew install colordiff

有了这个工具,就可以将svn生成的Diff格式高亮显示出来:

1
$ svn diff | colordiff

color diff

但是你可能已经发现这些神奇的^M,这是Windows系统中的换行符在Unix类系统中的展示,我们需要将Diff先转换一次:

1
$ svn diff | dos2unix | colordiff

color diff converted

如果你的系统中没有dos2unix,可以用brew来安装:

1
$ brew install dos2unix unix2dos

分页器

*nix系统下有两种分页器:morelesslessmore的功能更丰富。less有很多的参数,我们这里选用了3个常见的:

  1. -s: 压缩连续的空白行为一行
  2. -M: 给出更多的提示信息,包含行号,百分比等
  3. +Gg: 先跳至要查看文件的末尾,再跳至文件开头,这样从less就可以得到整个流的长度,从而计算出正确的百分比。当然如果是单独文件时,less是明确知道文件长度的,但是如果是从流中重定向过来的文本,less无法在开始时就得知长度。

下面这条命令可以将当前目录下的所有html文件分屏显示,并且在每一屏的最后一行显示百分比等信息:

1
$ cat *.html | less -s -M +Gg

放在一起

好了,我们将每个部分都已经讲解了一遍了,现在让我们将这些零件串起来,在svn的working copy中执行这条命令就可以得到非常漂亮的,分页显示的Diff:

1
$ svn diff | dos2unix | colordiff | less -s -M +Gg

当然,还可以用一个alias(别名)来节省敲入的字符数:

1
$ alias sd='svn diff | dos2unix | colordiff | less -s -M +Gg'

Comments