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

Add taplo pre-commit hook to format and sort toml files #1207

Merged
merged 7 commits into from
Nov 18, 2024
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
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,10 @@ repos:
- id: sp-repo-review
additional_dependencies: ["repo-review[cli]"]
args: ["--show=errskip"]

- repo: https://github.com/ComPWA/taplo-pre-commit
rev: v0.9.3
hooks:
- id: taplo-format
# See options: https://taplo.tamasfe.dev/configuration/formatter-options.html
args: [--option, "reorder_arrays=true", --option, "reorder_keys=true"]
70 changes: 35 additions & 35 deletions .ruff.toml
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
extend = "pyproject.toml"

lint.ignore = [
# NOTE: To find a rule code to fix, run:
# ruff --select="ALL" --statistics src/geovista/<subpackage>
# NOTE: To find a rule code to fix, run:
# ruff --select="ALL" --statistics src/geovista/<subpackage>

# flake8-boolean-trap (FBT)
# https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
# NOTE: A good thing to fix, but changes API.
"FBT001", # boolean-positional-arg-in-function-definition.
"FBT002", # boolean-default-value-in-function-definition.
"FBT003", # boolean-positional-value-in-function-call.
# flake8-boolean-trap (FBT)
# https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
# NOTE: A good thing to fix, but changes API.
"FBT001", # boolean-positional-arg-in-function-definition.
"FBT002", # boolean-default-value-in-function-definition.
"FBT003", # boolean-positional-value-in-function-call.

# Pylint (PL)
# https://docs.astral.sh/ruff/rules/#pylint-pl
"PLR0912", # Too many branches.
"PLR0913", # Too many arguments in function definition.
"PLR0915", # Too many statements.
"PLR2004", # Magic value used in comparison, consider replacing with a constant.
"PLW0603", # Using the global statement to update is discouraged.
# Pylint (PL)
# https://docs.astral.sh/ruff/rules/#pylint-pl
"PLR0912", # Too many branches.
"PLR0913", # Too many arguments in function definition.
"PLR0915", # Too many statements.
"PLR2004", # Magic value used in comparison, consider replacing with a constant.
"PLW0603", # Using the global statement to update is discouraged.

# flake8-self (SLF)
# https://docs.astral.sh/ruff/rules/#flake8-self-slf
"SLF001", # Private member accessed.
# flake8-self (SLF)
# https://docs.astral.sh/ruff/rules/#flake8-self-slf
"SLF001", # Private member accessed.

# flake8-todos (TD)
# https://docs.astral.sh/ruff/rules/#flake8-todos-td
"TD003", # Missing issue link on the line following this TODO.
# flake8-todos (TD)
# https://docs.astral.sh/ruff/rules/#flake8-todos-td
"TD003", # Missing issue link on the line following this TODO.
]

[lint.extend-per-file-ignores]
"conftest.py" = [
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN001", # Missing type annotation for function argument.
"ANN201", # Missing return type annotation for public function.
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN001", # Missing type annotation for function argument.
"ANN201", # Missing return type annotation for public function.
]
"src/geovista/geoplotter.py" = [
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN401", # Dynamically typed expressions (typing.Any).
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN401", # Dynamically typed expressions (typing.Any).
]
"test_*.py" = [
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN001", # Missing type annotation for function argument.
"ANN201", # Missing return type annotation for public funciton.
# flake8-annotations (ANN)
# https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
"ANN001", # Missing type annotation for function argument.
"ANN201", # Missing return type annotation for public funciton.
]
"test_slice_lines.py" = [
# eradicate (ERA)
# https://docs.astral.sh/ruff/rules/#eradicate-era
"ERA001", # Found commented-out code.
# eradicate (ERA)
# https://docs.astral.sh/ruff/rules/#eradicate-era
"ERA001", # Found commented-out code.
]
1 change: 1 addition & 0 deletions changelog/1207.contributor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add `taplo <https://github.com/tamasfe/taplo>`__ pre-commit hook to format and sort toml files. (:user:`tkoyama010`)
Loading
Loading