🎨 Add auto formatter

.github/workflows/codeql.yml

@@ -48,11 +48,11 @@ jobs:
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
-        
+
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
 
-        
+
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
@@ -61,7 +61,7 @@ jobs:
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
     #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
     # - run: |

.github/workflows/lint-format.yml

@@ -0,0 +1,54 @@
+name: Formatter
+
+on:
+  pull_request:
+  push:
+
+env:
+  SKIP: pylint,isort,black
+
+jobs:
+  Formatter:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4.1.1
+        with:
+          ref: ${{ github.head_ref }}
+      - uses: isort/isort-action@v1.1.0
+        with:
+          configuration: "--settings-file=.isort.cfg"
+          requirements-files: "requirements.txt"
+      - uses: psf/black@stable
+        with:
+          options: "--line-length=120"
+          version: "24.3.0"
+      - uses: stefanzweifel/git-auto-commit-action@v5.0.0
+        with:
+          commit_message: "Format code with isort and black"
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.1
+      - uses: actions/setup-python@v5.0.0
+      - uses: pre-commit/action@v3.0.0
+  Pylint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+    steps:
+      - uses: actions/checkout@v4.1.1
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Analysing the code with pylint
+        run: |
+          pylint $(git ls-files '*.py') --rcfile=$(git ls-files '.pylintrc')

.github/workflows/main.yml

@@ -33,24 +33,24 @@ jobs:
     - uses: actions/checkout@v3.1.0
       with:
         fetch-depth: 0
-    
+
     - name: Setup Python
       uses: actions/setup-python@v4.3.0
       with:
         python-version: 3.9
         cache: 'pip'
       if: matrix.os != 'macos-latest'
-    
+
     - name: Setup Python MacOS
       run: |
             wget https://www.python.org/ftp/python/3.10.11/python-3.10.11-macos11.pkg
             sudo installer -verbose -pkg ./python-3.10.11-macos11.pkg -target /
             echo "/Library/Frameworks/Python.framework/Versions/3.10/bin" >> $GITHUB_PATH
       if: matrix.os == 'macos-latest'
-        
+
     - name: Install Requirements
       run: python3 -m pip install --upgrade pip && pip3 install wheel && pip3 install -r requirements.txt && pip3 uninstall -y typing
-    
+
     - name: Build Wheel
       run: python3 setup.py bdist_wheel
       if: matrix.os == 'ubuntu-latest'
@@ -61,7 +61,7 @@ jobs:
         name: pros-cli-wheel-${{needs.update_build_number.outputs.output1}}
         path: dist/*
       if: matrix.os == 'ubuntu-latest'
-      
+
     - name: Run Pyinstaller
       run: |
             python3 version.py
@@ -80,7 +80,7 @@ jobs:
             pyinstaller --onefile pros/cli/compile_commands/intercept-cc.py --name=intercept-cc --target-arch=universal2
             pyinstaller --onefile pros/cli/compile_commands/intercept-cc.py --name=intercept-c++ --target-arch=universal2
       if: matrix.os == 'macos-latest'
-      
+
     - name: Package Everything Up
       shell: bash
       run: |

.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+
+line_length = 120
+
+profile = black

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-vcs-permalinks
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+      - id: isort
+        name: isort
+        types: [python]
+        args: [--settings-file=.isort.cfg]
+  - repo: https://github.com/psf/black
+    rev: 24.3.0
+    hooks:
+      - id: black
+        args: ["--line-length=120"]
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: python -m pylint
+        language: system
+        types: [python]
+        args: [--rcfile=.pylintrc]

.pylintrc

@@ -0,0 +1,9 @@
+[MASTER]
+
+max-line-length = 120
+disable =   C0114, C0115, C0116, R0903, C0415, R1705, R0913, W1203, R1729, E1120, E1123, C0209, R1710, W0621, C0121,
+            W0614, W0401, W1202, C0117, W0718, R0205, R0402, R0914, R1725, R1735, C0411, W0237, W0702, W0223, W0613,
+            W0108, R0912, R0911, W0511, E1136, R0902, W0611, C0412, C0103, C0301, R1732, R0915, W1514, R1718, W1510,
+            E0602, W1309, C0325, E1101, R1714, R0916, W0719, R1734, E1133, W1201, W0107, W3101, W0640, C0201, W1113,
+            W0246, W0622, W0221, E1111, R1720, W0221, R1723, E0102, W0201, E0203, E0401, W0602, W0212, W0707, R0904,
+            W0101, C0302, E0110, W0603, R1701, W0106, R1721, W0601, R0401, R1731, W0612

install_requires.py

@@ -1,2 +1,2 @@
-with open('requirements.txt') as reqs:
+with open("requirements.txt") as reqs:
     install_requires = [req.strip() for req in reqs.readlines()]

pip_version

@@ -1 +1 @@
-3.5.0
+3.5.0

pros/cli/build.py

@@ -5,8 +5,9 @@
 import click
 
 import pros.conductor as c
-from pros.ga.analytics import analytics
 from pros.cli.common import default_options, logger, project_option, pros_root, shadow_command
+from pros.ga.analytics import analytics
+
 from .upload import upload
 
 
@@ -15,9 +16,9 @@ def build_cli():
     pass
 
 
-@build_cli.command(aliases=['build','m'])
+@build_cli.command(aliases=["build", "m"])
 @project_option()
-@click.argument('build-args', nargs=-1)
+@click.argument("build-args", nargs=-1)
 @default_options
 def make(project: c.Project, build_args):
     """
@@ -26,17 +27,17 @@ def make(project: c.Project, build_args):
     analytics.send("make")
     exit_code = project.compile(build_args)
     if exit_code != 0:
-        if sys.platform == 'win32':
+        if sys.platform == "win32":
             kernel32 = ctypes.windll.kernel32
             kernel32.SetConsoleMode(kernel32.GetStdHandle(-11), 7)
 
-        logger(__name__).error(f'Failed to make project: Exit Code {exit_code}', extra={'sentry': False})
-        raise click.ClickException('Failed to build')
+        logger(__name__).error(f"Failed to make project: Exit Code {exit_code}", extra={"sentry": False})
+        raise click.ClickException("Failed to build")
     return exit_code
 
 
-@build_cli.command('make-upload', aliases=['mu'], hidden=True)
-@click.option('build_args', '--make', '-m', multiple=True, help='Send arguments to make (e.g. compile target)')
+@build_cli.command("make-upload", aliases=["mu"], hidden=True)
+@click.option("build_args", "--make", "-m", multiple=True, help="Send arguments to make (e.g. compile target)")
 @shadow_command(upload)
 @project_option()
 @click.pass_context
@@ -46,41 +47,45 @@ def make_upload(ctx, project: c.Project, build_args: List[str], **upload_args):
     ctx.invoke(upload, project=project, **upload_args)
 
 
-@build_cli.command('make-upload-terminal', aliases=['mut'], hidden=True)
-@click.option('build_args', '--make', '-m', multiple=True, help='Send arguments to make (e.g. compile target)')
+@build_cli.command("make-upload-terminal", aliases=["mut"], hidden=True)
+@click.option("build_args", "--make", "-m", multiple=True, help="Send arguments to make (e.g. compile target)")
 @shadow_command(upload)
 @project_option()
 @click.pass_context
 def make_upload_terminal(ctx, project: c.Project, build_args, **upload_args):
     analytics.send("make-upload-terminal")
     from .terminal import terminal
+
     ctx.invoke(make, project=project, build_args=build_args)
     ctx.invoke(upload, project=project, **upload_args)
     ctx.invoke(terminal, port=project.target, request_banner=False)
 
 
-@build_cli.command('build-compile-commands', hidden=True)
+@build_cli.command("build-compile-commands", hidden=True)
 @project_option()
-@click.option('--suppress-output/--show-output', 'suppress_output', default=False, show_default=True,
-              help='Suppress output')
-@click.option('--compile-commands', type=click.File('w'), default=None)
-@click.option('--sandbox', default=False, is_flag=True)
-@click.argument('build-args', nargs=-1)
+@click.option(
+    "--suppress-output/--show-output", "suppress_output", default=False, show_default=True, help="Suppress output"
+)
+@click.option("--compile-commands", type=click.File("w"), default=None)
+@click.option("--sandbox", default=False, is_flag=True)
+@click.argument("build-args", nargs=-1)
 @default_options
-def build_compile_commands(project: c.Project, suppress_output: bool, compile_commands, sandbox: bool,
-                           build_args: List[str]):
+def build_compile_commands(
+    project: c.Project, suppress_output: bool, compile_commands, sandbox: bool, build_args: List[str]
+):
     """
     Build a compile_commands.json compatible with cquery
     :return:
     """
     analytics.send("build-compile-commands")
-    exit_code = project.make_scan_build(build_args, cdb_file=compile_commands, suppress_output=suppress_output,
-                                        sandbox=sandbox)
+    exit_code = project.make_scan_build(
+        build_args, cdb_file=compile_commands, suppress_output=suppress_output, sandbox=sandbox
+    )
     if exit_code != 0:
-        if sys.platform == 'win32':
+        if sys.platform == "win32":
             kernel32 = ctypes.windll.kernel32
             kernel32.SetConsoleMode(kernel32.GetStdHandle(-11), 7)
 
-        logger(__name__).error(f'Failed to make project: Exit Code {exit_code}', extra={'sentry': False})
-        raise click.ClickException('Failed to build')
+        logger(__name__).error(f"Failed to make project: Exit Code {exit_code}", extra={"sentry": False})
+        raise click.ClickException("Failed to build")
     return exit_code