Merge pull request #10348 from mhilbrunner/pre-commit

CI: Integrate pre-commit for style checks

.github/workflows/ci.yml

@@ -15,19 +15,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Install dependencies
-        run: |
-          # Install tools used by `_tools/format.sh`.
-          sudo apt-get -qq update
-          sudo apt-get -qq install dos2unix recode
-          sudo pip3 install -r requirements.txt
-          sudo pip3 install codespell
-
-      - name: Linter checks
-        run: |
-          bash _tools/format.sh
+      - name: Style checks via pre-commit
+        uses: pre-commit/[email protected]
 
-          codespell -D- -D _tools/codespell-dict.txt -I _tools/codespell-ignore.txt -x _tools/codespell-ignore-lines.txt -S tutorials/i18n/locales.rst {about,community,contributing,getting_started,tutorials}/{*.rst,**/*.rst,**/**/*.rst,**/**/**/*.rst}
+      - name: Install dependencies
+        run: sudo pip3 install -r requirements.txt
 
       # Use dummy builder to improve performance as we don't need the generated HTML in this workflow.
       - name: Sphinx build

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        files: ^(about|community|contributing|getting_started|tutorials)/.*\.rst$
+        additional_dependencies: [tomli]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: ['--fix=lf']

pyproject.toml

@@ -0,0 +1,8 @@
+[tool.ruff]
+line-length = 120
+
+[tool.codespell]
+dictionary = ["_tools/codespell-dict.txt", "-"]
+ignore-words = "_tools/codespell-ignore.txt"
+exclude-file = "_tools/codespell-ignore-lines.txt"
+skip = "tutorials/i18n/locales.rst"