可以忽略/排除.editorconfig中的文件/文件夹吗？

Question

如何在.editorconfig中忽略/排除文件或文件夹？

原因：我有一个包含第三方文件的 /vendor 文件夹。我不希望该文件夹继承我的任何.editorconfig配置。

我查看了EditorConfig-Properties页面，似乎没有任何可以排除文件夹的属性。也许有一些技巧可以实现呢？

当前配置

root = true

[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab

- iDev247

---

我在考虑，也许我可以仅仅调整一下规则。不用通配符[*]涵盖所有内容，而是指定要包含的文件夹，而非试图排除文件夹。有没有办法实现只在根目录生效的规则？ - iDev247

Answer 1

忽略/vendor文件夹的另一个解决方案:

• 匹配您想要忽略的路径
• 将要忽略的属性设置为unset

例如，如果您有以下内容：

• /index.html
• /vendor
• /.editorconfig

您可以在.editorconfig中匹配vendor目录中的所有文件，并忽略所有属性（设置为IDE的默认值）：

# top-most EditorConfig file
root = true

# Ignore paths
[/vendor/**]
charset = unset
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
indent_size = unset

- Danail

---

我认为这是一个更好的解决方案，因为它将所有的编辑器配置都保存在一个地方。 - Rob Young

“官方”的方法是将它们设置为 unset。VS Code 的 EditorConfig 插件也会作为智能感知的一部分建议这样做。但是任何无效值都可以工作。 - Mario Tacke

对于我的.jinjalintconfig.py文件，如果我使用unset、ignore或ignore，我会得到NameError: name '' is not defined。 - Akin Hwan

这个答案应该更新，使用现在文档化的 unset 值。否则，这个答案是完全正确的。 - David Baucum

Answer 2

你可以在 vender/ 目录下创建一个简单的 root = true 行的 .editorconfig 文件。

- xuhdev

---

@avandecreme 在 .editorconfig 文件中应该只有一行。 root = true 不属于任何部分。 - xuhdev

是的，那就是我拥有的内容，但某些部分不知何故自动添加了。也许是 Netbeans 插件的错误。 - avandecreme

@xuhdev，但供应商或node_modules目录没有版本控制，因此在这些目录中放置 .editorconfig 不是一个选择。还有其他方法吗？ - Maykonn

@Maykonn，你能创建目录，添加.editorconfig并对此文件进行版本控制吗？ - xuhdev

@xuhdev 我刚刚尝试过这样做了，答案是肯定的，但会有问题。每次我运行 yarn 命令时，它都会删除我的 node_modules/.editorconfig 文件，即使在 Git 中已经将其检入。 - Oliver Joseph Ash

Answer 3

在IntelliJ中，有一个非常棒的功能，它在一个月前才到来：

ij_formatter_enabled = true/false

只需在您的 .editorconfig 中匹配一个模式或文件类型，匹配的资源将被忽略：

[{**/*.sql,**/*.properties,**/File.kt}]
ij_formatter_enabled = false

感谢 JetBrains！

- fast-reflexes

---

我也可以用这个匹配整个文件夹吗？ - Gandora

我认为是这样的，例如templates/*...但很容易检查和找出来，所以试一下吧 :) - fast-reflexes

Answer 4

我发现最好的方法是在你想要忽略的文件夹中添加一个否则为空的 .editorconfig 文件，如下所示：

[*]
generated_code = true

- kzu

---

请注意，这尚未成为核心的EditorConfig标准的一部分，所以在您的环境中可能会有所不同（例如，VSCode Editorconfig扩展不支持此功能，而Visual Studio则支持）。https://github.com/editorconfig/editorconfig/issues/399 - undefined

Answer 5

结合本帖中其他人的答案，创建以下解决方案，以简单地关闭文件夹内文件的整个 .editorconfig，同时仍将其保留在基本 .editorconfig 文件中。注意：根据微软文档（https://learn.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022），这是自 VS 2019 16.5 新增的功能。

# top-most EditorConfig file
root = true

# Ignore paths
[*/Migrations/*]
generated_code = true

- kcanders