troubadix 24.8.2__tar.gz → 24.9.1__tar.gz

{troubadix-24.8.2 → troubadix-24.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.8.2
+Version: 24.9.1
 Summary: A linting and QA check tool for NASL files
 Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later
@@ -44,9 +44,19 @@ A linting and QA check tool for NASL files
 
 Python 3.9 and later is supported.
 
+### Install using pipx
+
+You can install the latest stable release of **troubadix** from the Python
+Package Index (pypi) using [pipx]
+
+    python3 -m pipx install troubadix
+
 ### Install using pip
 
-pip 19.0 or later is required.
+> [!NOTE]
+> The `pip install` command does no longer work out-of-the-box in newer
+> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
+> Please use the [installation via pipx](#install-using-pipx) instead.
 
 You can install the latest stable release of **troubadix** from the Python
 Package Index (pypi) using [pip]
@@ -71,9 +81,7 @@ For installation via pipenv please take a look at their [documentation][pipenv].
 **troubadix** uses [poetry] for its own dependency management and build
 process.
 
-First install poetry via pip
-
-    python3 -m pip install --user poetry
+First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).
 
 Afterwards run
 
@@ -113,6 +121,7 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 [Greenbone]: https://www.greenbone.net/
 [poetry]: https://python-poetry.org/
 [pip]: https://pip.pypa.io/
+[pipx]: https://pypa.github.io/pipx/
 [pipenv]: https://pipenv.pypa.io/
 [autohooks]: https://github.com/greenbone/autohooks
 

{troubadix-24.8.2 → troubadix-24.9.1}/README.md

@@ -15,9 +15,19 @@ A linting and QA check tool for NASL files
 
 Python 3.9 and later is supported.
 
+### Install using pipx
+
+You can install the latest stable release of **troubadix** from the Python
+Package Index (pypi) using [pipx]
+
+    python3 -m pipx install troubadix
+
 ### Install using pip
 
-pip 19.0 or later is required.
+> [!NOTE]
+> The `pip install` command does no longer work out-of-the-box in newer
+> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
+> Please use the [installation via pipx](#install-using-pipx) instead.
 
 You can install the latest stable release of **troubadix** from the Python
 Package Index (pypi) using [pip]
@@ -42,9 +52,7 @@ For installation via pipenv please take a look at their [documentation][pipenv].
 **troubadix** uses [poetry] for its own dependency management and build
 process.
 
-First install poetry via pip
-
-    python3 -m pip install --user poetry
+First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).
 
 Afterwards run
 
@@ -84,5 +92,6 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 [Greenbone]: https://www.greenbone.net/
 [poetry]: https://python-poetry.org/
 [pip]: https://pip.pypa.io/
+[pipx]: https://pypa.github.io/pipx/
 [pipenv]: https://pipenv.pypa.io/
 [autohooks]: https://github.com/greenbone/autohooks

{troubadix-24.8.2 → troubadix-24.9.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "24.8.2"
+version = "24.9.1"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"

{troubadix-24.8.2 → troubadix-24.9.1}/tests/plugins/test_script_calls_recommended.py

@@ -67,11 +67,10 @@ class CheckScriptCallsRecommendedTestCase(PluginTestCase):
 
     def test_dependencies_multiline(self):
         content = (
+            # tests group1
             '  script_dependencies("123",\n"456");\n'
-            "  script_require_ports();\n"
-            "  script_require_udp_ports();\n"
-            "  script_require_keys();\n"
-            "  script_mandatory_keys();\n"
+            # tests group2
+            '  script_mandatory_keys("foo",\n"bar");\n'
         )
         fake_context = self.create_file_plugin_context(
             nasl_file=self.path, file_content=content

{troubadix-24.8.2 → troubadix-24.9.1}/troubadix/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "24.8.2"
+__version__ = "24.9.1"

{troubadix-24.8.2 → troubadix-24.9.1}/troubadix/plugins/script_calls_recommended.py

@@ -73,7 +73,9 @@ class CheckScriptCallsRecommended(FileContentPlugin):
         ]
 
         if not _get_special_script_tag_pattern(
-            name=rf"({'|'.join(recommended_many_call)})", value=".*"
+            name=rf"({'|'.join(recommended_many_call)})",
+            value=".*?",
+            flags=re.DOTALL,
         ).search(file_content):
             yield LinterWarning(
                 "VT contains none of the following recommended calls: "

{troubadix-24.8.2 → troubadix-24.9.1}/troubadix/standalone_plugins/file_extensions.py

@@ -34,6 +34,11 @@ def parse_args() -> Namespace:
     parser.add_argument(
         "--ignore-file", type=file_type, help="path to ignore file"
     )
+    parser.add_argument(
+        "--gen-ignore-entries",
+        action="store_true",
+        help="output only newline seperated entries, no header",
+    )
     return parser.parse_args()
 
 
@@ -74,16 +79,23 @@ def check_extensions(args: Namespace) -> List[Path]:
 
 
 def main() -> int:
-    if unwanted_files := check_extensions(parse_args()):
-        print(
-            f"{len(unwanted_files)} "
-            "Files with unwanted file extension were found:"
-        )
+    args = parse_args()
+    unwanted_files = check_extensions(args)
+    if not unwanted_files:
+        return 0
+
+    if args.gen_ignore_entries:
         for file in unwanted_files:
-            print(file)
-        return 1
+            print(file.relative_to(args.dir))
+        return 0
 
-    return 0
+    print(
+        f"{len(unwanted_files)} "
+        "Files with unwanted file extension were found:"
+    )
+    for file in unwanted_files:
+        print(file)
+    return 1
 
 
 if __name__ == "__main__":