Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Introduce buildifier config file #328

Merged
merged 1 commit into from
Jan 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .buildifier.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"type": "auto",
"mode": "fix",
"lint": "fix",
"warningsList": [
"attr-applicable_licenses",
"attr-cfg",
"attr-license",
"attr-licenses",
"attr-non-empty",
"attr-output-default",
"attr-single-file",
"build-args-kwargs",
"bzl-visibility",
"confusing-name",
"constant-glob",
"ctx-actions",
"ctx-args",
"deprecated-function",
"depset-items",
"depset-iteration",
"depset-union",
"dict-concatenation",
"dict-method-named-arg",
"duplicated-name",
"filetype",
"function-docstring-args",
"function-docstring-return",
"git-repository",
"http-archive",
"integer-division",
"keyword-positional-params",
"list-append",
"load",
"name-conventions",
"native-build",
"native-package",
"no-effect",
"output-group",
"overly-nested-depset",
"package-name",
"package-on-top",
"positional-args",
"print",
"provider-params",
"redefined-variable",
"repository-name",
"return-value",
"rule-impl-return",
"skylark-comment",
"skylark-docstring",
"string-iteration",
"uninitialized",
"unnamed-macro",
"unreachable",
"unsorted-dict-items",
"unused-variable"
]
}
12 changes: 10 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,23 @@ repos:
additional_dependencies:
- mdformat-gfm

# Ground truth for available checks: https://github.com/bazelbuild/buildtools/blob/main/warn/warn.go
# Documentation for checks: https://github.com/bazelbuild/buildtools/blob/main/WARNINGS.md?plain=1
# An example config file can be generated with command 'buildifier --config=example'
# We use all checks, even non default ones with those exceptions:
# - function-docstring: Not all functions require a docstring. If a docstring exists other checks ensure its sanity.
# - function-docstring-header: A dedicated docstring header often provides no added value.
# - module-docstring: Too noisy, not all modules require a docstring
# - naive-<some_language>: The auto fix uses the deprecated defs.bzl approach
- repo: https://github.com/keith/pre-commit-buildifier
rev: 7.3.1
hooks:
- id: buildifier
args: [ "--warnings=-load,+unsorted-dict-items,+native-py" ]
args: [ "--config=.buildifier.json" ]
- id: buildifier-lint
args: [
"--diff_command='diff'",
"--warnings=-module-docstring,-function-docstring,-function-docstring-header,-print"
"--config=.buildifier.json",
]

- repo: https://github.com/astral-sh/ruff-pre-commit
Expand Down
2 changes: 2 additions & 0 deletions src/utils/utils.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ def print_compilation_context(cc_info, headline = None):
cc = cc_info.compilation_context
headline_str = "\n" + headline if headline else ""
external_includes = cc.external_includes if hasattr(cc, "external_includes") else "NA"

# buildifier: disable=print
print("""{headline}
defines : {d}
local_defines : {ld}
Expand Down