feat: Sync latest project configuration

- Use Ruff for linting and formatting - Default documentation directory is 'doc'
atsphinx · Mar 23, 2024 · e44099f · e44099f
1 parent f7f658c
commit e44099f
Show file tree

Hide file tree

Showing 14 changed files with 29 additions and 34 deletions.
diff --git a/{{cookiecutter.project_basename}}/.pre-commit-config.yaml b/{{cookiecutter.project_basename}}/.pre-commit-config.yaml
@@ -1,25 +1,15 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-      - id: black
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.0
+    hooks:
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/PyCQA/doc8
     rev: v1.0.0
     hooks:
       - id: doc8
         args:
-          - '--max-line-length=119'
-  - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
-    hooks:
-      - id: flake8
-        args:
-          - '--max-line-length=88'
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/PyCQA/pydocstyle
-    rev: 6.1.1
-    hooks:
-      - id: pydocstyle
+          - --max-line-length=119
diff --git a/{{cookiecutter.project_basename}}/doc/.ruff.toml b/{{cookiecutter.project_basename}}/doc/.ruff.toml
@@ -0,0 +1,4 @@
+extend = "../pyproject.toml"
+
+[lint]
+ignore = ["D100", "D103"]
diff --git a/...iecutter.project_basename}}/docs/Makefile → ...kiecutter.project_basename}}/doc/Makefile b/...iecutter.project_basename}}/docs/Makefile → ...kiecutter.project_basename}}/doc/Makefile
diff --git a/...roject_basename}}/docs/_static/.gitignore → ...project_basename}}/doc/_static/.gitignore b/...roject_basename}}/docs/_static/.gitignore → ...project_basename}}/doc/_static/.gitignore
diff --git a/...ect_basename}}/docs/_templates/.gitignore → ...ject_basename}}/doc/_templates/.gitignore b/...ect_basename}}/docs/_templates/.gitignore → ...ject_basename}}/doc/_templates/.gitignore
diff --git a/...kiecutter.project_basename}}/docs/conf.py → ...okiecutter.project_basename}}/doc/conf.py b/...kiecutter.project_basename}}/docs/conf.py → ...okiecutter.project_basename}}/doc/conf.py
@@ -1,4 +1,3 @@
-# noqa: D100
 from {{ cookiecutter.package_fullname }} import __version__ as version
 
 # -- Project information

diff --git a/...ecutter.project_basename}}/docs/index.rst → ...iecutter.project_basename}}/doc/index.rst b/...ecutter.project_basename}}/docs/index.rst → ...iecutter.project_basename}}/doc/index.rst
diff --git a/...iecutter.project_basename}}/docs/make.bat → ...kiecutter.project_basename}}/doc/make.bat b/...iecutter.project_basename}}/docs/make.bat → ...kiecutter.project_basename}}/doc/make.bat
diff --git a/{{cookiecutter.project_basename}}/pyproject.toml b/{{cookiecutter.project_basename}}/pyproject.toml
@@ -46,7 +46,13 @@ dev-dependencies = [
 setup = {chain = ["setup:sync", "setup:pre-commit"]}
 "setup:sync" = "rye sync --no-lock --all-features"
 "setup:pre-commit" = "pre-commit install"
-doc = "make -C docs"
+doc = "make -C doc"
+
+[tool.ruff.lint]
+select = ["C90", "D", "E", "F", "I", "W"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
 
 [tool.hatch.metadata]
 allow-direct-references = true

diff --git a/{{cookiecutter.project_basename}}/setup.cfg b/{{cookiecutter.project_basename}}/setup.cfg
diff --git a/{{cookiecutter.project_basename}}/src/atsphinx/{{cookiecutter.package_basename}}.py b/{{cookiecutter.project_basename}}/src/atsphinx/{{cookiecutter.package_basename}}.py
@@ -1,4 +1,5 @@
-"""{{ cookiecutter.description }}"""
+"""{{ cookiecutter.description }}."""
+
 from sphinx.application import Sphinx
 
 __version__ = "{{ cookiecutter.version }}"

diff --git a/{{cookiecutter.project_basename}}/tests/.ruff.toml b/{{cookiecutter.project_basename}}/tests/.ruff.toml
@@ -0,0 +1,4 @@
+extend = "../pyproject.toml"
+
+[lint]
+ignore = ["D100", "D103"]
diff --git a/{{cookiecutter.project_basename}}/tests/conftest.py b/{{cookiecutter.project_basename}}/tests/conftest.py
@@ -1,4 +1,5 @@
 """Configuration for pytest."""
+
 import pytest
 from sphinx.testing.path import path
 

diff --git a/{{cookiecutter.project_basename}}/tests/test_it.py b/{{cookiecutter.project_basename}}/tests/test_it.py
@@ -1,4 +1,5 @@
 """Standard tests."""
+
 from io import StringIO
 
 import pytest
@@ -8,3 +9,4 @@
 @pytest.mark.sphinx("html")
 def test__it(app: SphinxTestApp, status: StringIO, warning: StringIO):
     """Test to pass."""
+    app.build()