SonarQube无法识别自定义String.prototype方法，如何不排除文件解决？

我来帮你搞定这个SonarQube的报错问题！之所以会出现“‘contains’属性不存在”的提示，是因为SonarQube的代码分析逻辑默认只认JavaScript标准内置API，你给String.prototype加的自定义方法不在它的默认识别列表里。下面几个方案都不用排除文件检查，按需选择即可：

1. 给SonarQube补充自定义全局类型声明 #

这是最推荐的全局解决方案，一次性搞定所有同类型问题：

• 新建一个专门的声明文件，比如string-prototype-extensions.js（JS项目）或者string-prototype-extensions.d.ts（TS项目），在里面定义你的自定义方法：
  • JavaScript项目的声明示例：

    /**
     * 判断字符串是否包含指定子串
     * @param {string} str - 要查找的子串
     * @param {number} [startIndex=0] - 开始查找的起始索引
     * @returns {boolean} 找到返回true，否则返回false
     */
    String.prototype.contains = function(str, startIndex) {};
    

  • TypeScript项目的声明示例：

    interface String {
      contains(str: string, startIndex?: number): boolean;
    }
    

• 确保这个文件被SonarQube扫描到（不要在SonarQube里排除它），扫描时SonarQube会读取这个声明，就不会再认为contains是未定义属性了。

2. 用// NOSONAR精准忽略单条报错 #

如果只是个别代码行报错，不想全局配置，可以在报错代码附近加注释精准忽略：

// NOSONAR - 自定义的String.prototype.contains已在其他文件定义
if (myString.contains("hello")) {
  // 业务逻辑代码
}

这个注释只会跳过当前行的这条规则检查，不会影响文件里其他代码的SonarQube校验，非常灵活。

3. 全局调整SonarQube规则（不推荐） #

如果你的项目里有大量自定义的prototype扩展，也可以在SonarQube的项目设置里，找到规则javascript:S2685（检测未定义属性访问的那条规则），把它的级别改成“关闭”或者降低为不影响你的等级。
不过这个方法是全局禁用该规则，可能会漏掉真正的“访问未定义属性”错误，所以除非万不得已，优先选前两个方案。

4. 改用ES标准的includes方法（如果环境允许） #

其实ES6已经内置了String.prototype.includes方法，功能和你自定义的contains几乎完全一致。如果你的项目运行环境支持ES6+，直接把自定义的contains替换成标准的includes，既不用折腾SonarQube配置，还能避免自定义prototype可能带来的冲突问题，一举两得。

选哪个方案看你项目的实际情况，个人优先推荐方案1或者方案4哦！

内容的提问来源于stack exchange，提问作者Vikram Kumar