Merge pull request #315 from imagej/add-ruff

Use the `ruff` linter/formatter

Author: ctrueden

.github/workflows/build.yml

@@ -55,18 +55,11 @@ jobs:
       - uses: actions/setup-python@v3
 
       - name: Lint code
-        uses: psf/black@stable
-
-      - name: Flake code
         run: |
-          python -m pip install flake8 Flake8-pyproject flake8-typing-imports
-          python -m flake8 src tests
-
-      - name: Check import ordering
-        uses: isort/isort-action@master
-        with:
-          configuration: --check-only
-
+          python -m pip install ruff
+          ruff check
+          ruff format --check
+        
       - name: Validate pyproject.toml
         run: |
           python -m pip install validate-pyproject[all]

.pre-commit-config.yaml

@@ -1,24 +1,12 @@
 repos:
-  - repo: https://github.com/myint/autoflake
-    rev: v1.4
-    hooks:
-      - id: autoflake
-        args: ["--in-place", "--remove-all-unused-imports"]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - "flake8-typing-imports"
-          - "Flake8-pyproject"
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # ruff version
+    rev: v0.6.2
+    hooks:
+      # run the linter
+      - id: ruff
+      # run the formatter
+      - id: ruff-format
   - repo: https://github.com/abravalheri/validate-pyproject
     rev: v0.10.1
     hooks:

Makefile

@@ -21,6 +21,9 @@ check:
 lint: check
 	bin/lint.sh
 
+fmt: check
+	bin/fmt.sh
+
 test: check
 	bin/test.sh
 

bin/fmt.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+dir=$(dirname "$0")
+cd "$dir/.."
+
+exitCode=0
+ruff check --fix
+code=$?; test $code -eq 0 || exitCode=$code
+ruff format
+code=$?; test $code -eq 0 || exitCode=$code
+exit $exitCode

bin/lint.sh

@@ -4,11 +4,9 @@ dir=$(dirname "$0")
 cd "$dir/.."
 
 exitCode=0
-black src tests
+ruff check
 code=$?; test $code -eq 0 || exitCode=$code
-isort src tests
-code=$?; test $code -eq 0 || exitCode=$code
-python -m flake8 src tests
+ruff format --check
 code=$?; test $code -eq 0 || exitCode=$code
 validate-pyproject pyproject.toml
 code=$?; test $code -eq 0 || exitCode=$code

dev-environment.yml

@@ -39,22 +39,17 @@ dependencies:
   - pooch # for scikit image
   - scikit-image
   # Developer tools
-  - autopep8
-  - black
-  - flake8
-  - flake8-typing-imports
-  - isort
   - myst-nb
   - pre-commit
   - python-build
   - pytest
   - pytest-cov
+  - ruff
   - sphinx
   - sphinx_rtd_theme
   - pip
   - pip:
     - readthedocs-sphinx-search
-    - flake8-pyproject
     - validate-pyproject[all]
     # Project from source
     - -e .

pyproject.toml

@@ -49,17 +49,12 @@ dependencies = [
 # NB: Keep this in sync with dev-environment.yml!
 # Development tools
 dev = [
-    "autopep8",
-    "black",
     "build",
-    "flake8",
-    "flake8-pyproject",
-    "flake8-typing-imports",
-    "isort",
     "myst-nb",
     "pre-commit",
     "pytest",
     "pytest-cov",
+    "ruff",
     "sphinx",
     "sphinx_rtd_theme",
     "validate-pyproject[all]",
@@ -96,20 +91,19 @@ include-package-data = false
 where = ["src"]
 namespaces = false
 
-[tool.black]
-exclude = 'dist|doc'
+# ruff configuration
+[tool.ruff]
+line-length = 88
+src = ["src", "tests"]
+include = ["pyproject.toml", "src/**/*.py", "tests/**/*.py"]
+extend-exclude = ["bin", "build", "dist"]
 
-# Thanks to Flake8-pyproject, we can configure flake8 here!
-[tool.flake8]
-exclude = ["build", "dist", "doc"]
+[tool.ruff.lint]
 extend-ignore = ["E203"]
-# See https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
-max-line-length = 88
-min_python_version = "3.8"
 
-[tool.isort]
-profile = "black"
-skip = ["doc"]
+[tool.ruff.lint.per-file-ignores]
+# Ignore `E402` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
+"__init__.py" = ["E402", "F401"]
 
 [tool.pytest.ini_options]
 addopts = "--ignore=docs"

src/imagej/doctor.py

@@ -14,6 +14,7 @@
     import imagej
     ij = imagej.init()
 """
+
 import importlib
 import logging
 import os