Skip to content

Commit 5efd7b9

Browse files
committed
Add a note to update other files & streamline comments
In some places, the value of a linter configuration property should match the value of the editor configuration in `.editorconfig`. This is easily forgotten, so I added a comment to remind us. Also, I streamlined the introductory comments at the tops of the files to make them less verbose.
1 parent 82c217c commit 5efd7b9

6 files changed

Lines changed: 12 additions & 19 deletions

File tree

.clang-format

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
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
---
2020
Language: Cpp
2121
BasedOnStyle: Google

.hadolint.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@
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

2119
format: tty
2220
no-color: false

.jsonlintrc.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,13 @@
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

1917
comments: false
2018
compact: true
2119
continue: true
2220
endOfLine: lf
21+
# Note: if you change indentation or line length, update .editorconfig too.
2322
indent: 2
2423
log-files: false
2524
no-duplicate-keys: true

.markdownlintrc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
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
@@ -28,7 +27,6 @@
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

.yamlfmt.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,16 @@
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.
2119
gitignore_excludes: true
2220

2321
formatter:
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

.yamllint.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@
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

2018
rules:
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

0 commit comments

Comments
 (0)