Add linting

.github/workflows/test.yml

@@ -26,9 +26,13 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install -U pytest
           python -m pip install -e .[test]
 
+      - name: Lint
+        run: |
+          ruff format --check sphinxcontrib
+          ruff check sphinxcontrib
+  
       - name: Test
         run: |
           pytest

pyproject.toml

@@ -0,0 +1,20 @@
+[tool.ruff]
+line-length = 150
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+default-section = "third-party"
+known-first-party = ["sphinxcontrib.mermaid"]
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401", "F403"]

setup.py

@@ -58,9 +58,9 @@ def remove_block(text, token, margin=0):
         "Topic :: Utilities",
     ],
     platforms="any",
-    packages=find_namespace_packages(where='./', include=['sphinxcontrib.mermaid']),
-    package_dir={'': './'},
+    packages=find_namespace_packages(where="./", include=["sphinxcontrib.mermaid"]),
+    package_dir={"": "./"},
     include_package_data=True,
     install_requires=["sphinx", "pyyaml"],
-    extras_require={'test': ['myst-parser', 'defusedxml', 'sphinx', 'pytest']},
+    extras_require={"test": ["defusedxml", "myst-parser", "pytest", "ruff", "sphinx"]},
 )