get ci pipelines functional, and switch to ruff linter/formatter

.github/actions/check-json/json_checker.py

@@ -1,5 +1,6 @@
 import json
 import re
+import sys
 from glob import glob
 from typing import List, Tuple, Union
 
@@ -8,11 +9,7 @@
 
 def format_output(*, level: str, file: str, line: int, col: int, message: str) -> str:
     return "::{level} file={file},line={line},col={col}::{message}".format(
-        level=level,
-        file=file,
-        line=line,
-        col=col,
-        message=message
+        level=level, file=file, line=line, col=col, message=message
     )
 
 
@@ -36,13 +33,13 @@ def validate(schema_name: str, filename: str) -> bool:
             error_keys, msg_bounds = list_from_str(error.message)
             for key in error_keys:
                 line, col = get_key_pos(filename, key)
-                message = f"{error.message[:msg_bounds[0] + 1]}{key}{error.message[msg_bounds[1] - 1:]}"
+                message = f"{error.message[: msg_bounds[0] + 1]}{key}{error.message[msg_bounds[1] - 1 :]}"
                 print(format_output(level="error", file=filename, line=line, col=col, message=message))
         else:
             key_name = error.path[1]
             line, col = get_key_pos(filename, key_name)
             print(format_output(level="warning", file=filename, line=line, col=col, message=error.message))
-            return False
+        return False
 
 
 def get_key_pos(filename: str, key: str) -> Tuple[int, int]:
@@ -72,8 +69,8 @@ def list_from_str(set_str: str) -> Tuple[List[str], Tuple[int, int]]:
 def main() -> int:
     validation_success: List[bool] = []
     for file_pattern, schema_path in {
-            "info.json": ".github/actions/check-json/repo.json",
-            "*/info.json": ".github/actions/check-json/cog.json"
+        "info.json": ".github/actions/check-json/repo.json",
+        "*/info.json": ".github/actions/check-json/cog.json",
     }.items():
         for filename in glob(file_pattern):
             validation_success.append(validate(schema_path, filename))
@@ -83,4 +80,4 @@ def main() -> int:
 
 if __name__ == "__main__":
     exit_code = main()
-    exit(exit_code)
+    sys.exit(exit_code)

.github/actions/setup/action.yml

@@ -3,16 +3,16 @@ description: Installs project dependencies
 runs:
   using: composite
   steps:
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v2
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.8"
+        python-version: "3.11"
     - name: Install base dependencies
       shell: bash
       run: pip install --quiet --upgrade --requirement requirements.txt
     - name: Install CI dependencies
       shell: bash
-      run: pip install --quiet --upgrade --requirement requirements-ci.txt
+      run: pip install --quiet --upgrade --requirement requirements-dev.txt
     - name: Install cog dependencies
       shell: bash
       run: |

.github/actions/setup/compile_requirements.py

@@ -1,4 +1,5 @@
 """Pipeline script for extracting imports from cogs"""
+
 import json
 from glob import glob
 from typing import Set

.github/workflows/ci.yml

@@ -3,55 +3,33 @@ name: CI
 on: [pull_request]
 
 jobs:
-  lint-flake8:
+  ruff:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install dependencies
         uses: ./.github/actions/setup
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings
-          flake8 . --format="::warning file=%(path)s,line=%(row)d,col=%(col)d::%(text)s" --exit-zero --max-complexity=10
+      - uses: astral-sh/ruff-action@v3
+        with:
+          version-file: "./requirements-dev.txt"
 
-  lint-black:
+  pyright:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install dependencies
         uses: ./.github/actions/setup
-      - name: Lint with black
-        run: black --diff .
-
-  lint-pylint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
-      - name: Install dependencies
-        uses: ./.github/actions/setup
-      - name: Lint with pylint
-        run: pylint --msg-template='::warning file={path},line={line},col={column}::{msg}' */ || exit 0
-
-  lint-isort:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
-      - name: Install dependencies
-        uses: ./.github/actions/setup
-      - name: Lint with isort
-        run: isort --check --diff .
+      - uses: jakebailey/pyright-action@v2
+        with:
+          python-version: "3.11"
 
   check-json:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install dependencies
         uses: ./.github/actions/setup
       - name: Check cog and repo JSON files against schema
@@ -61,8 +39,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository at the current branch
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install dependencies
         uses: ./.github/actions/setup
       - name: Run unit tests
         run: python3 -m pytest .
+
+  fixmes:
+    name: FIXME check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: rippleFCL/[email protected]
+      with:
+        terms: 'WIP|FIXME'
+        case-sensitive: false
+        severity: "WARNING"

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: ["--fix", "--exit-non-zero-on-fix"]
+      # Run the formatter.
+      - id: ruff-format
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.393
+    hooks:
+    - id: pyright

.vscode/extensions.json

@@ -1,9 +1,7 @@
 {
   "recommendations": [
-      "ms-python.black-formatter",
-      "ms-python.isort",
-      "ms-python.pylint",
-      "ms-python.python",
+      "charliermarsh.ruff",
       "ms-python.vscode-pylance",
+      "MarkLarah.pre-commit-vscode",
   ]
 }

README.md

@@ -42,6 +42,9 @@ Cogs for the [Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot/)-b
     - [Reactrole](#reactrole)
     - [Report](#report)
     - [role\_welcome](#role_welcome)
+      - [Welcome Message Templating](#welcome-message-templating)
+      - [Welcome Logic](#welcome-logic)
+      - [Commands](#commands)
     - [Roleinfo](#roleinfo)
     - [Sentry](#sentry)
     - [Tags](#tags)
@@ -114,7 +117,7 @@ This cog displays the number of users banned in the guild with a random selectio
 - `[p]bancount` - Displays the total ban count using a randomly selected message.
 - `[p]bancount list` - Lists all the messages that can be used in the guild.
 - `[p]bancount add <message>` - Add a message to the guild list. Use `$ban` to insert the ban count in the message.
-- `[p]bancount remove <message index>` - Deletes (by index, from the list command) the message from the guild list. 
+- `[p]bancount remove <message index>` - Deletes (by index, from the list command) the message from the guild list.
 
 ### BetterPing
 
@@ -206,14 +209,14 @@ Also availble as a slash command.
 ### Jail
 
 This cog allows users to be "jailed" in their own personal cell (channel). Also archives the channel to disk for future
-reference. 
+reference.
 
-* `[p]jail setup <#category>` - Set the jail category where jail channels will be created in. (category is the channel 
+* `[p]jail setup <#category>` - Set the jail category where jail channels will be created in. (category is the channel
 category ID of the jail category)
 * `[p]jail <@user>` - Jail the specified user.
 * `[p]jail free <@user>` - Frees the specified user and cleans up the jail channel & role, archives the channel content.
 * `[p]jail archives` - Lists the archived jails with user, date, and jail UUID.
-* `[p]jail archives fetch <export uuid>` - Sends the specified jail channel archive as a file in the current channel (be 
+* `[p]jail archives fetch <export uuid>` - Sends the specified jail channel archive as a file in the current channel (be
 careful running this in public channels)
 
 ### Latex
@@ -477,16 +480,15 @@ If you're using VSCode, this repository also includes launch configs for the bot
 
 ### Linting your code
 
-The CI will fail unless your code is [PEP8](https://www.python.org/dev/peps/pep-0008/) compliant.
+Your code must be passed by our lint & type checkers to be merged:
 
 ```bash
-pip install -r requirements-ci.txt
-isort . # This will fix the order of imports
-black . # This will auto-format and fix a lot of common mistakes
-pylint * # This will show general pep8-violations
+pip install -r requirements-dev.txt -r requirements.txt
+pre-commit install
+pre-commit run --all-files
 ```
 
-If you use [VSCode](https://code.visualstudio.com/) you can use the tasks integrated into the repo to locally run the same tasks as our CI
+If you use [VSCode](https://code.visualstudio.com/) you can use the [pre-commit-vscode](https://marketplace.visualstudio.com/items?itemName=MarkLarah.pre-commit-vscode) extension to auto generate tasks for the pre-commit hooks
 
 ### Making changes