Merge branch 'sushmey-dev-branch' of https://github.com/Sushmey/zulip-terminal into sushmey-dev-branch

Author: Sushmey

.github/workflows/lint-and-test.yml

@@ -9,7 +9,7 @@ on:
 
 # Cancel previous runs within same workflow and if within a PR (all branch runs complete)
 # (head_ref [branch name] is unique to and only for PRs, otherwise use always-unique run_id)
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
@@ -31,9 +31,9 @@ jobs:
       - name: Run mypy
         run: ./tools/run-mypy
 
-  flake8:
+  ruff:
     runs-on: ubuntu-latest
-    name: Lint - PEP8 & more (flake8)
+    name: Lint - PEP8 & more (ruff)
     steps:
       - uses: actions/checkout@v3
         with:
@@ -45,8 +45,8 @@ jobs:
           cache-dependency-path: 'setup.py'
       - name: Install with linting tools
         run: pip install .[linting]
-      - name: Run flake8
-        run: flake8 zulipterminal/ tests/ setup.py `tools/python_tools.py`
+      - name: Run ruff
+        run: ruff zulipterminal/ tests/ setup.py `tools/python_tools.py`
 
   isort:
     runs-on: ubuntu-latest
@@ -57,7 +57,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.7
           cache: 'pip'
           cache-dependency-path: 'setup.py'
       - name: Install with linting tools
@@ -75,14 +75,31 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.7
           cache: 'pip'
           cache-dependency-path: 'setup.py'
       - name: Install with linting tools
         run: pip install .[linting]
       - name: Check code & tests meet black standards
         run: black --check zulipterminal/ tests/ setup.py `tools/python_tools.py`
 
+  spellcheck:
+    runs-on: ubuntu-latest
+    name: Lint - Spellcheck
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.7
+          cache: 'pip'
+          cache-dependency-path: 'setup.py'
+      - name: Install with linting tools
+        run: pip install .[linting]
+      - name: Check spelling
+        run: ./tools/run-spellcheck
+
   hotkeys:
     runs-on: ubuntu-latest
     name: Lint - Hotkeys linting & docs sync check
@@ -92,13 +109,13 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.7
           cache: 'pip'
           cache-dependency-path: 'setup.py'
       - name: Minimal install
         run: pip install .
-      - name: Run generate_hotkeys
-        run: ./tools/generate_hotkeys.py --check-only
+      - name: Run lint-hotkeys
+        run: ./tools/lint-hotkeys
 
   docstrings:
     runs-on: ubuntu-latest
@@ -109,30 +126,89 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.7
           cache: 'pip'
           cache-dependency-path: 'setup.py'
       - name: Minimal install
         run: pip install .
       - name: Run lint-docstring
         run: ./tools/lint-docstring
 
-  pytest:
+  base_pytest:
+    runs-on: ubuntu-latest
+    name: Install & test - CPython 3.7 (ubuntu), codecov
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - name: Install Python version
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.7
+          cache: 'pip'
+          cache-dependency-path: 'setup.py'
+      - name: Output Python version
+        run: python --version
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Ensure regular package installs from checkout
+        run: pip install .
+      - name: Install test dependencies
+        run: pip install .[testing]
+      - name: Run tests with pytest
+        run: pytest --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+
+  isolated-commits:
+    runs-on: ubuntu-latest
+    name: Ensure isolated PR commits
+    needs:
+      - mypy
+      - ruff
+      - isort
+      - black
+      - spellcheck
+      - hotkeys
+      - docstrings
+      - base_pytest
+    steps:
+      - uses: actions/checkout@v3
+        if: github.event_name == 'pull_request'
+        with:
+          persist-credentials: false
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        if: github.event_name == 'pull_request'
+        with:
+          python-version: 3.7
+          cache: 'pip'
+          cache-dependency-path: 'setup.py'
+      - name: Run check-branch
+        if: github.event_name == 'pull_request'
+        # Note that we install at each step since dependencies may change
+        run:
+          git fetch https://github.com/zulip/zulip-terminal main;
+          CHECK="pip install .[linting,testing,typing] && ./tools/lint-all && pytest" ./tools/check-branch FETCH_HEAD
+
+  pytest-on-other-platforms:
+    needs: isolated-commits
     strategy:
       # Not failing fast allows all matrix jobs to try & finish even if one fails early
       fail-fast: false
       matrix:
         env:
-          - {PYTHON: 3.6, OS: ubuntu-latest, NAME: "CPython 3.6 (ubuntu)"}
-          - {PYTHON: 3.7, OS: ubuntu-latest, NAME: "CPython 3.7 (ubuntu)"}
-          - {PYTHON: 3.8, OS: ubuntu-latest, NAME: "CPython 3.8 (ubuntu)"}
-          - {PYTHON: 3.9, OS: ubuntu-latest, NAME: "CPython 3.9 (ubuntu)", CODECOV: true}
-          - {PYTHON: "3.10", OS: ubuntu-latest, NAME: "CPython 3.10 (ubuntu)"}
-          - {PYTHON: 'pypy-3.6', OS: ubuntu-latest, NAME: "PyPy 3.6 (ubuntu)"}
-          - {PYTHON: 'pypy-3.7', OS: ubuntu-latest, NAME: "PyPy 3.7 (ubuntu)"}
-          - {PYTHON: 'pypy-3.8', OS: ubuntu-latest, NAME: "PyPy 3.8 (ubuntu)"}
-          - {PYTHON: 'pypy-3.9', OS: ubuntu-latest, NAME: "PyPy 3.9 (ubuntu)"}
-          - {PYTHON: 3.9, OS: macos-latest, NAME: "CPython 3.9 (macos)"}
+          - {PYTHON: 3.8, OS: ubuntu-latest, NAME: "CPython 3.8 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: 3.9, OS: ubuntu-latest, NAME: "CPython 3.9 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: "3.10", OS: ubuntu-latest, NAME: "CPython 3.10 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: "3.11", OS: ubuntu-latest, NAME: "CPython 3.11 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: 'pypy-3.7', OS: ubuntu-latest, NAME: "PyPy 3.7 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: 'pypy-3.8', OS: ubuntu-latest, NAME: "PyPy 3.8 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: 'pypy-3.9', OS: ubuntu-latest, NAME: "PyPy 3.9 (ubuntu)", EXPECT: "Linux"}
+          - {PYTHON: '3.x', OS: macos-latest, NAME: "CPython 3.x [latest] (macos)", EXPECT: "MacOS"}
+    env:
+      EXPECT: ${{ matrix.env.EXPECT }}
     runs-on: ${{ matrix.env.OS }}
     name: Install & test - ${{ matrix.env.NAME}}
     steps:
@@ -154,11 +230,9 @@ jobs:
         run: sudo apt install libxml2-dev libxslt1-dev
       - name: Ensure regular package installs from checkout
         run: pip install .
+      - name: Check we detect the platform correctly
+        run: python -c "from zulipterminal.platform_code import detected_platform; import os; e, d = os.environ['EXPECT'], detected_platform(); assert d == e, f'{d} != {e}'"
       - name: Install test dependencies
         run: pip install .[testing]
       - name: Run tests with pytest
-        run: pytest --cov-report=xml
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
-        # We avoid extra work by just running codecov on one python version
-        if: matrix.env.CODECOV
+        run: pytest --cov-report=

.gitlint

@@ -4,6 +4,9 @@ ignore=title-trailing-punctuation, body-is-missing, body-min-length, title-must-
 # ZT: These are custom rules written for Zulip-Terminal, included by default
 extra-path=tools/gitlint-extra-rules.py
 
+# Added to acknowledge that eg. ignore-by-title regex
+regex-style-search=True
+
 # verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
 # verbosity = 2
 

CHANGELOG.md

@@ -364,7 +364,7 @@ While not composed of as many significant changes as 0.5.0, this is a meaningful
 - Support nested lists (bulleted and numbered)
 - Style reaction counts which include yourself differently (inverted colors, typically)
 - Sort reactions alphabetically for consistency
-- Support color depths other than 256-colors; try --color-depth=1 for a retro, high-constrast experience!
+- Support color depths other than 256-colors; try --color-depth=1 for a retro, high-contrast experience!
 - Improve specificity of colors in default theme, enhancing rendering and consistency in 256 color mode
 - Use triangle symbol (▶) to separate streams and topics, instead of simply '>'
 - The 'bar' extending from topics or private message recipients is now thinner and colored if a stream