ci: update pre-commit config (#113)

Jo-Byr · web-flow · commit e3169d8c3799 · 2026-05-11T08:50:44.000-06:00
Update pre-commit config from trame cookiecutter
diff --git a/.codecov.yml b/.codecov.yml
@@ -2,4 +2,4 @@ comment: false
 coverage:
   status:
     project: off
-    patch: off
+    patch: off
diff --git a/.coveragerc b/.coveragerc
@@ -1,2 +1,2 @@
 [run]
-omit = *docs*, *tests*, setup.py
+omit = *docs*, *tests*, setup.py
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,11 +1,81 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+
+exclude: ^.cruft.json|.copier-answers.yml$|.*\.md|LICENSE|static_viewer.html|serve
+
 repos:
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
     hooks:
-      - id: codespell
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: "v3.8.1"
+    hooks:
+      - id: prettier
+        types_or: [yaml, markdown, html, css, scss, javascript, json]
+        args: [--prose-wrap=always]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.4
+    rev: "v0.15.0"
     hooks:
       - id: ruff
-      - id: ruff-format
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.4.1"
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: "v0.11.0.1"
+    hooks:
+      - id: shellcheck
+
+  - repo: local
+    hooks:
+      - id: disallow-caps
+        name: Disallow improper capitalization
+        language: pygrep
+        entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
+        exclude: .pre-commit-config.yaml
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: "v0.25"
+    hooks:
+      - id: validate-pyproject
+        additional_dependencies: ["validate-pyproject-schema-store[all]"]
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: "0.36.1"
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-readthedocs
+
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.24.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
+        additional_dependencies: ["@commitlint/config-conventional"]
diff --git a/README.rst b/README.rst
@@ -118,10 +118,10 @@ VtkLocalView
 The VtkLocalView component relies on the server for defining the vtkRenderWindow but then only the geometry is exchanged with the client.
 The server does not need a GPU as no rendering is happening on the server.
 The vtkRenderWindow is only used to retrieve the scene data and parameters (coloring by, representations, ...).
-By relying on the same vtkRenderWindow, you can easily switch from a `VtkRemoteView` to a `VtkLocalView` or vice-versa.
+By relying on the same vtkRenderWindow, you can easily switch from a ``VtkRemoteView`` to a ``VtkLocalView`` or vice-versa.
 This component gives you controls on how you want to map mouse interaction with the camera.
-The default setting mimic default VTK interactor style so you will rarely have to override to the `interactor_settings`.
-The VtkLocalView supports WebXR thanks to the `VtkWebXRHelper` component. Please refer to the examples for details on how to use it.
+The default setting mimic default VTK interactor style so you will rarely have to override to the ``interactor_settings``.
+The VtkLocalView supports WebXR thanks to the ``VtkWebXRHelper`` component. Please refer to the examples for details on how to use it.
 
 How to use it?
 ```````````````````````````````````````````````````````````
@@ -157,7 +157,7 @@ The component also provides a convenient method to push the scene to the client
 Interactor Settings
 ```````````````````````````````````````````````````````````
 
-For the `interactor_settings` we expect a list of mouse event type linked to an action. The example below is what is used as default:
+For the ``interactor_settings`` we expect a list of mouse event type linked to an action. The example below is what is used as default:
 
 .. code-block:: javascript
 
@@ -247,8 +247,8 @@ Examples
 VtkRemoteLocalView
 -----------------------------------------------------------
 
-The VtkRemoteLocalView component is a blend of `VtkLocalView` and `VtkRemoteView` where the user can choose dynamically which mode they want to be in.
-When instantiating a `VtkRemoteLocalView` several variables and triggers will be created for you to more easily control your view.
+The VtkRemoteLocalView component is a blend of ``VtkLocalView`` and ``VtkRemoteView`` where the user can choose dynamically which mode they want to be in.
+When instantiating a ``VtkRemoteLocalView`` several variables and triggers will be created for you to more easily control your view.
 
 How to use it?
 ```````````````````````````````````````````````````````````
@@ -279,7 +279,7 @@ How to use it?
 Namespace parameter
 ```````````````````````````````````````````````````````````
 
-Constructing a VtkRemoteLocalView will set several variables, prefixed by a namespace. In the example below we used `namespace="view"`.
+Constructing a VtkRemoteLocalView will set several variables, prefixed by a namespace. In the example below we used ``namespace="view"``.
 
 .. list-table::
    :widths: 25 75
@@ -307,12 +307,12 @@ Constructing a VtkRemoteLocalView will also set several trame triggers.
    * - viewAnimateStop
      - Stop the animation loop
 
-The `namespace` will also be used as `ref=` unless provided by the user.
+The ``namespace`` will also be used as ``ref=`` unless provided by the user.
 
 Mode parameter
 ```````````````````````````````````````````````````````````
 
-The mode is driven by the variable `{namespace}Mode` but can be provided when instantiated so the default can be overridden and a JavaScript expression can be used instead of the default variable. This attribute behaves the same way as any trame one except, we won't register the left side as a state entry since we already have one under `{namespace}Mode`. This means we will evaluate the left side of the expression assuming a tuple is provided and the right side of the tuple is used to set its initial value.
+The mode is driven by the variable ``{namespace}Mode`` but can be provided when instantiated so the default can be overridden and a JavaScript expression can be used instead of the default variable. This attribute behaves the same way as any trame one except, we won't register the left side as a state entry since we already have one under ``{namespace}Mode``. This means we will evaluate the left side of the expression assuming a tuple is provided and the right side of the tuple is used to set its initial value.
 
 Examples
 ```````````````````````````````````````````````````````````
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,7 +46,7 @@ build_command = """
   python -m build .
 """
 
-[semantic_release.publish]
+[tool.semantic_release.publish]
 dist_glob_patterns = ["dist/*"]
 upload_to_vcs_release = true
 
@@ -76,5 +76,5 @@ docstring-code-line-length = "dynamic"
 [tool.ruff.lint.pycodestyle]
 max-line-length = 120
 
-[lint.pydocstyle]
+[tool.lint.pydocstyle]
 convention = "google"
diff --git a/src/trame_vtk/modules/vtk/serializers/mesh.py b/src/trame_vtk/modules/vtk/serializers/mesh.py
@@ -146,7 +146,7 @@ def volume(dataset):
     return state
 
 
-# Numpy to JS TypedArray
+# numpy to JS TypedArray
 to_js_type = {
     "int8": "Int8Array",
     "uint8": "Uint8Array",
diff --git a/tests/refs/test_rendering_int64.yml b/tests/refs/test_rendering_int64.yml
@@ -1,6 +1,6 @@
 - document:
-  - banner:
-    - button
-    - text: Int64 Validation 1
-  - main:
-    - img
+    - banner:
+        - button
+        - text: Int64 Validation 1
+    - main:
+        - img
diff --git a/tests/refs/test_rendering_lut.yml b/tests/refs/test_rendering_lut.yml
@@ -1,6 +1,6 @@
 - document:
-  - banner:
-    - button
-    - text: PyVista Lookup Table N Colors 1
-  - main:
-    - img
+    - banner:
+        - button
+        - text: PyVista Lookup Table N Colors 1
+    - main:
+        - img
diff --git a/tests/refs/test_rendering_volume.yml b/tests/refs/test_rendering_volume.yml
@@ -1,6 +1,6 @@
 - document:
-  - banner:
-    - button
-    - text: VTK Volume Rendering 1
-  - main:
-    - img
+    - banner:
+        - button
+        - text: VTK Volume Rendering 1
+    - main:
+        - img
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -1,8 +1,8 @@
+coverage
+pytest-asyncio
+pytest-playwright
+pyvista[all]==0.45.2
 trame
 trame-client[test]
 trame-vuetify
 vtk==9.4.2
-pyvista[all]==0.45.2
-pytest-asyncio
-pytest-playwright
-coverage

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`[run]`
`2`		`-omit = docs, tests, setup.py`
	`2`	`+omit = docs, tests, setup.py`