JSLint:如何标记错误的代码

JSLint: How to flag code as being wrong

本文关键字:代码 错误 何标记 JSLint      更新时间:2023-09-26

我想标记一些代码片段,稍后再回来。代码严重违反了我们的设计,我想确保每次运行JSHint时都能看到它,直到我修复它。

作为一个例子,假设要使其他东西工作,我更改以下代码:

addTwoNumbers: function(numberOne, numberTwo){
    return numberOne+numberTwo;
}

To this:

addTwoNumbers: function(numberOne, numberTwo){
    return 11;
}

JSLint对这些更改没有问题,但显然它们会给我带来一些麻烦。我们要做的是:

addTwoNumbers: function(numberOne, numberTwo){
    /* jslint fail */
    return 11;
}

这样,当我在提交之前运行JSLint时,我将看到我做了一些可能不应该做的事情。

或者,如果我打算提交代码(坏主意),并在几周后返回,我希望JSHint经常警告我。

我知道我可以使用"意外的TODO注释",但是我的团队(包括我)非常自由地使用TODO。最好采用另一种方法。

关于意外TODO注释的更多信息

这是一种编码风格,而不是语言错误,最近JSHint决定不在脚本中实现编码风格选项。

我不确定发展的状态,但它可能/成为可能编写扩展到JSHint来强制自己的编码风格。

但是,既然编程和编辑器存在,你所要求的已经完成了:

addTwoNumbers: function(numberOne, numberTwo){
    return 11; // TODO bad implementation, change it!
}

并让编辑器用黄色和红色突出显示评论,在行号列中添加/!',并将其与编辑器的警告一起列出!

但是不是 JSHint的工作,甚至不是linter的工作来检查这类事情!

我把这篇文章留在这里,一部分是给我自己,一部分是给其他有这个问题的人。

如果您使用grunt来调用jslint,您也可以使用grunt-todo。这允许您在项目中定义标签,然后它将在build/grunt上列出标签。默认情况下,它有一些内置标签,您可以添加自己的标签。我认为,如果代码库中有特定的标签,您甚至应该能够配置发布构建以失败。