feat: Add more pre commits hooks (#331)

osl-incubator · Dec 30, 2024 · 72f0bf2 · 72f0bf2
1 parent 122be2e
commit 72f0bf2
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 9 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,9 +4,23 @@ default_stages:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-json
+        exclude: "src/scicookie/{{cookiecutter.project_slug}}.*"
+      - id: check-toml
+        exclude: "src/scicookie/{{cookiecutter.project_slug}}.*"
+      - id: check-xml
+      - id: debug-statements
+        exclude: "src/scicookie/{{cookiecutter.project_slug}}.*|src/scicookie/hooks/.*"
+      - id: check-builtin-literals
+        exclude: "src/scicookie/{{cookiecutter.project_slug}}.*|src/scicookie/hooks/.*"
+      - id: check-case-conflict
+      - id: check-docstring-first
+        exclude: "src/scicookie/{{cookiecutter.project_slug}}.*"
+      - id: detect-private-key
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.0.2"

diff --git a/src/scicookie/hooks/post_gen_project.py b/src/scicookie/hooks/post_gen_project.py
@@ -137,7 +137,7 @@ def move_selected_doc_dir():
     if DOCUMENTATION_ENGINE.startswith("sphinx"):
         DOCS_SPHINX = Path(DOCS_SPEC_DIR).parent
         remove_project_file(Path("docs") / "index.md")
-        
+
         for file_name in ['conf.py', 'make.bat', 'readme.md']:
             try:
                 shutil.move(DOCS_SPHINX / file_name, docs_target_dir)
@@ -167,7 +167,7 @@ def clean_up_automation():
 def clean_up_docs():
     move_selected_doc_dir()
     remove_dirs(ALL_DOCS_DIRS)
-    
+
 
 def clean_up_project_layout():
     if USE_SRC_LAYOUT:

diff --git a/src/scicookie/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/src/scicookie/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
@@ -7,9 +7,18 @@ default_stages:
   - pre-commit
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: detect-private-key
 {# keep this comment #}
 {%- if cookiecutter.use_prettier == "yes" %}
   - repo: https://github.com/pre-commit/mirrors-prettier

diff --git a/src/scicookie/{{cookiecutter.project_slug}}/build-system/base/dev-deps-pyproject.toml b/src/scicookie/{{cookiecutter.project_slug}}/build-system/base/dev-deps-pyproject.toml
@@ -97,7 +97,7 @@ dev = [
 {%- elif cookiecutter.documentation_engine == 'quarto' %}
   "quarto-cli >= 1.5.56",
   "quartodoc >= 0.7.5",
-{%- endif %}
+{%- endif -%}
   # 'PosixPath' object has no attribute 'endswith'
   "virtualenv<=20.25.1",
 ]
diff --git a/src/scicookie/{{cookiecutter.project_slug}}/docs-mkdocs/mkdocs.yaml b/src/scicookie/{{cookiecutter.project_slug}}/docs-mkdocs/mkdocs.yaml
@@ -110,7 +110,7 @@ markdown_extensions:
           - docs/static/icons
   - pymdownx.details
   - pymdownx.highlight:
-      pygments_lang_class: true 
+      pygments_lang_class: true
   - pymdownx.inlinehilite:
       style_plain_text: python
   - pymdownx.magiclink:

diff --git a/src/scicookie/{{cookiecutter.project_slug}}/docs-sphinx/myst/api/references.md b/src/scicookie/{{cookiecutter.project_slug}}/docs-sphinx/myst/api/references.md
@@ -11,5 +11,5 @@
 ```{admonition} API documentation with sphinx-autodoc2
 :class: important
 
-You can also build the API documentation using [sphinx-autodoc2 extension](https://sphinx-autodoc2.readthedocs.io/en/latest/). 
+You can also build the API documentation using [sphinx-autodoc2 extension](https://sphinx-autodoc2.readthedocs.io/en/latest/).
 ```
diff --git a/src/scicookie/{{cookiecutter.project_slug}}/docs-sphinx/rst/index.rst b/src/scicookie/{{cookiecutter.project_slug}}/docs-sphinx/rst/index.rst
@@ -13,7 +13,7 @@ Welcome to {{ cookiecutter.project_name }}'s documentation!
    Example <example>
    contributing
    changelog
-   
+
 
 Indices and tables
 ==================

diff --git a/tests/smoke/base.sh b/tests/smoke/base.sh
@@ -30,7 +30,7 @@ export PATH=$(echo $PATH| sed -E "s/[^:]+\/scicookie\/[^:]+//g")
 
 BUILD_SYSTEM="others"
 
-COMMAND_PREFIX= 
+COMMAND_PREFIX=
 if command -v poetry &> /dev/null; then
   poetry install
 elif command -v flit &> /dev/null; then