Commit 15e593d8 authored by Dom Sekotill's avatar Dom Sekotill
Browse files

Switch flake8 to flakeheaven

parent 7053aff0
Loading
Loading
Loading
Loading
+0 −93
Original line number Diff line number Diff line
@@ -6,96 +6,3 @@ strict = true
warn_unused_configs = true
warn_unreachable = true
mypy_path = tests

[flake8]
max-line-length = 92
max-doc-length = 92
use-flake8-tabs = true
blank-lines-indent = never
indent-tabs-def = 1
format = pylint
select = C,D,E,ET,F,SFS,T,W,WT

per-file-ignores =
  **/__init__.py: D104
  **/__main__.py: D100, E702

ignore =
  ;[ '%s' imported but unused ]
  ; Handled by pylint, which does it better
  F401

  ;[ Missing docstring in public method ]
  ; Handled by pylint, which does it better
  D102

  ;[ Missing docstring in magic method ]
  ; Magic/dunder methods are well-known
  D105

  ;[ Misisng docstring in __init__ ]
  ; Document basic construction in the class docstring
  D107

  ;[ One-line docstring should fit on one line with quotes ]
  ; Prefer top-and-bottom style always
  D200

  ;[ Docstring should be indented with spaces, not tabs ]
  ; Tabs, absolutely always
  D206

  ;[ Use r""" if any backslashes in a docstring ]
  ; If I want to put escape chars in a docstring, I will
  D301

  ;[ Use u""" for Unicode docstrings ]
  ; This must be for Python 2?
  D302

  ;[ First line should end with a period ]
  ; First line should *NEVER* end with a period
  D400

  ;[ First line should be in the imperative mood ]
  ; I like this for functions and methods, not for properties. This stands until
  ; pydocstyle splits a new code for properties or flake8 adds some way of
  ; filtering codes with line regexes like golangci-lint.
  D401

  ;[ No blank lines allowed between a section header and its content ]
  D412

  ;[ missing whitespace around bitwise or shift operator ]
  E227

  ;[ Line too long ]
  ; Prefer B950 implementation
  E501

  ;[ multiple statements on one line (def) ]
  ; Dosen't work well with short @overload definitions
  E704

  ;[ unexpected number of tabs and spaces at start of statement ]
  ET128

  ;[ Line break before binary operator ]
  ; Not considered current
  W503

  ;[ Format-method string formatting ]
  ; Allow this style
  SFS201

  ;[ f-string string formatting ]
  ; Allow this style
  SFS301

include =
  ;[ First word of the docstring should not be This ]
  D404

  ; flake8-bugbear plugin
  ; B950 is a replacement for E501
  B0 B903 B950
+3 −4
Original line number Diff line number Diff line
@@ -75,16 +75,15 @@ repos:
    types_or: [python, pyi]
    stages: [commit, manual]

- repo: https://gitlab.com/pycqa/flake8
  rev: 3.8.4
- repo: https://github.com/flakeheaven/flakeheaven
  rev: 1.0.1
  hooks:
  - id: flake8
  - id: flakeheaven
    args: ["--config=.lint.cfg"]
    additional_dependencies:
    - flake8-bugbear
    - flake8-docstrings
    - flake8-print
    - flake8-requirements
    - flake8-return
    - flake8-sfs
    - flake8-tabs

pyproject.toml

0 → 100644
+16 −0
Original line number Diff line number Diff line
[tool.flakeheaven]
base = "https://code.kodo.org.uk/dom/project-templates/-/raw/main/.flakerules.toml"
max_line_length = 92
max_doc_length = 92

[tool.flakeheaven.plugins]
pycodestyle = ["-E701", "-E226"]

[tool.flakeheaven.exceptions."tests/"]
flake8-docstrings = ["-D100"]

[tool.flakeheaven.exceptions."README.md"]
flake8-docstrings = ["-*"]

[tool.flakeheaven.exceptions."doc/*"]
flake8-docstrings = ["-*"]