Add config key to ignore rules

Author: Sigmanificient

flake.nix

@@ -33,13 +33,13 @@
           version = "0.0.1";
           src = ./.;
 
-          propagatedBuildInputs = [ pypkgs.pygls ];
+          propagatedBuildInputs = [ pypkgs.pygls pypkgs.tomli ];
           nativeBuildInputs = with pkgs; [
             makeWrapper
           ];
 
           postPatch = ''
-            substituteInPlace src/ecsls/vera.py --replace   \
+            substituteInPlace src/ecsls/config.py --replace   \
               'self.path = "./banana-coding-style-checker"' \
               'self.path = "${ruleset}"'
           '';

src/ecsls/config.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+import tomli
+from lsprotocol.types import LSPAny
+from pygls.server import LanguageServer
+
+class Config:
+    _instance = None
+
+    @classmethod
+    def instance(cls) -> Config:
+        if cls._instance is None:
+            cls._instance = cls()
+
+        return cls._instance
+
+    def __init__(self):
+        self.__conf = {}
+        self.path = "./banana-coding-style-checker"
+
+    def set_opts(self, opts: LSPAny, ls: LanguageServer):
+        if opts is None:
+            return
+
+        self.path = opts.get("path", self.path)
+        ls.show_message(f"=> PATH = [{self.path}]")
+        if not os.path.exists(self.path):
+            raise ValueError
+
+    def _read_conf(self, confpath):
+        with open(confpath, "rb") as f:
+            self.__conf = tomli.load(f)
+
+    def read(self, filepath):
+        path = Path(filepath)
+
+        while path != '/':
+            if (path / "ecsls.toml").exists():
+                return self._read_conf(path / "ecsls.toml")
+
+            path = path.parent
+
+    def get(self, key, default):
+        return self.__conf.get(key, default)

src/ecsls/server.py

@@ -1,8 +1,9 @@
 import tempfile
 from typing import Dict, List
 
+from .config import Config
 from .version import __version__
-from .vera import get_vera_output, Report, ReportType, CONFIG
+from .vera import get_vera_output, Report, ReportType
 
 from pygls.server import LanguageServer
 from pygls.workspace import Document
@@ -59,7 +60,10 @@ def _merge_cf4s(reports: List[Report]) -> List[Report]:
 def get_diagnostics(text_doc: Document):
     content = text_doc.source
     filename = ".mk" if text_doc.filename == "Makefile" else text_doc.filename 
- 
+    
+    conf = Config.instance()
+    conf.read(text_doc.uri)
+
     with tempfile.NamedTemporaryFile(suffix=filename) as tf:
         tf.write(content.encode())
         tf.flush()
@@ -74,11 +78,12 @@ def get_diagnostics(text_doc: Document):
             severity=SEVERITIES[report.type],
         )
         for report in _merge_cf4s(reports)
+        if report.rule not in conf.get("ignore", [])
     ]
 
 @server.feature(INITIALIZE)
 async def initialize(ls: LanguageServer, params: InitializeParams):
-    CONFIG.set_opts(params.initialization_options, ls)
+    Config.instance().set_opts(params.initialization_options, ls)
 
 
 @server.feature(TEXT_DOCUMENT_DID_OPEN)

src/ecsls/vera.py

@@ -1,46 +1,29 @@
 from __future__ import annotations
 
+import re
+import subprocess
+
 from dataclasses import dataclass
 from enum import StrEnum
 
-import os
 import re
 import subprocess
 from typing import Final, List, Optional
 
-from lsprotocol.types import LSPAny
-from pygls.server import LanguageServer
-
-
-class Config:
-    _instance = None
-
-    @classmethod
-    def instance(cls):
-        if cls._instance is None:
-            cls._instance = cls()
-
-        return cls._instance
-
-    def __init__(self):
-        self.path = "./banana-coding-style-checker"
+from .config import Config
 
-    def set_opts(self, opts: LSPAny, ls: LanguageServer):
-        if opts is None:
-            return
-
-        self.path = opts.get("path", self.path)
-        ls.show_message(f"=> PATH = [{self.path}]")
-        if not os.path.exists(self.path):
-            raise ValueError
 
+REPORT_FORMAT: Final[re.Pattern] = re.compile(
+    r"^[^:]+:(?P<line>\d+):\s?(?P<type>MAJOR|MINOR|INFO):(?P<rule>C-\w\d)$"
+)
 
 class ReportType(StrEnum):
     MAJOR = "MAJOR"
     MINOR = "MINOR"
     INFO = "INFO"
 
 
+
 @dataclass
 class Report:
     line: int
@@ -80,16 +63,12 @@ def message(self) -> str:
         times = f" x{self.count}" * (self.count > 1)
         return f"{self.rule}: {desc}" + times
 
-CONFIG = Config.instance()
-REPORT_FORMAT: Final[re.Pattern] = re.compile(
-    r"^[^:]+:(?P<line>\d+):\s?(?P<type>MAJOR|MINOR|INFO):(?P<rule>C-\w\d)$"
-)
-
 
 def populate_descriptions():
     descriptions = {}
 
-    with open(f"{CONFIG.path}/vera/code_to_comment") as f:
+    conf = Config.instance()
+    with open(f"{conf.path}/vera/code_to_comment") as f:
         content = f.read()
 
     for line in content.split("\n"):
@@ -115,13 +94,14 @@ def parse_vera_output(raw_report: str) -> List[Report]:
 
 
 def get_vera_output(filename: str) -> List[Report]:
+    conf = Config.instance()
     out = subprocess.run(
         (
             "vera++",
             "--profile",
             "epitech",
             "--root",
-            f"{CONFIG.path}/vera",
+            f"{conf.path}/vera",
             filename,
         ),
         capture_output=True,