Rewrite it in Rust: Ruff as alternative Linter

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ repos:
           - id: end-of-file-fixer
             exclude: '\.ipynb$'
           - id: check-toml
+            exclude: '{{cookiecutter.repo_name}}/pyproject.toml'
           - id: check-xml
           - id: check-case-conflict
           - id: detect-aws-credentials

cookiecutter.json

@@ -5,5 +5,6 @@
     "repo_url": "URL to repository",
     "env_name": "{{ cookiecutter.project_name.lower().replace(' ', '-') + '-env' }}",
     "install_jupyter": ["yes", "no"],
+    "linter_name": ["pylint", "ruff"],
     "cicd_configuration": ["none", "gitlab"]
 }

environment.yaml

@@ -3,9 +3,10 @@ channels:
     - conda-forge
 dependencies:
     - black=23.1.0
-    - python=3.10.9
+    - cookiecutter=2.1.1
     - pre-commit=3.0.4
     - pylint=2.16.1
     - pytest=7.2.1
-    - cookiecutter=2.1.1
     - pytest=7.2.1
+    - python=3.10.9
+    - ruff=0.1.4

hooks/post_gen_project.py

@@ -5,6 +5,8 @@
 import subprocess
 from abc import ABC, abstractmethod
 
+import yaml
+
 
 # as cookiecutter is currently (v2.1.1) unable to support local imports in hooks
 # the environment management code has to be included here
@@ -105,6 +107,14 @@ def copy_chosen_files(self) -> None:
             else:
                 shutil.copy2(src, dst)
 
+    def remove_unused_linter_files(self):
+        with open(f"{self.temp_files_dir}/.manifest.yaml", "r", encoding="utf-8") as f:
+            manifest = yaml.safe_load(f)
+            for feature in manifest["features"]:
+                if not feature["enabled"]:
+                    for resource in feature["resources"]:
+                        os.remove(resource)
+
 
 def get_ci_cd_file_manager(ci_cd_options: str) -> ConditionalFileManager:
     template_root_dir = pathlib.Path.cwd()
@@ -147,6 +157,7 @@ def get_ci_cd_file_manager(ci_cd_options: str) -> ConditionalFileManager:
     print("copying")
     CICD_FILE_MANAGER.copy_chosen_files()
     print("cleaning")
+    CICD_FILE_MANAGER.remove_unused_linter_files()
     CICD_FILE_MANAGER.clean_temp_dir()
     print("after")
 

{{cookiecutter.repo_name}}/.gitignore

@@ -80,6 +80,15 @@ venv.bak/
 .idea
 .vscode
 
+# System files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
 # Data
 data/*
 !data/raw/

{{cookiecutter.repo_name}}/.pre-commit-config.yaml

@@ -31,6 +31,7 @@ repos:
             additional_dependencies: ['@commitlint/config-conventional']
             stages:
                 - commit-msg
+    {%- if cookiecutter.linter_name == "pylint" %}
     - repo: https://github.com/pycqa/isort
       rev: 5.12.0
       hooks:
@@ -39,6 +40,12 @@ repos:
             stages:
                 - commit
                 - manual
+    {%- elif cookiecutter.linter_name == "ruff" %}
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.1.4
+      hooks: 
+      - id: ruff
+    {%- endif %}
     - repo: local
       hooks:
           - id: black
@@ -52,6 +59,7 @@ repos:
             entry: nbqa black
             language: system
             files: \.ipynb
+          {%- if cookiecutter.linter_name == "pylint" %}
           - id: pylint
             name: pylint
             entry: pylint
@@ -65,6 +73,13 @@ repos:
             args:
                 - --disable=pointless-statement,duplicate-code,expression-not-assigned
                 - --const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__)|([a-z_][a-z0-9_]{0,50}))$
+          {%- elif cookiecutter.linter_name == "ruff" %}
+          - id: nbqa-ruff
+            name: nbqa-ruff
+            entry: nbqa ruff
+            language: system
+            files: \.ipynb
+          {%- endif %}
     - repo: https://github.com/pre-commit/mirrors-prettier
       rev: v2.7.1
       hooks:

{{cookiecutter.repo_name}}/.temp_ci_cd/.manifest.yaml

                     os.remove(resource) 
 def remove_unused_linter_files(self): 
     with open(f"{self.temp_files_dir}/.manifest.yaml", "r", encoding="utf-8") as f: 
         manifest = yaml.safe_load(f) 
         for feature in manifest["features"]: 
             if not feature["enabled"]: 
                 for resource in feature["resources"]: 
                     os.remove(resource) 
@@ -0,0 +1,9 @@
+features: 
+  - name: pylint
+    enabled: {{cookiecutter.linter_name == "pylint"}}
+    resources:
+      - .pylintrc
+  - name: ruff
+    enabled: {{cookiecutter.linter_name == "ruff"}}
+    resources:
+      - ruff.toml

{{cookiecutter.repo_name}}/environment.yaml

@@ -3,10 +3,14 @@ channels:
     - conda-forge
 dependencies:
     - black=23.1.0
-    - nbqa=1.6.1
+    - python=3.10.9
+    - pre-commit=3.0.4
     {%- if cookiecutter.install_jupyter == 'yes' %}
     - jupyter=1.0.0
+    - nbqa=1.6.1
     {%- endif %}
-    - python=3.10.9
-    - pre-commit=3.0.4
+    {%- if cookiecutter.linter_name == "pylint" %}
     - pylint=2.16.1
+    {%- elif cookiecutter.linter_name == "ruff" %}
+    - ruff=0.1.4
+    {%- endif %}

{{cookiecutter.repo_name}}/pyproject.toml

@@ -17,6 +17,8 @@ exclude = '''
 )
 '''
 
+{% if cookiecutter.linter_name == "pylint" %}
 [tool.isort]
-profile='black'
+profile = 'black'
 line_length = 100
+{% endif %}

{{cookiecutter.repo_name}}/ruff.toml

@@ -0,0 +1,33 @@
+# sync with black
+line-length = 100
+
+# No need for NBQA as ruff has native Jupyter support
+extend-include = ["*.ipynb"]
+
+# https://docs.astral.sh/ruff/rules/
+ignore = [
+#    "E501", # Line too long, handled by black
+#    "W291", # Trailing whitespace, handled by black
+#    "W292", # Missing final newline, handled by black
+#    "PLR0904", # Too many public methods
+#    "PLR0911", # Too many return statements
+#    "PLR0913", # Too many arguments
+#    "PLC0415", # Import outside toplevel
+    # NA as checks yet but mentioned in github comments
+    # "C0305", # Trailing newlines, handled by black
+    # "C0114", # Missing module docstring
+    # "C0115", # Missing class docstring
+    # "C0116", # Missing function docstring
+    # "R0902", # Too many instance attributes
+    # "R0903", # Too few public methods
+    # "R0914", # Too many locals
+    # "W0124", # Confusing with statement
+    # "C0413", # Wrong import position
+    # "C0410", # Multiple imports
+    # "R1705", # No else return
+    # "W0201", # Attribute defined outside init
+    # "E1123", # Unexpected keyword arg
+    # "C0401", # Wrong spelling in comment
+    # "C0402", # Wrong spelling in docstring
+    # "C0403"  # Invalid character in docstring
+]