From 8e92d3a3a2deedf0114f9227935a7aa4c98523f0 Mon Sep 17 00:00:00 2001 From: Chandler Carruth Date: Tue, 21 May 2024 03:15:46 +0200 Subject: [PATCH] Stop skipping JSON copyright & license headers by default. (#3959) A lot of the JSON we use is parsed by VSCode or other systems that are happy to have comments in them, and we should retain a license header there. We can exclude specific files where this is a problem. I think the `package.json` and generated lock file from it are two such cases where we can't have the license header, but we can directly exclude more as needed. This should help make sure that when we *do* have a license header in a JSON file it stays up to date and is formatted canonically. --- .devcontainer/devcontainer.json | 4 ++++ .pre-commit-config.yaml | 13 +++++++------ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index cc83ebc162db..5dbfdc133c81 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,3 +1,7 @@ +// Part of the Carbon Language project, under the Apache License v2.0 with LLVM +// Exceptions. See /LICENSE for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + { "name": "carbon-lang", "build": { diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7bac9e330ccb..88f370ff82f7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -179,8 +179,12 @@ repos: Part of the Carbon Language project, under the Apache License v2.0 with LLVM Exceptions. See /LICENSE for license information. SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + - --skip_pattern + # The default skip pattern skips JSON which we use with VSCode and + # it, like most file-based parsers, can support comments easily. + - '(^LICENSE|\.(ico))$' - --custom_format - - '\.(carbon|proto|ypp)(\.tmpl)?$' + - '\.(carbon|c|json|proto|ypp)(\.tmpl)?$' - '' - '// ' - '' @@ -209,18 +213,15 @@ repos: - '' - '-- ' - '' - - --custom_format - - '\.c$' - - '' - - '// ' - - '' exclude: | (?x)^( .bazelversion| .github/pull_request_template.md| + .vscode/extensions.json| compile_flags.txt| github_tools/requirements.txt| third_party/.*| + utils/vscode/package(-lock)?.json| .*\.def| .*\.svg| .*/fuzzer_corpus/.*|