Merge pull request #76 from bckohan/v1.2.x

Version 2.0

Author: bckohan

.github/workflows/lint.yml

@@ -1,6 +1,14 @@
 name: lint
 
-on: [push, pull_request, workflow_dispatch]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      debug:
+        description: 'Set to on, to open ssh debug session.'
+        required: true
+        default: 'off'
 
 jobs:
 
@@ -45,22 +53,19 @@ jobs:
           poetry run pip install --upgrade pip
           poetry install -E rich
           poetry run pip install -U "django~=${{ matrix.django-version }}"
-      # - name: Setup tmate session
-      #   uses: mxschmitt/action-tmate@v3
-      #   with:
-      #     detached: true
-      #   timeout-minutes: 60
+      - name: Install Emacs
+        if: ${{ github.event.inputs.debug == 'on' }}
+        run: |
+          sudo apt install emacs
+      - name: Setup tmate session
+        if: ${{ github.event.inputs.debug == 'on' }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          detached: true
+        timeout-minutes: 60
       - name: Run Static Analysis
         run: |
           source .venv/bin/activate
-          isort django_typer --check
-          black django_typer --check
-          pylint django_typer
-          mypy django_typer
-          pyright
-          poetry check
-          pip check
+          ./check.sh --no-fix
           python -m readme_renderer ./README.md -o /tmp/README.html
-          cd ./doc
-          doc8 --ignore-path build --max-line-length 100
           echo "$(poetry env info --path)/bin" >> $GITHUB_PATH

.github/workflows/test.yml

@@ -1,15 +1,16 @@
 name: test
 
 on:
-  push: # runs on everything
-  pull_request: # runs on everything
+  push:
+  pull_request:
   workflow_dispatch:
     inputs:
-      debug_enabled:
-        type: boolean
-        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
-        required: false
-        default: false
+      debug:
+        description: 'Set to on, to open ssh debug session.'
+        required: true
+        default: 'off'
+  schedule:
+    - cron: '0 13 * * *'  # Runs at 6 am pacific every day
 
 jobs:
 
@@ -50,11 +51,16 @@ jobs:
         poetry run pip install --upgrade pip
         poetry install
         poetry run pip install -U "Django~=${{ matrix.django-version }}"
-    # - name: Setup tmate session
-    #   uses: mxschmitt/action-tmate@v3
-    #   with:
-    #     detached: true
-    #   timeout-minutes: 60
+    - name: Install Emacs
+      if: ${{ github.event.inputs.debug == 'on' }}
+      run: |
+        sudo apt install emacs
+    - name: Setup tmate session
+      if: ${{ github.event.inputs.debug == 'on' }}
+      uses: mxschmitt/action-tmate@v3
+      with:
+        detached: true
+      timeout-minutes: 60
     - name: Run Unit Tests
       run: |
         poetry run pip install colorama
@@ -107,9 +113,19 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y fish
+    - name: Install Emacs
+      if: ${{ github.event.inputs.debug == 'on' }}
+      run: |
+        sudo apt install emacs
+    - name: Setup tmate session
+      if: ${{ github.event.inputs.debug == 'on' }}
+      uses: mxschmitt/action-tmate@v3
+      with:
+        detached: true
+      timeout-minutes: 60
     - name: Run Unit Tests
       run: |
-        poetry run pytest django_typer/tests/completion_tests.py
+        poetry run pytest django_typer/tests/shellcompletion/*
         mv .coverage linux-complete-py${{ matrix.python-version }}-dj${{ matrix.django-version }}.coverage
 
     - name: Store coverage files
@@ -136,7 +152,6 @@ jobs:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
-      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -154,8 +169,8 @@ jobs:
         echo "  compinit" >> ~/.zshrc
         echo "fi" >> ~/.zshrc
         echo "fpath+=~/.zfunc" >> ~/.zshrc
-        chmod go-w /usr/local/share
-        chmod -R go-w /usr/local/share/zsh
+        chmod go-w /opt/homebrew/share
+        chmod -R go-w /opt/homebrew/share/zsh
         source ~/.zshrc
         sudo chsh -s /bin/zsh runner
     # - name: Install Bash Completions
@@ -169,6 +184,10 @@ jobs:
     #   run: |
     #     brew install sbt
     #     brew install fish
+    - name: Install Emacs
+      if: ${{ github.event.inputs.debug == 'on' }}
+      run: |
+        brew install emacs
     - name: Install Poetry
       uses: snok/install-poetry@v1
       with:
@@ -181,10 +200,16 @@ jobs:
         poetry run pip install --upgrade pip
         poetry install
         poetry run pip install -U "Django~=${{ matrix.django-version }}"
+    - name: Setup tmate session
+      if: ${{ github.event.inputs.debug == 'on' }}
+      uses: mxschmitt/action-tmate@v3
+      with:
+        detached: true
+      timeout-minutes: 60
     - name: Run Unit Tests
       shell: zsh {0}
       run: |
-        poetry run pytest django_typer/tests/completion_tests.py::ZshShellTests || exit 1
+        poetry run pytest django_typer/tests/shellcompletion/test_zsh.py || exit 1
         mv .coverage macos-complete-py${{ matrix.python-version }}-dj${{ matrix.django-version }}.coverage
 
     - name: Store coverage files
@@ -245,11 +270,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      # - name: Setup tmate session
-      #   uses: mxschmitt/action-tmate@v3
-      #   with:
-      #     detached: true
-      #   timeout-minutes: 15
+      - name: Install Emacs
+        if: ${{ github.event.inputs.debug == 'on' }}
+        run: |
+          sudo apt install emacs
+      - name: Setup tmate session
+        if: ${{ github.event.inputs.debug == 'on' }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          detached: true
+        timeout-minutes: 60
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:

CONTRIBUTING.md

@@ -46,21 +46,20 @@ poetry run make html
 
 ## Static Analysis
 
-`django-typer` uses [Pylint](https://www.pylint.org/) for Python linting and [mypy](http://mypy-lang.org/) and [pyright](https://github.com/microsoft/pyright) for static type
-checking. Header imports are also standardized using [isort](https://pycqa.github.io/isort/) and formatting is
-done with [black](https://black.readthedocs.io/en/stable/). Before any PR is accepted the following must be run, and
-static analysis tools should not produce any errors or warnings. Disabling
-certain errors or warnings where justified is acceptable:
+`django-typer` uses [ruff](https://docs.astral.sh/ruff/) for Python linting, header import
+standardization and code formatting. [mypy](http://mypy-lang.org/) and
+[pyright](https://github.com/microsoft/pyright) are used for static type checking. Before any PR
+is accepted the following must be run, and static analysis tools should not produce any errors or
+warnings. Disabling certain errors or warnings where justified is acceptable:
 
 ```bash
-poetry run isort django_typer
-poetry run black django_typer
-poetry run pylint django_typer
-poetry run mypy django_typer
-pyright
-poetry check
-poetry run pip check
-poetry run python -m readme_renderer ./README.md
+./check.sh
+```
+
+To run static analysis without automated fixing you can run:
+
+```bash
+./check.sh --no-fix
 ```
 
 ## Running Tests