File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1111# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212# See the License for the specific language governing permissions and
1313# limitations under the License.
14- #
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # Basic clang-format config for this project.
14+
15+ # Summary: configure clang-format for this project.
1716# See https://clang.llvm.org/docs/ClangFormatStyleOptions.html for more info.
18- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17+
18+ # Note: if you change line length or indentation here, update .editorconfig too.
1919---
2020Language : Cpp
2121BasedOnStyle : Google
Original file line number Diff line number Diff line change 1212# See the License for the specific language governing permissions and
1313# limitations under the License.
1414
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # Common editor configurations for this project.
17- #
18- # EditorConfig is a file format for specifying some common style parameters.
15+ # Summary: define basic code editor style parameters for this project.
16+
1917# Many IDEs & editors read .editorconfig files, either natively or via plugins.
2018# We mostly follow Google's style guides (https://google.github.io/styleguide/)
2119# with only a few deviations for line length and indentation in some files.
22- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2320
2421root = true
2522
@@ -41,6 +38,10 @@ indent_size = 4
4138[{CMakeLists.txt,* .cmake} ]
4239indent_size = 4
4340
41+ [{Makefile,makefile,* .mk} ]
42+ indent_style = tab
43+ indent_size = 4
44+
4445[{* .cc,* .h} ]
4546indent_size = 2
4647
@@ -51,7 +52,7 @@ indent_size = 2
5152indent_size = 4
5253
5354[* .sh ]
54- indent_size = 2
55+ indent_size = 4
5556
5657[{* .yaml,* .yml} ]
5758indent_size = 2
Original file line number Diff line number Diff line change 1212# See the License for the specific language governing permissions and
1313# limitations under the License.
1414
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # Hadolint (a Dockerfile linter) used in this project's CI checks.
15+ # Summary: configure the Dockerfile linter "hadolint" for this project.
1716# Info about options can be found at https://github.com/hadolint/hadolint/.
1817# Rule/error numbers are described at https://github.com/hadolint/hadolint/wiki
19- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2018
2119format : tty
2220no-color : false
Original file line number Diff line number Diff line change 1212# See the License for the specific language governing permissions and
1313# limitations under the License.
1414
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # Project configuration for jsonlint (https://github.com/prantlf/jsonlint).
17- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+ # Summary: configure https://github.com/prantlf/jsonlint for this project.
1816
1917comments : false
2018compact : true
2119continue : true
2220endOfLine : lf
21+ # Note: if you change indentation or line length, update .editorconfig too.
2322indent : 2
2423log-files : false
2524no-duplicate-keys : true
Original file line number Diff line number Diff line change 1313 // See the License for the specific language governing permissions and
1414 // limitations under the License.
1515
16- // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17- // Markdownlint linter configuration for this project.
16+ // Summary: configure markdownlint for this project.
1817 //
1918 // Note: there are multiple programs programs named "markdownlint". We use
2019 // https://github.com/igorshubovych/markdownlint-cli/, which is the one you
2827 // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
2928 // (Beware that the above looks similar but is NOT the same as the page
3029 // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md.)
31- // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3230
3331 "$schema" : " https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json" ,
3432
Original file line number Diff line number Diff line change 1212# See the License for the specific language governing permissions and
1313# limitations under the License.
1414
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # yamlfmt configuration for this project.
15+ # Summary: configure yamlfmt for this project.
1716# See https://github.com/google/yamlfmt for info about options.
18- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1917
2018# Read .gitignore for paths to exclude.
2119gitignore_excludes : true
2220
2321formatter :
2422 type : basic
2523 eof_newline : true
24+ # Note: if you change the line length here, update .editorconfig too.
2625 max_line_length : 80
2726 retain_line_breaks : true
2827 trim_trailing_whitespace : true
Original file line number Diff line number Diff line change 1212# See the License for the specific language governing permissions and
1313# limitations under the License.
1414
15- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16- # Yamllint configuration to match project settings like line length.
15+ # Summary: configure yamllint for this project.
1716# See https://yamllint.readthedocs.io/ for info about configuration options.
18- # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1917
2018rules :
2119 line-length :
20+ # Note: if you change the line length here, update .editorconfig too.
2221 max : 80
2322 # When the last item on a line can't be broken (e.g., a URL as a value),
2423 # it's rarely useful to flag it. The next 2 settings save developer time by
You can’t perform that action at this time.
0 commit comments