如何让gopls忽略Go项目中gqlgen生成的文件/目录？

以下是几种可行的方案，按精准度从高到低排序：

1. 精准排除单个文件的所有诊断 #

在VSCode的settings.json中配置gopls的诊断排除规则，只屏蔽目标生成文件的警告：

• 打开VSCode设置（快捷键Ctrl+,），搜索Go: Gopls Settings，选择Edit in settings.json
• 添加如下配置：

"gopls": {
  "diagnostics": {
    "exclude": [
      "app/api/graphql/graph/generated.go"
    ]
  }
}

修改完成后，重启VSCode或执行Ctrl+Shift+P -> Reload Window使配置生效。

2. 排除文件参与gopls构建分析 #

如果不想让gopls完全分析该生成文件，可以使用build.excludeFiles配置，比目录排除更精准：

"gopls": {
  "build": {
    "excludeFiles": [
      "**/graph/generated.go" // 通配符匹配，也可以写完整路径
    ]
  }
}

同样需要重启窗口生效。

3. 全局关闭unusedparams分析（不推荐，除非全局不需要） #

如果暂时可以接受关闭所有未使用参数的检查，直接禁用该分析项：

"gopls": {
  "analyses": {
    "unusedparams": false
  }
}

4. 给生成文件添加忽略注释 #

在generated.go的文件顶部添加特定注释，告知gopls忽略未使用参数的警告：

//go:generate gqlgen
//nolint:unusedparams
package graph

注意：部分版本的gopls可能对nolint注释支持有限，优先尝试前两种方案。

额外注意事项 #

• 确保gopls是最新版本，旧版本可能不支持部分配置：执行go install golang.org/x/tools/gopls@latest更新
• 之前配置的build.directoryFilters无效，可能是因为目录路径书写错误（需加负号-前缀，如["-app/api/graphql/graph"]），但这种方式会排除整个目录，若目录内还有其他需要分析的文件，不建议使用

内容的提问来源于stack exchange，提问作者Herza Islad