Merge pull request #3 from pybamm-team/pre-commit-hooks

Add `pre-commit` hooks

Author: agriyakhetarpal

.gitignore

@@ -122,4 +122,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+
+repos:
+
+  # Standard and general-purpose hooks
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: mixed-line-ending
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+      - id: codespell
+
+  - repo: local
+    hooks:
+      - id: disallow-caps
+        name: Disallow improper capitalization
+        language: pygrep
+        entry: Numpy|Scipy|Cmake|Github|Pybamm
+        exclude: .pre-commit-config.yaml
+
+  # Python files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.281
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+
+  # Documentation files
+
+  - repo: https://github.com/asottile/blacken-docs
+    rev: "1.15.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.7.0]
+
+  - 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
+
+  # Jupyter notebooks
+
+  - repo: https://github.com/nbQA-dev/nbQA
+    rev: "1.7.0"
+    hooks:
+      - id: nbqa-ruff
+        additional_dependencies: [ruff==0.0.281]