mvn-tree-visualizer 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

mvn_tree_visualizer/cli.py

@@ -1,5 +1,6 @@
 import argparse
 from pathlib import Path
+from typing import NoReturn
 
 from .diagram import create_diagram
 from .get_dependencies_in_one_file import merge_files
@@ -7,7 +8,7 @@ from .outputs.html_output import create_html_diagram
 from .outputs.json_output import create_json_output
 
 
-def cli():
+def cli() -> NoReturn:
     parser = argparse.ArgumentParser(
         prog="mvn-tree-visualizer",
         description="Generate a dependency diagram from a file.",
@@ -50,12 +51,19 @@ def cli():
         help="Keep the dependency tree file after generating the diagram. Default is False.",
     )
 
+    parser.add_argument(
+        "--show-versions",
+        action="store_true",
+        help="Show dependency versions in the diagram. Applicable to both HTML and JSON output formats.",
+    )
+
     args = parser.parse_args()
     directory: str = args.directory
     output_file: str = args.output
     filename: str = args.filename
     keep_tree: bool = args.keep_tree
     output_format: str = args.format
+    show_versions: bool = args.show_versions
 
     dir_to_create_files = Path(output_file).parent
 
@@ -73,9 +81,9 @@ def cli():
     )
 
     if output_format == "html":
-        create_html_diagram(dependency_tree, output_file)
+        create_html_diagram(dependency_tree, output_file, show_versions)
     elif output_format == "json":
-        create_json_output(dependency_tree, output_file)
+        create_json_output(dependency_tree, output_file, show_versions)
 
     print(f"Diagram generated and saved to {output_file}")
     print("You can open it in your browser to view the dependency tree.")
@@ -83,4 +91,4 @@ def cli():
 
 
 if __name__ == "__main__":
-    cli()
+    cli()

mvn_tree_visualizer/diagram.py

@@ -1,13 +1,14 @@
+import os
+
+
 def create_diagram(
     keep_tree: bool = False,
     intermediate_filename: str = "dependency_tree.txt",
-):
+) -> str:
     with open(intermediate_filename, "r") as file:
-        dependency_tree = file.read()
+        dependency_tree: str = file.read()
 
     if not keep_tree:
-        import os
-
         os.remove(intermediate_filename)
-    
+
     return dependency_tree

mvn_tree_visualizer/get_dependencies_in_one_file.py

@@ -1,11 +1,13 @@
 import os
+from pathlib import Path
+from typing import Union
 
 
-def merge_files(output_file: str, root_dir: str = ".", target_filename: str = "maven_dependency_file"):
+def merge_files(output_file: Union[str, Path], root_dir: str = ".", target_filename: str = "maven_dependency_file") -> None:
     with open(output_file, "w", encoding="utf-8") as outfile:
         for dirpath, _, filenames in os.walk(root_dir):
             for fname in filenames:
                 if fname == target_filename:
-                    file_path = os.path.join(dirpath, fname)
+                    file_path: str = os.path.join(dirpath, fname)
                     with open(file_path, "r", encoding="utf-8") as infile:
                         outfile.write(infile.read())

mvn_tree_visualizer/outputs/html_output.py

@@ -1,49 +1,65 @@
 from pathlib import Path
+from typing import List, Set, Tuple
+
 from jinja2 import BaseLoader, Environment
+
 from ..TEMPLATE import HTML_TEMPLATE
 
-def create_html_diagram(dependency_tree: str, output_filename: str):
-    mermaid_diagram = _convert_to_mermaid(dependency_tree)
+
+def create_html_diagram(dependency_tree: str, output_filename: str, show_versions: bool = False) -> None:
+    mermaid_diagram: str = _convert_to_mermaid(dependency_tree, show_versions)
     template = Environment(loader=BaseLoader).from_string(HTML_TEMPLATE)
-    rendered = template.render(diagram_definition=mermaid_diagram)
-    parent_dir = Path(output_filename).parent
+    rendered: str = template.render(diagram_definition=mermaid_diagram)
+    parent_dir: Path = Path(output_filename).parent
     if not parent_dir.exists():
         parent_dir.mkdir(parents=True, exist_ok=True)
     with open(output_filename, "w") as f:
         f.write(rendered)
 
-def _convert_to_mermaid(dependency_tree: str) -> str:
+
+def _convert_to_mermaid(dependency_tree: str, show_versions: bool = False) -> str:
     # generate a `graph LR` format for Mermaid
-    lines = dependency_tree.strip().split("\n")
-    mermaid_lines = set()
-    previous_dependency = []
+    lines: List[str] = dependency_tree.strip().split("\n")
+    mermaid_lines: Set[str] = set()
+    previous_dependency: List[Tuple[str, int]] = []
     for line in lines:
         if not line:
             continue
         if line.startswith("[INFO] "):
             line = line[7:]  # Remove the "[INFO] " prefix
-        parts = line.split(":")
+        parts: List[str] = line.split(":")
         if len(parts) < 3:
             continue
         if len(parts) == 4:
             group_id, artifact_id, app, version = parts
-            mermaid_lines.add(f"\t{artifact_id};")
+            if show_versions:
+                node_label: str = f"{artifact_id}:{version}"
+                mermaid_lines.add(f"\t{node_label};")
+            else:
+                node_label: str = artifact_id
+                mermaid_lines.add(f"\t{artifact_id};")
             if previous_dependency:  # Re initialize the list if it wasn't empty
                 previous_dependency = []
-            previous_dependency.append((artifact_id, 0))  # The second element is the depth
+            previous_dependency.append((node_label, 0))  # The second element is the depth
         else:
-            depth = len(parts[0].split(" ")) - 1
+            depth: int = len(parts[0].split(" ")) - 1
             if len(parts) == 6:
                 dirty_group_id, artifact_id, app, ejb_client, version, dependency = parts
             else:
                 dirty_group_id, artifact_id, app, version, dependency = parts
+
+            if show_versions:
+                node_label: str = f"{artifact_id}:{version}"
+            else:
+                node_label: str = artifact_id
+
             if previous_dependency[-1][1] < depth:
-                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
-                previous_dependency.append((artifact_id, depth))
+                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {node_label};")
+                previous_dependency.append((node_label, depth))
             else:
                 # remove all dependencies that are deeper or equal to the current depth
                 while previous_dependency and previous_dependency[-1][1] >= depth:
                     previous_dependency.pop()
-                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
-                previous_dependency.append((artifact_id, depth))
+                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {node_label};")
+                previous_dependency.append((node_label, depth))
     return "graph LR\n" + "\n".join(mermaid_lines)

mvn_tree_visualizer/outputs/json_output.py

@@ -1,9 +1,11 @@
 import json
+from typing import Any, Dict, List, Tuple
 
-def create_json_output(dependency_tree: str, output_filename: str):
-    lines = dependency_tree.strip().split("\n")
-    tree = {}
-    node_stack = []  # Stack to keep track of nodes and their depth
+
+def create_json_output(dependency_tree: str, output_filename: str, show_versions: bool = False) -> None:
+    lines: List[str] = dependency_tree.strip().split("\n")
+    tree: Dict[str, Any] = {}
+    node_stack: List[Tuple[Dict[str, Any], int]] = []  # Stack to keep track of nodes and their depth
 
     for line in lines:
         if not line:
@@ -11,33 +13,43 @@ def create_json_output(dependency_tree: str, output_filename: str):
         if line.startswith("[INFO] "):
             line = line[7:]  # Remove the "[INFO] " prefix
 
-        parts = line.split(":")
+        parts: List[str] = line.split(":")
         if len(parts) < 3:
             continue
 
         # Root node
         if len(parts) == 4:
             group_id, artifact_id, _, version = parts
-            node = {"id": f"{group_id}:{artifact_id}:{version}", "children": []}
+            if show_versions:
+                node_id: str = f"{group_id}:{artifact_id}:{version}"
+            else:
+                node_id: str = f"{group_id}:{artifact_id}"
+            node: Dict[str, Any] = {"id": node_id, "children": []}
             tree = node
             node_stack = [(node, 0)]  # Reset stack with root node at depth 0
         # Child node
         else:
             # This depth calculation is based on the mermaid logic's whitespace parsing
-            depth = len(parts[0].split(" ")) - 1
+            depth: int = len(parts[0].split(" ")) - 1
 
             if len(parts) == 6:
                 _, artifact_id, _, _, version, _ = parts
             else:
                 _, artifact_id, _, version, _ = parts
 
-            node = {"id": f"{artifact_id}:{version}", "children": []}
+            if show_versions:
+                node_id: str = f"{artifact_id}:{version}"
+            else:
+                node_id: str = artifact_id
+
+            node: Dict[str, Any] = {"id": node_id, "children": []}
 
             # Go up the stack to find the correct parent
             while node_stack and node_stack[-1][1] >= depth:
                 node_stack.pop()
 
             if node_stack:
+                parent_node: Dict[str, Any]
                 parent_node, _ = node_stack[-1]
                 parent_node["children"].append(node)
 

{mvn_tree_visualizer-1.1.0.dist-info → mvn_tree_visualizer-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mvn-tree-visualizer
-Version: 1.1.0
+Version: 1.2.0
 Summary: A simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
 Project-URL: source, https://github.com/dyka3773/mvn-tree-visualizer
 Author-email: Iraklis Konsoulas <dyka3773@gmail.com>
@@ -12,6 +12,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Build Tools
+Classifier: Typing :: Typed
 Requires-Python: >=3.13
 Requires-Dist: jinja2>=3.1.6
 Description-Content-Type: text/markdown
@@ -22,11 +23,14 @@ Description-Content-Type: text/markdown
 
 A simple command-line tool to visualize the dependency tree of a Maven project in a graphical and interactive format.
 
-This tool was born out of the frustration of not being able to easily visualize the dependency tree of a Maven project. The `mvn dependency:tree` command is great, but the output can be hard to read, especially for large projects. This tool aims to solve that problem by providing a simple way to generate an interactive diagram of the dependency tree.
+This tool was born out of the frustration of not being able to easily visualize the dependency tree of a Maven project. The `mvn dependency:tree` command is great, but the output can be hard to read, especially for large projects. This tool aims to solve that problem by providing a simple way to generate an interactive diagram or a structured JSON output of the dependency tree.
 
 ## Features
 
-*   **Interactive Diagrams:** Generates an interactive HTML diagram of your dependency tree using Mermaid.js.
+*   **Multiple Output Formats:**
+    *   **HTML:** Generates an interactive HTML diagram of your dependency tree using Mermaid.js.
+    *   **JSON:** Creates a structured JSON representation of the dependency tree, perfect for scripting or integration with other tools.
+*   **Version Display:** Show or hide dependency versions in both HTML and JSON outputs using the `--show-versions` flag.
 *   **Easy to Use:** A simple command-line interface that gets the job done with minimal configuration.
 *   **File Merging:** Automatically finds and merges multiple `maven_dependency_file` files from different subdirectories.
 *   **Customizable Output:** Specify the output file name and location.
@@ -45,17 +49,36 @@ This tool was born out of the frustration of not being able to easily visualize
 2.  **Visualize the dependency tree:**
     Use the `mvn-tree-visualizer` command to generate the diagram.
 
+    **For an HTML diagram:**
     ```bash
-    mvn_tree_visualizer --filename "maven_dependency_file" --output "diagram.html"
+    mvn_tree_visualizer --filename "maven_dependency_file" --output "diagram.html" --format html
     ```
 
-3.  **View the diagram:**
-    Open the generated `diagram.html` file in your web browser to view the interactive dependency tree.
+    **For a JSON output:**
+    ```bash
+    mvn_tree_visualizer --filename "maven_dependency_file" --output "dependencies.json" --format json
+    ```
+
+    **With version information displayed:**
+    ```bash
+    mvn_tree_visualizer --filename "maven_dependency_file" --output "diagram.html" --show-versions
+    ```
+
+    **JSON output with versions:**
+    ```bash
+    mvn_tree_visualizer --filename "maven_dependency_file" --output "dependencies.json" --format json --show-versions
+    ```
+
+3.  **View the output:**
+    *   Open the generated `diagram.html` file in your web browser to view the interactive dependency tree.
+    *   Use the `dependencies.json` file in your scripts or other tools.
 
 ## Options
 
 *   `--filename`: The name of the file containing the Maven dependency tree. Defaults to `maven_dependency_file`.
-*   `--output`: The name of the output HTML file. Defaults to `diagram.html`.
+*   `--output`: The name of the output file. Defaults to `diagram.html`.
+*   `--format`: The output format. Can be `html` or `json`. Defaults to `html`.
+*   `--show-versions`: Show dependency versions in the diagram. Applicable to both HTML and JSON output formats.
 *   `--directory`: The directory to scan for the Maven dependency file(s). Defaults to the current directory.
 *   `--keep-tree`: Keep the intermediate `dependency_tree.txt` file after generating the diagram. Defaults to `False`.
 *   `--help`: Show the help message and exit.
@@ -68,4 +91,4 @@ Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for more details.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

mvn_tree_visualizer-1.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+mvn_tree_visualizer/TEMPLATE.py,sha256=WIQfSNBygUZVkBrERq7QzqouGURA0NYVqUUm-11wMvo,2499
+mvn_tree_visualizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mvn_tree_visualizer/__main__.py,sha256=yIQFAdWjthKAFbSzzRuz5_YGlK0c6BnR2ypjNRDq180,82
+mvn_tree_visualizer/cli.py,sha256=Pygjrz87rge2Bfpy1ePucjER8PL2ZP1fBJCRax4otqo,2761
+mvn_tree_visualizer/diagram.py,sha256=8If6rNbyBZlM_BkQwpGTE3W3bHHxcJ_5MMBc2NnJZWM,313
+mvn_tree_visualizer/get_dependencies_in_one_file.py,sha256=1UQUWny5t5QLbE2HOkK_BXSIU3BP7Qjx8mo6yEhMFi4,580
+mvn_tree_visualizer/outputs/html_output.py,sha256=QwUZRzNUCKrpdOq6BHadIJSU47W_1Kat-ouzwue-olA,2857
+mvn_tree_visualizer/outputs/json_output.py,sha256=49X02e3gNoKzBj2FYGKOwuyaX0s5pxWIQUZPruCTbTQ,2064
+mvn_tree_visualizer-1.2.0.dist-info/METADATA,sha256=ZJNzw2z2zRItzBof4tFGrotsBL7SBumgaranNor4BWc,4603
+mvn_tree_visualizer-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mvn_tree_visualizer-1.2.0.dist-info/entry_points.txt,sha256=Mu3QZhrlvbYuCxqmluVGi2efgKjkQY6T8Opf-vdb7hU,68
+mvn_tree_visualizer-1.2.0.dist-info/licenses/LICENSE,sha256=4zi6unpe17RUDMBu7ebh14jdbyvyeT-UA3n8Zl7aW74,1075
+mvn_tree_visualizer-1.2.0.dist-info/RECORD,,

mvn_tree_visualizer-1.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-mvn_tree_visualizer/TEMPLATE.py,sha256=WIQfSNBygUZVkBrERq7QzqouGURA0NYVqUUm-11wMvo,2499
-mvn_tree_visualizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mvn_tree_visualizer/__main__.py,sha256=yIQFAdWjthKAFbSzzRuz5_YGlK0c6BnR2ypjNRDq180,82
-mvn_tree_visualizer/cli.py,sha256=P3v27Axod-aYkhtnoAh06RnScUTR2k9QZ3vVGkolHg8,2451
-mvn_tree_visualizer/diagram.py,sha256=elUQHCFu9DPeCpcLkjlRg-xl-fAEn8TvMWpIho1vo0E,312
-mvn_tree_visualizer/get_dependencies_in_one_file.py,sha256=sX669Lo3gsv-dTvaf4PNSQMTp3Gx3CKwqBmJQFiQF04,504
-mvn_tree_visualizer/outputs/html_output.py,sha256=rCD55g8aUdYiPs2Mkd9VB0dBKvMZu0Va3uYGZkJxO20,2295
-mvn_tree_visualizer/outputs/json_output.py,sha256=v9aRPaCDMG-zyVdg82YPhPRyFCNLaWXPcdRmnpzuajg,1554
-mvn_tree_visualizer-1.1.0.dist-info/METADATA,sha256=VmIy1sZ1XHWlqnXJwzFKuG1Z3yxqZ2YV7OlEPaNvIuM,3470
-mvn_tree_visualizer-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mvn_tree_visualizer-1.1.0.dist-info/entry_points.txt,sha256=Mu3QZhrlvbYuCxqmluVGi2efgKjkQY6T8Opf-vdb7hU,68
-mvn_tree_visualizer-1.1.0.dist-info/licenses/LICENSE,sha256=4zi6unpe17RUDMBu7ebh14jdbyvyeT-UA3n8Zl7aW74,1075
-mvn_tree_visualizer-1.1.0.dist-info/RECORD,,