From 3b08ca63f03aed2db808a8ddcdab0f1b636c2e31 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:02:09 -0700 Subject: [PATCH 1/8] Add a .clang-format file This uses a line length of 80, because analysis of existing files shows that the greatest number of lines in the files are 80 chars or less. --- .clang-format | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .clang-format diff --git a/.clang-format b/.clang-format new file mode 100644 index 000000000..ea69660c0 --- /dev/null +++ b/.clang-format @@ -0,0 +1,35 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# Basic clang-format config for this project. +# See https://clang.llvm.org/docs/ClangFormatStyleOptions.html for more info. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--- +Language: Cpp +BasedOnStyle: Google +ColumnLimit: 80 +AlignAfterOpenBracket: AlwaysBreak +IncludeCategories: + - Regex: '^<.*>$' + Priority: 1 + - Regex: '^"gtest/.*"$' + Priority: 2 + - Regex: '^".*"$' + Priority: 3 +IncludeIsMainRegex: '([.](test|benchmark))?$' +--- +Language: Proto +BasedOnStyle: Google +... From dc62f6ce23b08b8fd46f8903708bffebaf7cf07e Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:02:18 -0700 Subject: [PATCH 2/8] Add a .editorconfig file --- .editorconfig | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..b0898f1d5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,54 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# Common editor configurations for this project. +# +# EditorConfig is a file format for specifying some common style parameters. +# Many IDEs & editors read .editorconfig files, either natively or via plugins. +# We mostly follow Google's style guides (https://google.github.io/styleguide/) +# with only a few deviations for line length and indentation in some files. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +root = true + +# IMPORTANT: some of the other config files (.markdownlintrc, .jsonlintrc.yaml, +# etc.) also have settings for indent and line length. When making changes to +# this file, make sure to update the other files to match. + +[*] +charset = utf-8 +indent_style = space +insert_final_newline = true +spelling_language = en-US +trim_trailing_whitespace = true +max_line_length = 80 + +[{BUILD,*.BUILD,*.bzl,*.bazel,.bazelrc}] +indent_size = 4 + +[{*.cc,*.h}] +indent_size = 2 + +[*.json] +indent_size = 2 + +[*.py] +indent_size = 4 + +[*.sh] +indent_size = 2 + +[{*.yaml,*.yml}] +indent_size = 2 From c7398ea7806e8d195095a9d9b615410250dd7e6e Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:02:39 -0700 Subject: [PATCH 3/8] Add a .hadolint config file This is for the Dockerfile linter program `hadolint`. --- .hadolint.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .hadolint.yaml diff --git a/.hadolint.yaml b/.hadolint.yaml new file mode 100644 index 000000000..b74c09c1b --- /dev/null +++ b/.hadolint.yaml @@ -0,0 +1,27 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# Hadolint (a Dockerfile linter) used in this project's CI checks. +# Info about options can be found at https://github.com/hadolint/hadolint/. +# Rule/error numbers are described at https://github.com/hadolint/hadolint/wiki +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +format: tty +no-color: false +no-fail: false +failure-threshold: error +ignored: + # Multiple consecutive RUN stmts are usually deliberate. Don't flag that. + - DL3059 From af980fc0e531c08ca86977c703ab8e70ada30b19 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:02:52 -0700 Subject: [PATCH 4/8] Add a jsonlint config file --- .jsonlintrc.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .jsonlintrc.yaml diff --git a/.jsonlintrc.yaml b/.jsonlintrc.yaml new file mode 100644 index 000000000..f541f8a00 --- /dev/null +++ b/.jsonlintrc.yaml @@ -0,0 +1,30 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# Project configuration for jsonlint (https://github.com/prantlf/jsonlint). +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +comments: false +compact: true +continue: true +endOfLine: lf +indent: 2 +log-files: false +no-duplicate-keys: true +patterns: + - '**/*.json' + - '!**/node_modules' +singleQuote: false +trailing-commas: false From d667dcb3a77a15d5d987341a6b7f16065bcd0b22 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:03:00 -0700 Subject: [PATCH 5/8] Add a markdownlint config file --- .markdownlintrc | 160 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 .markdownlintrc diff --git a/.markdownlintrc b/.markdownlintrc new file mode 100644 index 000000000..4e4a75530 --- /dev/null +++ b/.markdownlintrc @@ -0,0 +1,160 @@ +{ // -*- jsonc -*- + // Copyright 2025 Google LLC + // + // Licensed under the Apache License, Version 2.0 (the "License"); + // you may not use this file except in compliance with the License. + // You may obtain a copy of the License at + // + // https://www.apache.org/licenses/LICENSE-2.0 + // + // Unless required by applicable law or agreed to in writing, software + // distributed under the License is distributed on an "AS IS" BASIS, + // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + // See the License for the specific language governing permissions and + // limitations under the License. + + // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + // Markdownlint linter configuration for this project. + // + // Note: there are multiple programs programs named "markdownlint". We use + // https://github.com/igorshubovych/markdownlint-cli/, which is the one you + // get with "brew install markdownlint" on MacOS. + // + // These settings try to stay close to the Google Markdown Style as + // described at https://google.github.io/styleguide/docguide/style.html + // with very few differences. + // + // For a list of possible configuration options, see the following page: + // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md + // (Beware that the above looks similar but is NOT the same as the page + // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md.) + // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json", + + // Require ATX-style headings. + // https://google.github.io/styleguide/docguide/style.html#atx-style-headings + "headings": { + "style": "atx" + }, + + // Google style does not require that the first line of a file is a heading + // for the title; it only states that the first heading should be a level 1. + // https://google.github.io/styleguide/docguide/style.html#document-layout + "first-line-heading": false, + + // The Google style does not define what to do about trailing punctuation in + // headings. The markdownlint default disallows exclamation points, which + // seems likely to be more annoying than useful – I have definitely seen + // people use exclamation points in headings in README files on GitHub. + // This setting removes exclamation point from the banned characters. + "no-trailing-punctuation": { + "punctuation": ".,;:。，；：" + }, + + // No trailing spaces. + // https://google.github.io/styleguide/docguide/style.html#trailing-whitespace + "whitespace": { + "br_spaces": 0 + }, + + // Google style is 80 characters. + // Google style exempts some constructs from the line-length limit: + // https://google.github.io/styleguide/docguide/style.html#exceptions + "line-length": { + "line_length": 80, + "code_block_line_length": 80, + "heading_line_length": 80, + "code_blocks": false, + "headings": false, + "tables": false + }, + + // Google Markdown style specifies 2 spaces after item numbers, 3 spaces + // after bullets, so that the text itself is consistently indented 4 spaces. + // https://google.github.io/styleguide/docguide/style.html#nested-list-spacing + "list-marker-space": { + "ol_multi": 2, + "ol_single": 2, + "ul_multi": 3, + "ul_single": 3 + }, + + "ul-indent": { + "indent": 4 + }, + + // Bare URLs are allowed in GitHub-flavored Markdown and in Google’s style. + "no-bare-urls": false, + + // Basic Markdown allows raw HTML. Both GitHub & PyPI support subsets of + // HTML, though it's unclear what subset PyPI supports. Google's style guide + // recommends against using raw HTML, but does allow it. (C.f. the bottom of + // https://google.github.io/styleguide/docguide/style.html) Google's in-house + // documentation system allows many inline and block-level tags, but strips + // others that can pose security risks (e.g., and standalone ). + // The list below tries to capture the intersection of what GitHub allows + // (c.f. https://github.com/github/markup/issues/245#issuecomment-682231577), + // what PyPI seems to allow, what Google allows, and what seems likely to be + // most useful in situations where someone needs to reach for HTML. + "html": { + "allowed_elements": [ + "a", + "abbr", + "b", + "blockquote", + "br", + "caption", + "cite", + "code", + "dd", + "del", + "details", + "dfn", + "div", + "dl", + "dt", + "em", + "figcaption", + "figure", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "hr", + "i", + "img", + "ins", + "kbd", + "li", + "mark", + "ol", + "p", + "picture", + "pre", + "q", + "s", + "samp", + "small", + "span", + "strong", + "sub", + "summary", + "sup", + "table", + "tbody", + "td", + "tfoot", + "th", + "thead", + "time", + "tr", + "tt", + "ul", + "var", + "wbr" + ] + } +} From 80f9f8214a8ef32a33cfbf441c3a16fae6972830 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:03:09 -0700 Subject: [PATCH 6/8] Add a yamlfmt config file --- .yamlfmt.yaml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .yamlfmt.yaml diff --git a/.yamlfmt.yaml b/.yamlfmt.yaml new file mode 100644 index 000000000..a52423c5f --- /dev/null +++ b/.yamlfmt.yaml @@ -0,0 +1,28 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# yamlfmt configuration for this project. +# See https://github.com/google/yamlfmt for info about options. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +# Read .gitignore for paths to exclude. +gitignore_excludes: true + +formatter: + type: basic + eof_newline: true + max_line_length: 80 + retain_line_breaks: true + trim_trailing_whitespace: true From 3147dbacd944aebdb71afd8299a7bb20fdb51eb0 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:03:14 -0700 Subject: [PATCH 7/8] Add a yamllint config file --- .yamllint.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .yamllint.yaml diff --git a/.yamllint.yaml b/.yamllint.yaml new file mode 100644 index 000000000..5180e5b66 --- /dev/null +++ b/.yamllint.yaml @@ -0,0 +1,27 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# Yamllint configuration to match project settings like line length. +# See https://yamllint.readthedocs.io/ for info about configuration options. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +rules: + line-length: + max: 100 + # When the last item on a line can't be broken (e.g., a URL as a value), + # it's rarely useful to flag it. The next 2 settings save developer time by + # not requiring comment directives to disable warnings at every occurrence. + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: true From 353b04c439586fbd6e61d6f05fdde874c1ef2ac9 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Fri, 23 May 2025 19:04:15 -0700 Subject: [PATCH 8/8] Use 80 chars, not 100 The lines in the files of this project are most often 80 chars or less, so let's use that as the convention for this project. --- .yamllint.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.yamllint.yaml b/.yamllint.yaml index 5180e5b66..5e144cb27 100644 --- a/.yamllint.yaml +++ b/.yamllint.yaml @@ -19,7 +19,7 @@ rules: line-length: - max: 100 + max: 80 # When the last item on a line can't be broken (e.g., a URL as a value), # it's rarely useful to flag it. The next 2 settings save developer time by # not requiring comment directives to disable warnings at every occurrence.