git - linter 配置文件应该在 .gitignore 中吗？

Question

像 eslintrc、prettierrc 或 .editorconfig 这样的文件应该在 .gitignore 中吗？存在与 linter 配置相关的任何良好实践吗？

标签： gitstatic-analysis

Answer 1

您应该签入（即提交而不是忽略）linter 配置文件和独立于编辑器的样式和格式配置文件（如.editorconfigor .clang-format）。这些存在于存储库中很重要，因为它们设置了适用于所有开发人员的样式，并让所有开发人员使用他们的工具应用相同的标准。这对于自动 linting 和格式检查（例如，通过 CI）很重要。

但是，您不应签入任何特定于编辑器或开发人员的配置文件。例如，您不会签入 Vim 的配置文件，因为并非所有开发人员都使用 Vim。（即使您的所有开发人员都使用相同的编辑器，您也不应该这样做，因为设置可能不同。）同样，您不会签入指示特定开发人员测试证书的代码签名文件，因为每个开发人员工作都会改变在项目上。这些东西应该以用户特定的方式列出，.gitignore除非它们可能出现在每个开发人员的系统上（例如特定于项目的配置文件），在这种情况下，存储库中的那个是最好的。