BEHAVIOR: remove flake8, isort, pydocstyle, and pylint (#145)

* DX: recommend unwanted recommendations extension
* DX: remove `flake8` linter
* DX: remove `isort` formatter
* DX: remove `pydocstyle` linting
* DX: remove `pylint` as linter
* DX: uninstall `pep8-naming` plugin for `flake8`
* ENH: run pre-commit check after other checks
* MAINT: add more unwanted extensions
* MAINT: remove `pylint` ignore comments
* MAINT: remove `noqa: F401` statement from notebooks
  Can be ignored through Ruff config

.cspell.json

@@ -24,14 +24,11 @@
     "*particle*.*ml",
     ".constraints/*.txt",
     ".editorconfig",
-    ".flake8*",
     ".gitignore",
     ".gitpod.*",
     ".mypy.ini",
     ".pre-commit-config.yaml",
     ".prettierignore",
-    ".pydocstyle*",
-    ".pylintrc",
     ".readthedocs.yml",
     ".vscode/*",
     ".vscode/.gitignore",
@@ -81,7 +78,6 @@
     "conda",
     "fromdict",
     "indentless",
-    "isort",
     "linkcheck",
     "maxsplit",
     "nargs",
@@ -97,8 +93,6 @@
     "prereleased",
     "prettierignore",
     "prettierrc",
-    "pydocstyle",
-    "pylint",
     "pyright",
     "pyupgrade",
     "redeboer",

.gitpod.yml

@@ -19,11 +19,9 @@ vscode:
     - eamodio.gitlens
     - editorconfig.editorconfig
     - esbenp.prettier-vscode
+    - garaioag.garaio-vscode-unwanted-recommendations
     - github.vscode-github-actions
     - github.vscode-pull-request-github
-    - ms-python.flake8
-    - ms-python.isort
-    - ms-python.pylint
     - ms-python.python
     - ms-python.vscode-pylance
     - ms-vsliveshare.vsliveshare

.pre-commit-config.yaml

@@ -3,10 +3,8 @@ ci:
   autoupdate_schedule: quarterly
   skip:
     - check-dev-files
-    - flake8
     - format-setup-cfg
     - mypy
-    - pylint
     - pyright
     - repoma-self-check
     - taplo
@@ -62,11 +60,6 @@ repos:
         language: python
         files: ^\.pre\-commit\-(config|hooks)\.yaml$
 
-  - repo: https://github.com/PyCQA/autoflake
-    rev: v2.1.1
-    hooks:
-      - id: autoflake
-
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
@@ -93,20 +86,6 @@ repos:
             .*\.py
           )$
 
-  - repo: local
-    hooks:
-      - id: flake8
-        name: flake8
-        entry: flake8
-        language: system
-        types:
-          - python
-
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.34.0
     hooks:
@@ -127,24 +106,6 @@ repos:
     hooks:
       - id: prettier
 
-  - repo: https://github.com/pycqa/pydocstyle
-    rev: 6.3.0
-    hooks:
-      - id: pydocstyle
-
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        args:
-          - --rcfile=.pylintrc
-          - --score=no
-        language: system
-        require_serial: true
-        types:
-          - python
-
   - repo: https://github.com/ComPWA/mirrors-pyright
     rev: v1.1.307
     hooks:

.vscode/extensions.json

@@ -6,11 +6,9 @@
     "eamodio.gitlens",
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
+    "garaioag.garaio-vscode-unwanted-recommendations",
     "github.vscode-github-actions",
     "github.vscode-pull-request-github",
-    "ms-python.flake8",
-    "ms-python.isort",
-    "ms-python.pylint",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "ms-vsliveshare.vsliveshare",
@@ -21,5 +19,12 @@
     "tamasfe.even-better-toml",
     "tyriar.sort-lines",
     "yzhang.markdown-all-in-one"
+  ],
+  "unwantedRecommendations": [
+    "bungcip.better-toml",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "ms-python.pylint",
+    "travisillig.vscode-json-stable-stringify"
   ]
 }

.vscode/settings.json

@@ -36,12 +36,8 @@
     "**/.git/**": true,
     "**/.tox/**": true
   },
-  "flake8.importStrategy": "fromEnvironment",
   "git.rebaseWhenSync": true,
   "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],
-  "isort.check": true,
-  "isort.importStrategy": "fromEnvironment",
-  "pylint.importStrategy": "fromEnvironment",
   "python.analysis.autoImportCompletions": false,
   "python.analysis.diagnosticMode": "workspace",
   "python.analysis.inlayHints.pytestParameters": true,
@@ -51,7 +47,7 @@
   "python.linting.enabled": true,
   "python.linting.flake8Enabled": false,
   "python.linting.mypyEnabled": true,
-  "python.linting.pydocstyleEnabled": true,
+  "python.linting.pydocstyleEnabled": false,
   "python.linting.pylamaEnabled": false,
   "python.linting.pylintEnabled": false,
   "python.testing.pytestArgs": ["--color=no", "--no-cov", "-vv"],
@@ -62,7 +58,6 @@
   "ruff.organizeImports": true,
   "search.exclude": {
     "**/tests/**/__init__.py": true,
-    "*/.pydocstyle": true,
     ".constraints/*.txt": true,
     ".github/workflows/cd.yml": true,
     ".github/workflows/ci.yml": true,

README.md

@@ -7,7 +7,6 @@
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/repo-maintenance/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/repo-maintenance/main)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 This repository is to standardize the developer environment of Python packages by the

pyproject.toml

@@ -33,13 +33,6 @@ target-version = [
     "py39",
 ]
 
-[tool.isort]
-profile = "black"
-src_paths = [
-    "src",
-    "tests",
-]
-
 [tool.ruff]
 extend-select = [
     "A",
@@ -72,10 +65,6 @@ extend-select = [
     "UP",
     "YTT",
 ]
-external = [
-    "D100",
-    "R701",
-]
 ignore = [
     "D101",    # class docstring
     "D102",    # method docstring

setup.cfg

@@ -48,29 +48,13 @@ test =
     pytest-xdist
 format =
     black
-    isort
-flake8 =
-    flake8 >=4  # extend-select
-    flake8-blind-except
-    flake8-bugbear
-    flake8-builtins
-    flake8-comprehensions
-    flake8-future-import
-    flake8-pytest-style
-    flake8-rst-docstrings
-    flake8-type-ignore; python_version >="3.8.0"
-    flake8-use-fstring
-    pep8-naming
 mypy =
     mypy
     types-PyYAML
     types-setuptools
     types-toml
 lint =
-    %(flake8)s
     %(mypy)s
-    pydocstyle
-    pylint >=2.5  # good-names-rgxs
     radon
     ruff
 sty =

setup.py

@@ -1,4 +1,3 @@
-# noqa: D100
 from setuptools import setup
 
 setup(

src/repoma/check_dev_files/__init__.py

@@ -4,14 +4,14 @@
 import sys
 from typing import List, Optional, Sequence
 
+from repoma.check_dev_files.deprecated import remove_deprecated_tools
 from repoma.utilities.executor import Executor
 
 from . import (
     black,
     commitlint,
     cspell,
     editorconfig,
-    flake8,
     github_labels,
     github_templates,
     github_workflows,
@@ -162,11 +162,9 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
     )
     executor(nbstripout.main)
     executor(toml.main)  # has to run before pre-commit
-    executor(precommit.main)
     executor(prettier.main, args.no_prettierrc)
     if is_python_repo:
         executor(black.main)
-        executor(flake8.main)
         executor(release_drafter.main, args.repo_name, args.repo_title)
         if args.pin_requirements != "no":
             executor(
@@ -177,6 +175,8 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
         executor(ruff.main)
         executor(setup_cfg.main, args.ignore_author)
         executor(tox.main)
+    executor(precommit.main)
+    executor(remove_deprecated_tools)
     executor(vscode.main)
     if not args.no_gitpod:
         executor(gitpod.main)

src/repoma/check_dev_files/cspell.py

@@ -24,7 +24,6 @@
 __VSCODE_EXTENSION_NAME = "streetsidesoftware.code-spell-checker"
 
 # cspell:ignore pelling
-# pylint: disable=line-too-long
 # fmt: off
 __BADGE = (
     "[![Spelling"