HowToFix

常见错误修复

JS RULE003 [强制] 使用 4 个空格做为一个缩进层级，不允许使用 2 个空格 或 tab 字符。

这个问题通常发生在使用 tab 作为缩进，还有部分是由于前面出现的代码中有不恰当的换行或缩进影响的，具体需要使用 fecs 直接检查查看详细的错误信息。

比较容易发现的，是数组内的元素或函数的参数间换行，当内部需要换行时（比如超过 120 字符或排版美观需要），括号内侧也必须换行--左括号之后换行，右括号之前换行。第一个换行的缩进，需要比左括号所在行多一个缩进，右括号所在行的缩进则与左括号所在行的保持一致。

一个特殊的 case 是使用数组作 HTML 字符拼接时，除满足上面所述的缩进外，其它元素间的最多可以差一个缩进（在兄弟节点时可以相等，子节点时增加一个，父节点结束标记减少一个）。如果数组未被识别为 HTML 字符拼接，可以通过增加注释来标识：

// html
var html = [
    objectType,
    functionExpressionType,
    ...
];

JS RULE007 [强制] if / else / for / while / function / switch / do / try / catch / finally 关键字后，必须有一个空格。

文字描述已经很清楚，但很多 RD 同学碰到时可能不明白怎么修改，其实只需在以上关键字后加一个空格即可。

JS RULE008 [强制] 在对象创建时，属性中的 : 之后必须有空格，: 之前不允许有空格。

对象创建是指直接使用 { 和 } 创建的对象直接量，一般情况下，在 : 前是不允许有空格而在它之后是必须有空格的。特殊情况是当使用 : 作对象字段的对齐排版时，允许 : 前有空格。如果提示某些属性名后、: 前缺少空格，是由于当前对象的属性大部分相对于 : 对齐了。

JS RULE015 [强制] 每行不得超过 120 个字符。

除了很长的正则和 URL，这个只能通过添加适当的换行和缩进排版来修复。 对于超长的正则和 URL 导致的问题，可以通过注释来屏蔽：

/* eslint-disable max-len */
// 这里是超长的正则或 URL
/* eslint-enable max-len */

JS RULE016 [强制] 运算符处换行时，运算符必须在新行的行首。

例如：

if (thisIsALongExpressionForCodeDemoView &&
    thisAnotherLogExpression
)

需要改为

if (thisIsALongExpressionForCodeDemoView
    && thisAnotherLogExpression
)

JS RULE024 [强制] IIFE 必须在函数表达式外添加 (，非 IIFE 不得在函数表达式外添加 (。

IIFE 是指马上执行的函数表达式：

var task = function () {
    // Code
    return result;
}();

var func = (function () {
});

+function () {
    // blablabla
}();

必须改成：

// good
var task = (function () {
   // Code
   return result;
})();

var func = function () {
};

(function () {
    // blablabla
})();

JS RULE025 [强制] 变量 使用 Camel命名法。

使用其他语言的同学，可能习惯使用下划线作为命名中单词的分隔符：

var foo_bar = true;

这里需要改成：

var fooBar = true;

JS RULE029 [强制] 类 使用 Pascal命名法。

换言之，使用类的构建函数名，必须是大写字母开头。当调用了大写字母开头的函数或方法，但没有使用 new 操作符时，也是不允许的，即便结果正确。 如果是因为使用了第三方的代码，如果加 new 不影响结果的正确性，可以参见 FAQ 中的 《如何修复使用 jQuery 的 DataTable 插件的问题？》，否则需要使用以下方式屏蔽该条规则：

/* eslint-disable new-cap */

JS RULE030 [强制] 类的 方法 / 属性 使用 Camel命名法。

• 部分情况同 《JS RULE029 [强制] 类 使用 Pascal命名法》。

• 如果方法属性命名是受 RD 接口影响，需要使用以下方式处理：

/* eslint-disable fecs-camelcase */
// 这里是你的代码
/* eslint-enable fecs-camelcase */

• 如果有固定的模式，比如都以 api_ 开头，可以这样配置：

/* eslint fecs-camelcase: [2, {ignore: ["/^api_/"]}] */
ajax.send({
    api_site: 'baidu',
    api_key: 'djk13-liwfu-bstdj'
});

其中 ignore 的取值是字符串数组，字符串以 / 开始和结束时，将按正则字符匹配处理。

• 如果习惯使用 _ 前缀标识私有属性或方法，则需要增加 @private 来避免检查：

/**
 * 类描述
 *
 * @class
 * @extends Developer
 */
var Fronteer = function () {
    Developer.call(this);

    /**
     * 属性描述
     *
     * @type {string}
     * @private
     */
    this._level = 'T12';

    // constructor body
};
util.inherits(Fronteer, Developer);

/**
 * 方法描述
 *
 * @private
 * @return {string} 返回值描述
 */
Fronteer.prototype._getLevel = function () {
};

JS RULE044 [强制] 对于基本类型 {string}, {number}, {boolean}，首字母必须小写。

意思是除了 String/Number/Boolean 类型的首字母小写，其它类型都大写，如：{Array}，{Date}，{Function}，{Object}，{RegExp}。

JS RULE045 [强制] 文件顶部必须包含文件注释，用 @file 标识文件说明。

在文件开始，必须使用 @file 对当前文件作注释：

/**
 * @file 介绍当前文件的说明
 * @author name<email>
 */

JS RULE052 [强制] 函数/方法注释必须包含函数说明，有参数和返回值时必须使用注释标识。

这种情况通常是漏了某些参数或返回值的注释，可以通过本地运行 fecs 看具体的信息。 对于 Object 类型的参数（比如写配置项时，假设叫 options），想对参数对象的各个字段作注释时，首先不能漏了参数名（options）的注释，然后对于各个字段注释，需要带上 options. 作前缀：

/**
 * 初始化
 *
 * @param {Object} options 配置项
 * @param {boolean} options.disabled 控件的不可用状态
 * @param {(string | HTMLElement)} options.main 控件渲染容器
 * @param {(string | HTMLElement)} options.target 计算弹出层相对位置的目标对象
 * @param {string} options.prefix 控件class前缀，同时将作为main的class之一
 * @param {number} options.index 默认激活的标签索引
 */

JS RULE053 [强制] 参数和返回值注释必须包含类型信息和说明。

错误的注释：

/**
 * blablabla
 *
 * @param foo
 * @param bar
 */

需要加上参数类型和说明

/**
 * blablabla
 *
 * @param {number} foo 这是 foo 的说明
 * @param {boolean} bar 这是 bar 的说明
 */

JS RULE070 [强制] 变量在使用前必须通过 var 定义。

这是因为使用了非当前文件内定义的全局变量，或者是定义时漏写 var 的变量。

• 使用了 AMD 的项目，应该通过配置 shim 来把非 AMD 模块伪装成 AMD 模块 require。

• 未使用 AMD 的项目，可以把该变量标识为 globals：

/* globals foo */

• 还有一种错误的写法导致出现的全局变量：

var foo = bar = true;

正确写法应该是：

var foo = true;
var bar = foo;

JS RULE071 [强制] 每个 var 只能声明一个变量。

var foo = true,
    bar = false;

需要改为：

var foo = true;
var bar = false;

JS RULE072 [强制] 变量必须 即用即声明，不得在函数或其它形式的代码块起始位置统一声明所有变量。

var foo = function () {
    bar();
}

var bar = function () {
    // blablabla
}

这种代码的报错主要是因为 bar 的调用在定义之前所致。解决的办法很简单，把 bar 的定义提前：

var bar = function () {
    // blablabla
}

var foo = function () {
    bar();
}

也可以把 bar 改成函数声明：

var foo = function () {
    bar();
}

function bar() {
    // blablabla
}

JS RULE073 [强制] 在 Equality Expression 中使用类型严格的 ===。仅当判断 null 或 undefined 时，允许使用 == null。

当判断 foo 为 null 或 undefined 时，使用 foo == null，不是 foo == undefined。

JS RULE086 [强制] 使用 parseInt 时，必须指定进制。

其实就是为 parseInt 指定第二个参数：

// bad
parseInt(str);

// good
parseInt(str, 10);

主要是防止低级浏览器中的 0 开头的字符默认识别为 8 进制问题：

parseInt('010'); // 8
parseInt('010', 10); // 10

JS RULE089 [强制] 字符串开头和结束使用单引号 '。

单引号输入时可以少按一个 Shift 键，而在拼写 HTML 字符串时，还可以保留 HTML 属性中的双引号，避免使用 \ 转义嵌套的双引号。

var foo = 'bar';

JS RULE093 [强制] 对象创建时，如果一个对象的所有 属性 均可以不添加引号，则所有 属性 不得添加引号。

JS RULE094 [强制] 对象创建时，如果任何一个 属性 需要添加引号，则所有 属性 必须添加 '。

这两个问题通常和《JS RULE030 [强制] 类的 方法 / 属性 使用 Camel命名法》相关。

当属性中使用下划线时，不需要添加双引号，但是此时会报 030 的问题。正确的做法是除非有某一属性名出现关键字或非字母数字和 $、_ 之外字符时，可以全部添加引号，否则不允许使用引号。

// 不允许添加引号
var foo = {
    'bar': true,
    'baz': false
};

// 必须全部添加引号
var foo = {
    'bar': true,
    'foo-baz': false
};

JS RULE998 [强制] 存在兼容性问题或运行时错误。（%s）

从 Cooder 或 eagle 报的描述中，%s 没有替换为具体的错误信息，所以需要本地运行 fecs 来获取详细的信息再作修改。

JS RULE999 [强制] 语法错误。（%s）

和 RULE998 问题一样，需要本地运行 fecs 来获取详细的信息再作修改。

HTML012 [强制] 对 HTML5 中规定允许省略的闭合标签，不允许省略闭合标签。

该错误源于对未闭合的标签的检查，示例如下：

<!-- good -->
<ul>
    <li>first</li>
    <li>second</li>
</ul>

<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>

不过大多数时候，报告该错误都是因为文件内容并非单纯HTML代码，而是某种模板，模板语法破坏了HTML本身的结构，导致一些HTML标签被认为没有正确闭合。对于模板文件，建议的做法是修改文件后缀名为.tpl或.tmpl，避免HTML规范检查。如果因为某些原因需要使用.html后缀名，可以使用.tpl.html，也可以避免检查。

HTML033 [强制] title 必须作为 head 的直接子元素，并紧随 charset 声明之后。

HTML024 [强制] 页面必须使用精简形式，明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。

这两个字面上很好理解，要求head中第一个子元素为指定字符编码的meta标签，紧随其后是title标签。 常见的不规范情况包括：

• meta标签未使用精简形式

  精简形式：

  <meta charset="UTF-8">

  非精简形式（不符规范）：

  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />

• meta或title标签位置不正确，规范明确要求了meta作为head的第一个直接子元素，且title紧随其后

其他

当错误超出以上范围，并且认为不需要修复代码，可按以下步骤处理：

• 安装 fecs

• 运行 fecs [files] --rule，记下打印出的错误行尾显示的规则名。

• 在文件头部使用 /* linter-disable ruleName */ 来屏蔽对应的规则。其中，JavaScript、CSS 和 HTML 文件分别对应的 linter 为 eslint、csshint 和 htmlcs。

• 如果只需要对指定代码块作规则屏蔽，可以在代码块结束后使用 /* linter-enable ruleName */ 来恢复规则检查。

注意：在 CSS 与 HTML 中，当省略 ruleName 时，意味着关闭对当前文件的检查，但 ruleName 不存在时，则忽略该条设置。