fdev-xray

前端代码review工具

正在开发中

featrues

core

1. 能扫描，并指出有问题的代码所在的位置和错误信息
2. 可以自定义rule规则
3. 命令行

--js

1. 能解析单个js文件的结构
2. 能分析单个js文件不符合checklist的问题
   • 正确的缩进，最小缩进单位为4个空格
   • 所有语句结束带上分号
   • 所有条件区域必须用花括号括起来
   • 无侵入式js，tracelog除外，有特例
   • 使用命名空间，禁止出现不必要的全局变量
   • 方法、变量都使用驼峰命名，类使用大驼峰(Pascal)命名
   • 变量声明应放在function的最上面，避免使用未声明的变量
   • 常量名全部大写，单词分隔使用下划线
   • on开头的命名只能用作事件处理函数
   • 初始化函数以init开头
   • Bolean类型变量必须以is/has等判断词开头，str开头的必须是字符串，arr开头的必须是数组，num开头的必须是数字，obj开头的必须是对象
   • 获取和配置参数的函数必须以get set开头
   • 重复变量从字母i开始依次往后定义
   • 私有变量和方法如果不在闭包中，则以下划线开头
   • 关键字和保留字不能作为变量名
   • 库、组件、代码片段中有的方法必须优先使用
   • 非特殊原因必须使用YUI，addClass/removeClass/getRegion例外
   • 按库中的js模板书写js
   • 3个条件及以上的条件语句用switch代替if else
   • 使用{}代替new Object()；使用[]代替new Array()
   • 合理使用===和!==操作符
   • try catch一般不允许嵌套，若嵌套，需要充分的理由
   • 不允许使用eval
   • 防止重复提交（form、ajax）
   • DOMReady之前不能进行DOM操作
   • onerror事件必须消除onerror事件
   • 不出现将造成线上bug的潜在js错误。此项为累计扣分，出现一次即扣相应分值，两次则扣两次，依此类推。但凡出现一次，均不予发布
   • 产品线级merge文件只能merge下列文件：lib文件、sys文件、所在综合线global文件、所在综合线module文件、所在综合线widget文件、本产品线module文件、本产品线widget文件
   • merge文件写法正确，详见合并脚本规则
   • 页面级merge文件只能merge下列文件：lib文件、sys文件、所在综合线global文件、所在综合线module文件、所在综合线widget文件、本产品线module文件、本产品线widget文件、本产品线page同名文件
   • 功能文件头部必须有注释，且包含时间、作者、项目信息，更新后需要加上更新注释，包含时间、作者、更新内容
   • 发布上线的文件需要压缩，命名规则如a.js->a-min.js，且两者在同一目录下
   • 文件夹和文件命名全部用小写字母且不存在ad连续字符，单词分隔用中横线，其中文件夹只有需要版本区分时才可用中横分隔，如fdev-v3
   • 禁止在sys目录下放置merge文件
   • 产品线global目录下只放置该产品线级merge文件

h3. --css

1. 能分析出css不符合checklist的问题
   • 静态文件编码应为国标码（gbk/gb2312） [OK]
   • 页面级别样式不使用id [OK]
   • 页面级别样式不能全局定义标签样式 [OK]
   • CSS级联深度不能超过4层 [OK]
   • 合理使用hack [OK]
   • 副logo字体依次取微软雅黑、黑体、文泉驿正黑体、华文细黑 [SKIP]
   • 字体名称中的中文必须用ascii字符表示 [OK]
   • 禁止使用星号（*）选择符 [OK]
   • 禁止重写reset中定义的a标签的hover色（现为#ff7300） [OK]
   • 禁止修改或重载type中的样式 [OK]
   • 禁止使用CSS表达式，fixed例外 [OK]
   • z-index的使用符合以下规则：头部1000至2000，内容区1000以下
   • 产品线级merge文件只能merge下列文件：lib文件、sys文件、所在综合线global文件、所在综合线module文件、所在综合线widget文件、本产品线module文件、本产品线widget文件 [SKIP]
   • merge文件写法正确，详见合并脚本规则
   • 页面级merge文件只能merge下列文件：lib文件、sys文件、所在综合线global文件、所在综合线module文件、所在综合线widget文件、本产品线module文件、本产品线widget文件、本产品线page同名文件 [SKIP]
   • 发布上线的文件需要压缩，命名规则如a.js->a-min.js，且两者在同一目录下 [OK]
   • 功能文件头部必须有注释，且包含时间、作者、项目信息，更新后需要加上更新注释，包含时间、作者、更新内容 [SKIP]
   • 文件夹和文件命名全部用小写字母且不存在ad连续字符，单词分隔用中横线，其中文件夹只有需要版本区分时才可用中横分隔，如fdev-v3 [OK]
   • 禁止在sys目录下放置merge文件 [SKIP]
   • 产品线global目录下只放置该产品线级merge文件 [SKIP]
2. 能给出高级的css写法建议

h3. --html

1. 能分析出html的结构
2. 能分析出html不符合的问题
   • 不能定义内嵌样式style
   • 页面必须引用fdev css
   • 避免重复引用同一或相同功能文件 如何判断相同功能文件
   • 功能a必须加target="_self"，除非preventDefault过 如何判断功能a href !~ http
   • 新页面按库中的HTML基本结构模板书写基本页面结构
   • 必须存在文档类型声明，新页面统一使用HTML 5 DTD
   • head部份格式正确，包含字符集meta和title
   • 外链CSS置于head里，例外：应用里的footer样式
   • 不通过@import在页面上引入CSS
   • 外链产品线级js置于head，页面级js置于页底
   • 标签全部小写，包含属性
   • id、class名称全部小写，单词分隔使用中横线
   • 属性值使用双引号，且不能仅有属性名
   • 标签必须闭合，嵌套正确 是否包括meta、img等浏览器能辨认的标签？HTML5 DTD是否也要求如此？ yes!
   • 一个节点上定义的class个数最多不超过3个(不含lib中的class)
   • 行内标签不得包含块级标签
   • h类标签按层次递减， h1唯一（detail页h1放在detail title上）
   • a标签加上title属性，除非作为功能点的a标签
   • img标签加上alt属性
   • text、radio、checkbox、textarea、select必须加name属性
   • 所有按钮必须用button（button/submit/reset）

tasks

每项功能的完成都需要测试和功能都完成

css

1. 将css代码解析成可分析的数据结构
2. 分析出css代码中一条不符合checklist规则的位置和原因
3. 分析出css checklist中的所有问题
4. 对css语句顺序不合理的地方作出提醒
5. 检查css文件部署时的位置、名称、压缩状况是否符合规范
6. css的扫描规则可以自定义

js

1. 将js代码解析成可分析的数据结构
2. 分析出js代码中一条不符合checklist规则的位置和原因
3. 分析出js checklist中的所有问题
4. js扫描规则可以自定义
5. 检查js文件部署时的位置、名称、压缩状况是否符合规范

html

1. 将html代码解析成可分析的数据结构
2. 分析出html代码中一条不符合checklist规则的位置和原因
3. 分析出html checklist中的所有问题
4. html扫描规则可以自定义