9.2 静态分析

1. Ruby

rubocop

官方文档: rubocop, 主要的风格指导是基于社区流行的ruby-style-guide

如果对于rubocop的规则不太熟悉, rubocop执行代码时的报错信息, 不太容易和相关style对应起来, 一个技巧是在rubydoc Rubocop上搜索报错信息, 比如在google上利用site搜索:

Missing top-level class documentation comment site:www.rubydoc.info

Rubycritic

主要特性:

使用第三方静态分析器: Reek, Flay 和 Flog
同时支持命令行和web图表化展示分析结果
可以总览你的项目,并且可以对代码打分(百分制)
根据各自的坏味道数量建立文件索引
可以查看具体的类文件中的代码质量问题

主要分析维度:

Score: 代表所有分析文件的总分, 0~100分区间
Churn: 文件修改次数, 基于版本控制系统, 如git的commit次数
Complexity: 文件复杂度, 目前计算的维度主要基于Assignments,Branches和Calls
Rating: A~F的6个等级, A最好, 通常讲, A,B是比较好的, C可以视为警告, D和F是需要修复的
Rating是基于Cost计算的, 所谓Cost是和文件的smell和Complexity相关的
(RubyCritic's rating system was inspired by Code Climate's)
Duplication: 代码重复
Smells: 代码的坏味道, 主要基于Reek, Flay, Flog

Flog

Flog计算代码的复杂度, 并通过比较易读的方式展示出来, 分支(调用), 赋值, 魔数等有不同的分值, 并且不同的方法调用也有不同的分值.

一个印象示例:

class Test
  def blah         # 11.2 =
    a = eval "1+1" # 1.2 + 6.0 +
    if a == 2 then # 1.2 + 1.2 + 0.4 +
      puts "yay"   # 1.2
    end
  end
end

2. Javascript

eslint

主要特性:

开源的 JavaScript 代码检查工具
所有规则都被设计成可插入的, ESLint 内置了一些规则，用户可以在使用过程中自定义规则
ESLint 并不推荐任何编码风格，规则是自由的
每条规则各自独立, 可以开启或关闭, 可以将结果设置成警告或者错误
部分规则支持格式化自动修复

安装:

在具体项目中本地安装: npm install eslint --save-dev
通过NPM全局安装: npm install -g eslint

配置加载:

配置文件格式可以使JSON, JS或者YMAL, 会从当前目录一直向上需找
配置也可以内置到package.json中, 配置顶层key是eslintConfig
在配置文件中还可以指定外部配置文件, 这个机制可以用于共享配置文件: extends: './public-eslintrc.js'
另一个共享的方案是使用ESLint 配置的NPM包, 这些配置的模块名一般以eslint-config-为前缀
最后配置还可以通过eslint命令行参数指定

以JS配置文件为例:

module.exports = {
  extends: 'eslint:recommended', //指定规则分类
  env: { //指定运行环境
    node: true,
    es6: true
  },
  rules: { //对规则进行定制
    'no-console': 'off',
  },
};

每条规则有 3 个等级：off, warn和error. off表示禁用这条规则, warn表示仅给出警告, 并不会导致检查不通过, 而error则会导致检查不通过
规则的详细说明文档可以参考这里：Rules - 规则

代码格式化:

在ESLint 规则列表页面，我们发现有些规则的旁边会带有一个橙色扳手图标，表示在执行eslint命令时指定--fix参数可以自动修复该问题

更多细节, 请参考:

ESLint 官网官网容易被墙, 可以参考下面的中文文档
ESLint 中文
利用 ESLint 检查代码质量

vim-fixmyjs

Plugin 'ruanyl/vim-fixmyjs'
let g:fixmyjs_rc_path = '~/.eslintrc.js'

在vim中执行:Fixmyjs可以自动fix eslint中支持autofix的错误

3. Go

Go语言常见的代码质量工具有gofmt, golint, go vet

gofmt: 直接格式化源码, 它的标准基本是强制性的, 比如使用缩进时tab(width = 8)而不是space, 去掉行尾空白等等
golint: 只是输出建议, 不格式化代码; 更关注编码风格上的问题; Golint 是在google内部使用的代码规范, 同时逐步和Go社区中的主流规范融合.
go vet: 关注代码错误问题, 而不是风格问题, 比如可以通过编译但仍然有可能存在错误的代码.

Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes.

Golint differs from govet. Govet is concerned with correctness, whereas golint is concerned with coding style. Golint is in use at Google, and it seeks to match the accepted style of the open source Go project.

4. Lua

luacheck 是lua的静态分析工具, 它可以检测一系列的编码风格问题, 如使用未定义的全局变量, 没有使用的局部变量, 访问未初始化的变量, 代码死区(unreachable code)等等, 且大部分是可以配置的.

使用文档: Luacheck documentation

安装:

luarocks install luacheck

常见的错误解释:

Setting non-standard global variable

Luacheck默认只允许用户使用标准库定义的全局变量, 用户定义的全局变量会有此警告, 可以通过globals配置新增允许使用的全局变量.

9.2 静态分析工具