Skip to content

Commit

Permalink
Add editorconfig to help OSS contributors
Browse files Browse the repository at this point in the history
When switching between many different open source code bases, it can be
cumbersome to constantly change editor settings in order to respect a
given project's basic style preferences. EditorConfig is a popular
format for representing those preferences so editors can automatically
respect them.

Many editors support EditorConfig out of the box, and many others have
EditorConfig plugins:
https://editorconfig.org/#pre-installed

This commit adds an EditorConfig to the ModSecurity project. It is most
likely not perfect because the chosen indentation varies a bit
throughout the project, but hopefully it provides a good basis for most
ModSecurity editing.
  • Loading branch information
brandonpayton committed May 5, 2023
1 parent 1078a7c commit 6ad665f
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
indent_style = space
# Scripts without suffixes in the project root tend to indent by two spaces
indent_size = 2

# Most of the project files indent by four spaces
[*/**]
indent_size = 4

# Test files indent by two spaces
[test/**]
indent_size = 2

# The config parser file indents by both two and four spaces,
# so we choose to indent by two spaces as a common denominator.
[*.yy]
indent_size = 2

[{Makefile,Makefile.am}]
indent_style = tab

0 comments on commit 6ad665f

Please sign in to comment.