From b8c6c1530ef937521b60aabb0ecd98a8b5dca761 Mon Sep 17 00:00:00 2001
From: Dimitri Papadopoulos Orfanos
 <3234522+DimitriPapadopoulos@users.noreply.github.com>
Date: Sat, 23 Dec 2023 00:25:02 +0100
Subject: [PATCH] Use the ruff formatter (jaraco/skeleton#99)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Use the ruff formatter, instead of black

Based on:
- ruff-pre-commit README.md | Using Ruff with pre-commit
  https://github.com/astral-sh/ruff-pre-commit/blob/main/README.md
- The Ruff Formatter | Conflicting lint rules
  https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules

Support for the ruff formatter was added to pytest-ruff by commits from
October 2023, released the same day as versions 0.2 and 0.2.1. Hence, it
makes sense to require pytest-ruff ≥ 0.2.1 now.

Support for `quote-style = "preserve"` was added to ruff in the last
couple of weeks, therefore require the latest version, ruff ≥ 0.1.8.
This option is equivalent to `skip-string-normalization` in black.

Closes jaraco/skeleton#101.

---------

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
---
 .pre-commit-config.yaml |  7 ++++---
 README.rst              |  4 ----
 pyproject.toml          |  3 ---
 pytest.ini              |  8 --------
 ruff.toml               | 22 ++++++++++++++++++++++
 setup.cfg               |  5 +----
 6 files changed, 27 insertions(+), 22 deletions(-)
 create mode 100644 ruff.toml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index af50201..5a4a7e9 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,5 +1,6 @@
 repos:
-- repo: https://github.com/psf/black
-  rev: 22.6.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.1.8
   hooks:
-  - id: black
+  - id: ruff
+  - id: ruff-format
diff --git a/README.rst b/README.rst
index 41bcfbe..2fabcf3 100644
--- a/README.rst
+++ b/README.rst
@@ -11,10 +11,6 @@
     :target: https://github.com/astral-sh/ruff
     :alt: Ruff
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/psf/black
-   :alt: Code style: Black
-
 .. .. image:: https://readthedocs.org/projects/PROJECT_RTD/badge/?version=latest
 ..    :target: https://PROJECT_RTD.readthedocs.io/en/latest/?badge=latest
 
diff --git a/pyproject.toml b/pyproject.toml
index dce944d..a853c57 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -2,7 +2,4 @@
 requires = ["setuptools>=56", "setuptools_scm[toml]>=3.4.1"]
 build-backend = "setuptools.build_meta"
 
-[tool.black]
-skip-string-normalization = true
-
 [tool.setuptools_scm]
diff --git a/pytest.ini b/pytest.ini
index f9533b5..022a723 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -7,14 +7,6 @@ filterwarnings=
 	# Ensure ResourceWarnings are emitted
 	default::ResourceWarning
 
-	# shopkeep/pytest-black#55
-	ignore:<class 'pytest_black.BlackItem'> is not using a cooperative constructor:pytest.PytestDeprecationWarning
-	ignore:The \(fspath. py.path.local\) argument to BlackItem is deprecated.:pytest.PytestDeprecationWarning
-	ignore:BlackItem is an Item subclass and should not be a collector:pytest.PytestWarning
-
-	# shopkeep/pytest-black#67
-	ignore:'encoding' argument not specified::pytest_black
-
 	# realpython/pytest-mypy#152
 	ignore:'encoding' argument not specified::pytest_mypy
 
diff --git a/ruff.toml b/ruff.toml
new file mode 100644
index 0000000..7ed133b
--- /dev/null
+++ b/ruff.toml
@@ -0,0 +1,22 @@
+[lint]
+extend-ignore = [
+	# https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+	"W191",
+	"E111",
+	"E114",
+	"E117",
+	"D206",
+	"D300",
+	"Q000",
+	"Q001",
+	"Q002",
+	"Q003",
+	"COM812",
+	"COM819",
+	"ISC001",
+	"ISC002",
+]
+
+[format]
+# https://docs.astral.sh/ruff/settings/#format-quote-style
+quote-style = "preserve"
diff --git a/setup.cfg b/setup.cfg
index 20c5dd7..1d2729b 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -30,15 +30,12 @@ testing =
 	# upstream
 	pytest >= 6
 	pytest-checkdocs >= 2.4
-	pytest-black >= 0.3.7; \
-		# workaround for jaraco/skeleton#22
-		python_implementation != "PyPy"
 	pytest-cov
 	pytest-mypy; \
 		# workaround for jaraco/skeleton#22
 		python_implementation != "PyPy"
 	pytest-enabler >= 2.2
-	pytest-ruff
+	pytest-ruff >= 0.2.1
 
 	# local