如何为项目设置标准的linter、格式化程序和设置，并将其保存到git repo？

Question

我希望克隆存储库的其他人拥有这些设置，现在我有一个包含这些设置的settings/.vscode文件

{
    "files.exclude": {
        "*/__pycache__": true,
        "*/*/__pycache__": true,
        ".mypy_cache": true,
        ...
    },
    "python.linting.pylintEnabled": false,
    "python.linting.flake8Enabled": true,
    "python.linting.lintOnSave": true,
    "editor.formatOnPaste": true,
    "editor.formatOnSave": true,
    "editor.wordWrapColumn": 100,
    "python.formatting.provider": "autopep8",
    "python.formatting.autopep8Path": "autopep8",
    "python.linting.mypyEnabled": true,
    "python.linting.enabled": true,
}

我不想将这些设置保存到通用存储库

"python.linting.pylintEnabled": false,
"python.linting.flake8Enabled": true,
"python.linting.lintOnSave": true,
"python.formatting.autopep8Path": "autopep8",
"files.exclude": {
    "*/__pycache__": true,
    "*/*/__pycache__": true,
    ".mypy_cache": true,
    ...
},

但其他的一切我都会

我发现我可以创建一个.editorconfig，但我可以找到如何在其中设置linters和格式化程序。我真的只能找到两个我想要的设置，但找不到其他设置

trim_trailing_whitespace = true
max-line-length = 100

Answer 1

在这种情况下，最好的做法是在.editorconfig文件中设置您能做的任何设置，然后选择您的链接器并将它们的配置文件提交到存储库，通常是在顶层。如何配置它们，将它们的配置文件放在哪里，以及如何以适当的方式调用它们，这实际上取决于您所使用的工具。如果不清楚，您可以提供一个脚本，以便以适当的方式为您的项目调用linter。然后，如果您的语言有多个明显的选择，请记录您正在使用的linter，并将CI设置为在您的存储库中自动运行它们。

请注意，.editorconfig文件不指定大多数格式选项。它们对于指定人们在编写代码时最常用的选项很有用，例如缩进大小、制表符与空格、行长和行尾，但它们不能取代特定于您的语言的好的linter或格式化工具。

但是，通常情况下，您希望避免将特定于编辑器的文件提交到存储库。仅仅因为你使用VS Code并不意味着每个人都使用VS Code，而且你的VS Code设置对于使用不同编辑器的人来说是完全无用的，比如Vim或Emacs。此外，很多时候，特定于编辑器的配置文件包含不特定于代码样式的选项，而VS code的其他用户可能不关心您的特定设置。

如果您有构建产品的文件或不想签入到存储库中的缓存文件，这些文件应该放入存储库中的.gitignore文件中。这将阻止所有Git用户签入它们。如果您有特定于编辑器的文件(例如，备份文件或交换文件)，请使用Git的core.excludesfile选项在指定的文件中配置这些文件。