Configure Neovim and pre-commit to run flake8 and pylint (IBM#1339)

* Configure Neovim (and pre-commit) to run flake8 and pylint

Signed-off-by: Jonathan Springer <[email protected]>

* Adjust Makefile to match to GitHub CI/CD (ish).

Signed-off-by: Jonathan Springer <[email protected]>

* Add black to the pre-commit linters

Signed-off-by: Jonathan Springer <[email protected]>

* fix: Warnings are revealing improperly built tests.

Signed-off-by: Jonathan Springer <[email protected]>

* chore: add markdown config to nvim for LazyVim

Signed-off-by: Jonathan Springer <[email protected]>

* fix:  Create a lightweight pre-commit configuration to support Make tests and build check

Signed-off-by: Jonathan Springer <[email protected]>

* fix: correct uv pre-commit command in Makefile

The pre-commit target was using 'uv pre-commit run' which is not a valid
uv subcommand. Changed to 'uv run pre-commit run' to properly invoke the
pre-commit tool through uv's run command.

Signed-off-by: Mihai Criveti <[email protected]>

---------

Signed-off-by: Jonathan Springer <[email protected]>
Signed-off-by: Mihai Criveti <[email protected]>
Co-authored-by: Mihai Criveti <[email protected]>
Signed-off-by: p4yl04d3r <[email protected]>

Author: 2 people

.github/workflows/lint.yml

@@ -70,8 +70,8 @@ jobs:
               vulture mcpgateway --min-confidence 80
 
           - id: pylint
-            setup: pip install pylint pylint-pydantic
-            cmd: pylint mcpgateway --errors-only --fail-under=10
+            setup: true
+            cmd: uv run pylint mcpgateway --fail-on E --fail-under=10
 
           - id: interrogate
             setup: pip install interrogate
@@ -131,6 +131,11 @@ jobs:
         with:
           python-version: "3.12"
           cache: pip
+      # -----------------------------------------------------------
+      #   Install uv
+      # -----------------------------------------------------------
+      - name: ⚡Set up uv
+        uses: astral-sh/setup-uv@v6
 
       # -----------------------------------------------------------
       # 2️⃣  Install Project + Dev Dependencies

.nvim.lua

@@ -1,25 +1,34 @@
-
 -- Set colorcolumn to 200 for Python files only
 vim.api.nvim_create_autocmd("FileType", {
-  pattern = "python",
-  callback = function()
-    vim.opt_local.colorcolumn = "200"
-  end,
+    pattern = "python",
+    callback = function()
+        vim.opt_local.colorcolumn = "200"
+    end,
+})
+
+-- Set up for line formatting .md files to a 120-character limit
+vim.api.nvim_create_autocmd("FileType", {
+    pattern = "markdown",
+    callback = function()
+        vim.opt_local.colorcolumn = "120"
+        vim.opt_local.textwidth = 120
+    end,
 })
 
 --
 --  Project settings for ALE (Asynchronous Lint Engine)
 --  ALE is available at https://github.com/dense-analysis/ale
+--
 vim.g.ale_linters = {
-  make = {},
-  python = { "mypy", "ruff" },
-  markdown = { "markdownlint" },
+    make = {},
+    python = { "mypy", "ruff", "flake8", "pylint" },
+    markdown = { "markdownlint" },
 }
 vim.g.ale_python_auto_uv = 1
 
-vim.g.ale_python_mypy_options='--no-pretty'
-vim.g.ale_python_ruff_options = '--extend-select I'
-vim.g.ale_markdown_markdownlint_executable = 'markdownlint-cli2'
+vim.g.ale_python_mypy_options = "--no-pretty"
+vim.g.ale_python_ruff_options = "--extend-select I"
+vim.g.ale_markdown_markdownlint_executable = "markdownlint-cli2"
 
 vim.g.ale_fixers = {
     python = { "ruff", "black" },

.pre-commit-config.yaml

@@ -18,7 +18,7 @@
 # report issues (linters). Modified files will need to be staged again.
 # -----------------------------------------------------------------------------
 
-exclude: '(^|/)(\.pre-commit-config\.yaml|normalize_special_characters\.py|test_input_validation\.py|ai_artifacts_normalizer\.py)$|(^|/)mcp-servers/templates/|(^|/)tests/load/|.*\.(jinja|j2)$'  # ignore these files, all templates, load tests, and jinja files
+exclude: '(^|/)(\.pre-commit-.*\.yaml|normalize_special_characters\.py|test_input_validation\.py|ai_artifacts_normalizer\.py)$|(^|/)mcp-servers/templates/|(^|/)tests/load/|.*\.(jinja|j2)$'  # ignore these files, all templates, load tests, and jinja files
 
 repos:
   # -----------------------------------------------------------------------------
@@ -190,11 +190,6 @@ repos:
         description: Removes UTF-8 byte order marker.
         types: [text]
 
-      - id: fix-encoding-pragma
-        name: 🧹 Fix Python Encoding Pragma
-        description: "Adds # -*- coding: utf-8 -*- to the top of python files."
-        types: [python]
-
       - id: mixed-line-ending
         name: 🧹 Mixed Line Ending
         description: Replaces or checks mixed line ending.
@@ -371,12 +366,12 @@ repos:
         exclude: ^tests/(.*/)?(pages|helpers|fuzzers|scripts|fixtures|migration|utils|manual|async|load)/.*\.py$
         args: [--pytest-test-first] # `test_.*\.py`
 
-  # - repo: https://github.com/pycqa/flake8
-  #   rev: 7.2.0
-  #   hooks:
-  #     - id: flake8
-  #       name: 🐍 Flake8 - Python Linter
-  #       description: Tool for style guide enforcement.
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.2.0
+    hooks:
+      - id: flake8
+        name: 🐍 Flake8 - Python Linter
+        description: Tool for style guide enforcement.
 
   # - repo: https://github.com/pycqa/bandit
   #   rev: 1.8.3
@@ -418,13 +413,13 @@ repos:
       #   types_or: [ python, pyi ]
       #   files: ^mcpgateway/
 
-  # - repo: https://github.com/psf/black
-  #   rev: 25.1.0
-  #   hooks:
-  #     - id: black
-  #       name: 🐍 Black - Python Code Formatter
-  #       description: The uncompromising Python code formatter.
-  #       language_version: python3
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        name: 🐍 Black - Python Code Formatter
+        description: The uncompromising Python code formatter.
+        language_version: python3
 
   # - repo: https://github.com/pycqa/isort
   #   rev: 6.0.1