add linter function

Author: Gerit Wagner

search_query/linter.py

@@ -8,13 +8,14 @@
 import search_query.parser
 from search_query.constants import ExitCodes
 from search_query.search_file import load_search_file
+from search_query.search_file import SearchFile
 
 if typing.TYPE_CHECKING:
     from search_query.parser_base import QueryStringParser
 # pylint: disable=broad-except
 
 
-def get_parser(
+def _get_parser(
     search_string: str, *, platform: str, search_field_general: str
 ) -> QueryStringParser:
     """Run the linter on the search string"""
@@ -32,6 +33,46 @@ def get_parser(
     return parser
 
 
+def lint_file(search_file: SearchFile) -> dict:
+    """Lint a search file and return the messages."""
+    # pylint: disable=too-many-locals
+    platform = search_query.parser.get_platform(search_file.platform)
+    if platform not in search_query.parser.PARSERS:
+        raise ValueError(
+            f"Unknown platform: {platform}. "
+            f"Must be one of {search_query.parser.PARSERS}"
+        )
+
+    return lint_query_string(
+        search_file.search_string,
+        platform=search_file.platform,
+        search_field_general=search_file.search_field,
+    )
+
+
+def lint_query_string(
+    search_string: str,
+    *,
+    platform: str,
+    search_field_general: str = "",
+) -> dict:
+    """Lint a query string and return the messages."""
+    # pylint: disable=too-many-locals
+    if platform not in search_query.parser.PARSERS:
+        raise ValueError(
+            f"Unknown platform: {platform}. "
+            f"Must be one of {search_query.parser.PARSERS}"
+        )
+
+    print(f"Linting query string for platform {platform}")
+
+    parser = _get_parser(
+        search_string, platform=platform, search_field_general=search_field_general
+    )
+
+    return parser.linter.messages  # type: ignore
+
+
 # pylint: disable=too-many-locals
 def pre_commit_hook(file_path: str) -> int:
     """Entrypoint for the query linter hook"""
@@ -52,7 +93,7 @@ def pre_commit_hook(file_path: str) -> int:
 
     print(f"Lint: {Path(file_path).name} ({platform})")
 
-    parser = get_parser(
+    parser = _get_parser(
         search_file.search_string,
         platform=search_file.platform,
         search_field_general=search_file.search_field,