robotcode-analyze 0.97.0__tar.gz → 0.99.0__tar.gz

{robotcode_analyze-0.97.0 → robotcode_analyze-0.99.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotcode-analyze
-Version: 0.97.0
+Version: 0.99.0
 Summary: RobotCode analyze plugin for Robot Framework
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -24,9 +24,9 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
-Requires-Dist: robotcode-plugin==0.97.0
-Requires-Dist: robotcode-robot==0.97.0
-Requires-Dist: robotcode==0.97.0
+Requires-Dist: robotcode-plugin==0.99.0
+Requires-Dist: robotcode-robot==0.99.0
+Requires-Dist: robotcode==0.99.0
 Requires-Dist: robotframework>=4.1.0
 Description-Content-Type: text/markdown
 

{robotcode_analyze-0.97.0 → robotcode_analyze-0.99.0}/pyproject.toml

@@ -27,9 +27,9 @@ classifiers = [
 ]
 dependencies = [
   "robotframework>=4.1.0",
-  "robotcode-plugin==0.97.0",
-  "robotcode-robot==0.97.0",
-  "robotcode==0.97.0",
+  "robotcode-plugin==0.99.0",
+  "robotcode-robot==0.99.0",
+  "robotcode==0.99.0",
 ]
 dynamic = ["version"]
 

robotcode_analyze-0.99.0/src/robotcode/analyze/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.99.0"

{robotcode_analyze-0.97.0 → robotcode_analyze-0.99.0}/src/robotcode/analyze/cli.py

@@ -1,10 +1,10 @@
+from enum import Flag
 from pathlib import Path
 from textwrap import indent
 from typing import List, Optional, Set, Tuple
 
 import click
 
-from robotcode.analyze.config import AnalyzeConfig
 from robotcode.core.lsp.types import Diagnostic, DiagnosticSeverity
 from robotcode.core.text_document import TextDocument
 from robotcode.core.uri import Uri
@@ -18,6 +18,7 @@ from robotcode.robot.config.utils import get_config_files
 
 from .__version__ import __version__
 from .code_analyzer import CodeAnalyzer, DocumentDiagnosticReport, FolderDiagnosticReport
+from .config import AnalyzeConfig, ModifiersConfig
 
 
 @click.group(
@@ -45,6 +46,14 @@ SEVERITY_COLORS = {
 }
 
 
+class ReturnCode(Flag):
+    SUCCESS = 0
+    ERRORS = 1
+    WARNINGS = 2
+    INFOS = 4
+    HINTS = 8
+
+
 class Statistic:
     def __init__(self) -> None:
         self.folders: Set[WorkspaceFolder] = set()
@@ -60,6 +69,18 @@ class Statistic:
             f"Infos: {self.infos}, Hints: {self.hints}"
         )
 
+    def calculate_return_code(self) -> ReturnCode:
+        return_code = ReturnCode.SUCCESS
+        if self.errors > 0:
+            return_code |= ReturnCode.ERRORS
+        if self.warnings > 0:
+            return_code |= ReturnCode.WARNINGS
+        if self.infos > 0:
+            return_code |= ReturnCode.INFOS
+        if self.hints > 0:
+            return_code |= ReturnCode.HINTS
+        return return_code
+
 
 @analyze.command(
     add_help_option=True,
@@ -105,22 +126,88 @@ class Statistic:
     help="Additional locations where to search test libraries"
     " and other extensions when they are imported. see `robot --pythonpath` option.",
 )
+@click.option(
+    "-mi",
+    "--modifiers-ignore",
+    metavar="CODE",
+    type=str,
+    multiple=True,
+    help="Specifies the diagnostics codes to ignore.",
+)
+@click.option(
+    "-me",
+    "--modifiers-error",
+    metavar="CODE",
+    type=str,
+    multiple=True,
+    help="Specifies the diagnostics codes to treat as errors.",
+)
+@click.option(
+    "-mw",
+    "--modifiers-warning",
+    metavar="CODE",
+    type=str,
+    multiple=True,
+    help="Specifies the diagnostics codes to treat as warning.",
+)
+@click.option(
+    "-mI",
+    "--modifiers-information",
+    metavar="CODE",
+    type=str,
+    multiple=True,
+    help="Specifies the diagnostics codes to treat as information.",
+)
+@click.option(
+    "-mh",
+    "--modifiers-hint",
+    metavar="CODE",
+    type=str,
+    multiple=True,
+    help="Specifies the diagnostics codes to treat as hint.",
+)
 @click.argument(
     "paths", nargs=-1, type=click.Path(exists=True, dir_okay=True, file_okay=True, readable=True, path_type=Path)
 )
 @pass_application
 def code(
     app: Application,
-    filter: Tuple[str],
+    filter: Tuple[str, ...],
     variable: Tuple[str, ...],
     variablefile: Tuple[str, ...],
     pythonpath: Tuple[str, ...],
+    modifiers_ignore: Tuple[str, ...],
+    modifiers_error: Tuple[str, ...],
+    modifiers_warning: Tuple[str, ...],
+    modifiers_information: Tuple[str, ...],
+    modifiers_hint: Tuple[str, ...],
     paths: Tuple[Path],
 ) -> None:
     """\
-        Performs static code analysis to detect syntax errors, missing keywords or variables,
-        missing arguments, and more on the given *PATHS*. *PATHS* can be files or directories.
-        If no PATHS are given, the current directory is used.
+        Performs static code analysis to identify potential issues in the specified *PATHS*. The analysis detects syntax
+        errors, missing keywords or variables, missing arguments, and other problems.
+
+        - **PATHS**: Can be individual files or directories. If no *PATHS* are provided, the current directory is
+          analyzed by default.
+
+        The return code is a bitwise combination of the following values:
+
+        \b
+        - `0`: **SUCCESS** - No issues detected.
+        - `1`: **ERRORS** - Critical issues found.
+        - `2`: **WARNINGS** - Non-critical issues detected.
+        - `4`: **INFORMATIONS** - General information messages.
+        - `8`: **HINTS** - Suggestions or improvements.
+
+        \b
+        *Examples*:
+        ```
+        robotcode analyze code
+        robotcode analyze code --filter **/*.robot
+        robotcode analyze code tests/acceptance/first.robot
+        robotcode analyze code -mi DuplicateKeyword tests/acceptance/first.robot
+        robotcode --format json analyze code
+        ```
     """
 
     config_files, root_folder, _ = get_config_files(
@@ -162,6 +249,34 @@ def code(
             for vf in variablefile:
                 robot_profile.variable_files.append(vf)
 
+        if analyzer_config.modifiers is None:
+            analyzer_config.modifiers = ModifiersConfig()
+
+        if modifiers_ignore:
+            if analyzer_config.modifiers.ignore is None:
+                analyzer_config.modifiers.ignore = []
+            analyzer_config.modifiers.ignore.extend(modifiers_ignore)
+
+        if modifiers_error:
+            if analyzer_config.modifiers.error is None:
+                analyzer_config.modifiers.error = []
+            analyzer_config.modifiers.error.extend(modifiers_error)
+
+        if modifiers_warning:
+            if analyzer_config.modifiers.warning is None:
+                analyzer_config.modifiers.warning = []
+            analyzer_config.modifiers.warning.extend(modifiers_warning)
+
+        if modifiers_information:
+            if analyzer_config.modifiers.information is None:
+                analyzer_config.modifiers.information = []
+            analyzer_config.modifiers.information.extend(modifiers_information)
+
+        if modifiers_hint:
+            if analyzer_config.modifiers.hint is None:
+                analyzer_config.modifiers.hint = []
+            analyzer_config.modifiers.hint.extend(modifiers_hint)
+
         statistics = Statistic()
         for e in CodeAnalyzer(
             app=app,
@@ -190,7 +305,7 @@ def code(
 
         app.echo(statistics_str)
 
-        app.exit(statistics.errors)
+        app.exit(statistics.calculate_return_code().value)
 
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e
@@ -223,7 +338,7 @@ def _print_diagnostics(
                     + (f"{item.range.start.line + 1}:{item.range.start.character + 1}: " if print_range else " ")
                 )
                 if folder_path and folder_path != root_folder
-                else " "
+                else ""
             )
             + click.style(f"[{severity.name[0]}] {item.code}", fg=SEVERITY_COLORS[severity])
             + f": {indent(item.message, prefix='  ').strip()}",

{robotcode_analyze-0.97.0 → robotcode_analyze-0.99.0}/src/robotcode/analyze/code_analyzer.py

@@ -122,7 +122,7 @@ class CodeAnalyzer(DiagnosticsContext):
                         if item is None:
                             continue
                         elif isinstance(item, BaseException):
-                            self.app.error(f"Error analyzing {document.uri.to_path()}: {item}")
+                            self.app.error(f"Error collecting diagnostics for {document.uri.to_path()}: {item}")
                         else:
                             diagnostics.extend(item)
                     if diagnostics:

{robotcode_analyze-0.97.0 → robotcode_analyze-0.99.0}/src/robotcode/analyze/config.py

@@ -17,7 +17,7 @@ class ModifiersConfig(BaseOptions):
 
     ignore: Optional[List[str]] = field(
         description="""\
-            Specifies the error codes to ignore.
+            Specifies the diagnostics codes to ignore.
 
             Examples:
 
@@ -29,7 +29,7 @@ class ModifiersConfig(BaseOptions):
     )
     extend_ignore: Optional[List[str]] = field(
         description="""
-            Extend the error codes to ignore.
+            Extend the diagnostics codes to ignore.
 
             Examples:
 
@@ -41,7 +41,7 @@ class ModifiersConfig(BaseOptions):
     )
     error: Optional[List[str]] = field(
         description="""
-            Specifies the error codes to treat as errors.
+            Specifies the diagnostics codes to treat as errors.
 
             Examples:
 
@@ -53,7 +53,7 @@ class ModifiersConfig(BaseOptions):
     )
     extend_error: Optional[List[str]] = field(
         description="""
-            Extend the error codes to treat as errors.
+            Extend the diagnostics codes to treat as errors.
 
             Examples:
 
@@ -65,7 +65,7 @@ class ModifiersConfig(BaseOptions):
     )
     warning: Optional[List[str]] = field(
         description="""
-            Specifies the error codes to treat as warning.
+            Specifies the diagnostics codes to treat as warning.
 
             Examples:
 
@@ -77,7 +77,7 @@ class ModifiersConfig(BaseOptions):
     )
     extend_warning: Optional[List[str]] = field(
         description="""
-            Extend the error codes to treat as warnings.
+            Extend the diagnostics codes to treat as warning.
 
             Examples:
 
@@ -89,7 +89,7 @@ class ModifiersConfig(BaseOptions):
     )
     information: Optional[List[str]] = field(
         description="""
-            Specifies the error codes to treat as information.
+            Specifies the diagnostics codes to treat as information.
 
             Examples:
 
@@ -101,7 +101,7 @@ class ModifiersConfig(BaseOptions):
     )
     extend_information: Optional[List[str]] = field(
         description="""
-            Extend the error codes to treat as information.
+            Extend the diagnostics codes to treat as information.
 
             Examples:
 
@@ -113,7 +113,7 @@ class ModifiersConfig(BaseOptions):
     )
     hint: Optional[List[str]] = field(
         description="""
-            Specifies the error codes to treat as hint.
+            Specifies the diagnostics codes to treat as hint.
 
             Examples:
 
@@ -125,7 +125,7 @@ class ModifiersConfig(BaseOptions):
     )
     extend_hint: Optional[List[str]] = field(
         description="""
-            Extend the error codes to treat as hint.
+            Extend the diagnostics codes to treat as hint.
 
             Examples:
 

robotcode_analyze-0.97.0/src/robotcode/analyze/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.97.0"