Skip to content

Commit

Permalink
Enable style checks (#293)
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram authored Oct 2, 2024
2 parents e4dbc44 + 5f94030 commit 787aa81
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 52 deletions.
36 changes: 15 additions & 21 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ repos:
- id: check-symlinks
- id: debug-statements
- id: detect-private-key
- id: end-of-file-fixer
- id: trailing-whitespace
# - id: end-of-file-fixer
# - id: trailing-whitespace

- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
Expand All @@ -22,26 +22,26 @@ repos:
- id: rst-inline-touching-normal
- id: text-unicode-replacement-char

- repo: https://github.com/codespell-project/codespell
rev: v2.2.5
hooks:
- id: codespell
args: ["--write-changes"]
additional_dependencies:
- tomli
# - repo: https://github.com/codespell-project/codespell
# rev: v2.2.5
# hooks:
# - id: codespell
# args: ["--write-changes"]
# additional_dependencies:
# - tomli

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.1.5"
hooks:
- id: ruff
args: ["--fix", "--show-fixes"]
- id: ruff-format
# - id: ruff-format

- repo: https://github.com/MarcoGorelli/cython-lint
rev: v0.15.0
hooks:
- id: cython-lint
- id: double-quote-cython-strings
# - id: double-quote-cython-strings

- repo: https://github.com/pycqa/isort
rev: 5.12.0
Expand All @@ -57,13 +57,7 @@ repos:
additional_dependencies:
- black==22.12.0

- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v3.0.1"
hooks:
- id: prettier

- repo: https://github.com/scientific-python/cookie
rev: 2023.10.27
hooks:
- id: sp-repo-review
additional_dependencies: ["repo-review[cli]"]
# - repo: https://github.com/pre-commit/mirrors-prettier
# rev: "v3.0.1"
# hooks:
# - id: prettier
52 changes: 22 additions & 30 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -120,50 +120,50 @@ src = [
]

[tool.ruff.lint]
extend-select = [
"F", # Pyflakes (part of default flake8)
"W", "E", # pycodestyle (part of default flake8)
"I", # isort (import sorting)
select = [
#"F", # Pyflakes (part of default flake8)
#"W", "E", # pycodestyle (part of default flake8)
#"I", # isort (import sorting)
# "N", # pep8-naming
"D", # pydocstyle (docstring style guide)
"UP", # pyupgrade (upgrade code to modern python)
#"D", # pydocstyle (docstring style guide)
#"UP", # pyupgrade (upgrade code to modern python)
"YTT", # flake8-2020 (system version info)
"ANN", # flake8-annotations (best practices for type annotations)
"S", # flake8-bandit (security checks)
#"S", # flake8-bandit (security checks)
"BLE", # flake8-blind-except (prevent blind except statements)
"B", # flake8-bugbear (prevent common gotcha bugs)
#"B", # flake8-bugbear (prevent common gotcha bugs)
"A", # flake8-builtins (prevent shadowing of builtins)
"C4", # flake8-comprehensions (best practices for comprehensions)
"T10", # flake8-debugger (prevent debugger statements in code)
"EM", # flake8-errormessages (best practices for error messages)
#"EM", # flake8-errormessages (best practices for error messages)
"FA", # flake8-future-annotations (correct usage future annotations)
"ISC", # flake8-implicit-str-concat (prevent implicit string concat)
"ICN", # flake8-import-conventions (enforce import conventions)
"G", # flake8-logging-format (best practices for logging)
#"G", # flake8-logging-format (best practices for logging)
"INP", # flake8-no-pep420 (prevent use of PEP420, i.e. implicit name spaces)
"PIE", # flake8-pie (misc suggested improvement linting)
#"PIE", # flake8-pie (misc suggested improvement linting)
# "T20", # flake8-print (prevent print statements in code)
"PT", # flake8-pytest-style (best practices for pytest)
"Q", # flake8-quotes (best practices for quotes)
#"PT", # flake8-pytest-style (best practices for pytest)
#"Q", # flake8-quotes (best practices for quotes)
"RSE", # flake8-raise (best practices for raising exceptions)
"RET", # flake8-return (best practices for return statements)
"SLF", # flake8-self (prevent private member access)
#"RET", # flake8-return (best practices for return statements)
#"SLF", # flake8-self (prevent private member access)
"SLOT", # flake8-slots (require __slots__ for immutable classes)
"SIM", # flake8-simplify (suggest simplifications to code where possible)
#"SIM", # flake8-simplify (suggest simplifications to code where possible)
"TID", # flake8-tidy-imports (prevent banned api and best import practices)
"TCH", # flake8-type-checking (move type checking imports into type checking blocks)
"INT", # flake8-gettext (when to use printf style strings)
# "ARG", # flake8-unused-arguments (prevent unused arguments)
"PTH", # flake8-use-pathlib (prefer pathlib over os.path)
#"PTH", # flake8-use-pathlib (prefer pathlib over os.path)
# "ERA", # eradicate (remove commented out code)
"PGH", # pygrep (simple grep checks)
"PL", # pylint (general linting, flake8 alternative)
"TRY", # tryceratops (linting for try/except blocks)
#"PL", # pylint (general linting, flake8 alternative)
#"TRY", # tryceratops (linting for try/except blocks)
"FLY", # flynt (f-string conversion where possible)
"NPY", # NumPy-specific checks (recommendations from NumPy)
"PERF", # Perflint (performance linting)
#"NPY", # NumPy-specific checks (recommendations from NumPy)
#"PERF", # Perflint (performance linting)
"LOG",
"RUF", # ruff specific checks
#"RUF", # ruff specific checks
]
ignore = [
"ISC001", # interferes with formatter
Expand Down Expand Up @@ -236,14 +236,6 @@ line_length = 110
[tool.codespell]
skip = "*.pdf,*.fits,*.asdf,.tox,build,./tags,.git,docs/_build"

[tool.repo-review]
ignore = [
"GH200", # Use dependabot
"PC140", # add MyPy to pre-commit
"PC901", # custom pre-comit.ci message
"MY100", # Use MyPy
]

[tool.cibuildwheel.macos]
archs = [
"x86_64",
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ deps =
pre-commit
commands =
pre-commit install-hooks
pre-commit run {posargs:--color always --all-files --show-diff-on-failure}
pre-commit run --color always --all-files --show-diff-on-failure {posargs}

[testenv:check-build]
description = check build sdist/wheel and a strict twine check for metadata
Expand Down

0 comments on commit 787aa81

Please sign in to comment.