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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotcode-analyze
-Version: 0.98.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.98.0
-Requires-Dist: robotcode-robot==0.98.0
-Requires-Dist: robotcode==0.98.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.98.0 → robotcode_analyze-0.99.0}/pyproject.toml

@@ -27,9 +27,9 @@ classifiers = [
 ]
 dependencies = [
   "robotframework>=4.1.0",
-  "robotcode-plugin==0.98.0",
-  "robotcode-robot==0.98.0",
-  "robotcode==0.98.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.98.0 → robotcode_analyze-0.99.0}/src/robotcode/analyze/cli.py

@@ -1,3 +1,4 @@
+from enum import Flag
 from pathlib import Path
 from textwrap import indent
 from typing import List, Optional, Set, Tuple
@@ -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,
@@ -151,7 +172,7 @@ class Statistic:
 @pass_application
 def code(
     app: Application,
-    filter: Tuple[str],
+    filter: Tuple[str, ...],
     variable: Tuple[str, ...],
     variablefile: Tuple[str, ...],
     pythonpath: Tuple[str, ...],
@@ -163,12 +184,23 @@ def code(
     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:
+        *Examples*:
         ```
         robotcode analyze code
         robotcode analyze code --filter **/*.robot
@@ -273,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

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

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