Initial Commit

Author: qerdinger

.gitignore

@@ -0,0 +1,3 @@
+.venv
+__pycache__
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Quentin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# Node Modules Visualizer
+
+![Alt text](docs/visualizer.jpg?raw=true "Node modules Visualizer")
+
+## What we need to do to make it work
+
+## Requirements : 
+Have python [3.X] installed.
+
+
+## Install pip requirements
+> pip install -r requirements.txt
+
+## Run the visualizer
+> python3 visualizer.py [PATH]
+
+## Compatibility
+
+| Operating System         | Version needed |
+| :---:                    | :---:          |
+| Windows 10/11            |     1.0 |
+| MacOS / Linux            |     1.0 |
+
+## Copyrights
+
+```text
+Copyrights EQ-0 - 2023, All Rights Reserved
+
+   __ ___________________            _______    __   
+  / / \_   _____/\_____  \           \   _  \   \ \  
+ / /   |    __)_  /  / \  \   ______ /  /_\  \   \ \ 
+ \ \   |        \/   \_/.  \ /_____/ \  \_/   \  / / 
+  \_\ /_______  /\_____\ \_/          \_____  / /_/  
+              \/        \__>                \/       
+```
+

docs/visualizer.jpg

@@ -0,0 +1,4 @@
+markdown-it-py==3.0.0
+mdurl==0.1.2
+Pygments==2.15.1
+rich==13.4.2

requirements.txt

@@ -0,0 +1,66 @@
+import os
+import time
+
+from rich.progress import (
+    BarColumn,
+    MofNCompleteColumn,
+    Progress,
+    TextColumn,
+    TimeElapsedColumn,
+    TimeRemainingColumn,
+)
+
+class Scan:
+    def __init__(self, path="."):
+        self.path = path
+        self.size = 0
+        self.files = 0
+        self.folders = 0
+        self.results = []
+    
+    def convert_size(self, size_in_bytes):
+        units = ["B", "KB", "MB", "GB", "TB"]
+        unit_index = 0
+
+        while size_in_bytes >= 1024 and unit_index < len(units) - 1:
+            size_in_bytes /= 1024
+            unit_index += 1
+
+        return f"{size_in_bytes:.2f} {units[unit_index]}"
+    
+    def scan(self, target="", console=None):
+        console.print(f"[bold green]Indexing files/folders {self.path} for {target}...[/bold green]")
+        directories = list(os.walk(self.path))
+        with Progress() as progress:
+            task = progress.add_task("[cyan]Scanning directories...", total=len(directories), console=console)
+
+            for root, dirs, files in directories:
+                for dir in dirs:
+                    if dir == target:
+                        dir_path = os.path.join(root, dir)
+                        dir_size = os.path.getsize(dir_path)
+                        converted_size = self.convert_size(dir_size)
+
+                        self.results.append((root, dir_path, converted_size))
+                        self.size += dir_size
+                        self.folders += 1
+                        continue
+                time.sleep(0.00001)
+                progress.advance(task)  # Update the progress bar
+
+        return self
+    
+    def get_size(self):
+        return self.size
+    
+    def get_files(self):
+        return self.files
+    
+    def get_folders(self):
+        return self.folders
+    
+    def get_results(self):
+        return self.results
+    
+    def get_path(self):
+        return self.path

scan.py

@@ -0,0 +1,28 @@
+import sys
+from rich.console import Console
+from rich.table import Table
+from rich.progress import track
+from time import sleep
+
+from scan import Scan
+
+PATH = sys.argv[1] if len(sys.argv) > 1 else "." # Get the path from the command line arguments
+CONSOLE = Console() # Create a console
+
+scanner = Scan(PATH) # Scan the current directory
+
+scanner.scan(target="node_modules", console=CONSOLE) # Scan the directory
+
+table = Table(title="Node Visualizer") # Create a table with a title
+
+table.add_column("Project Name", justify="center", style="cyan")
+table.add_column("Path", justify="center", style="magenta")
+table.add_column("Size", justify="center", style="green")
+
+for result in scanner.results:
+    table.add_row(result[0], result[1], result[2]) # Add a row to the table
+
+CONSOLE.print(table, justify="center") # Print the tables
+
+CONSOLE.print(f"Possible reclaimed size on disk 💾 : [bold green]{scanner.convert_size(scanner.size)}", justify="center") # Print a message
+CONSOLE.print(f"Total node_modules folders 📁 : [bold green]{scanner.folders}", justify="center") # Print a message