Add new command: impact

swiftyfinch · Apr 8, 2024 · 6546743 · 6546743
1 parent 7533dc5
commit 6546743
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -36,19 +36,21 @@ Right now, it supports the following inputs:
 > xtree --help
 
  🌳 Printing and analyzing trees in a handy way.
-╭─────────────┬────────────────────────────────────────────╮
-│ > print     │ * Print a tree with children statistics.   │
-│ > frequency │ * Calculate a frequency of each node.      │
-│ > parents   │ * Find all parents of nodes.               │
-│ > update    │ * Download and install the latest version. │
-│             │                                            │
-│ --version   │ * Show the version.                        │
-│ --help, -h  │ * Show help information.                   │
-╰─────────────┴────────────────────────────────────────────╯
+╭─────────────┬────────────────────────────────────────────────────────────╮
+│ > print     │ * Print a tree with children statistics.                   │
+│ > frequency │ * Calculate a frequency of each node.                      │
+│ > parents   │ * Find all parents of nodes.                               │
+│ > impact    │ * Find affected parent nodes and print them out as a tree. │
+│ > update    │ * Download and install the latest version.                 │
+│             │                                                            │
+│ --version   │ * Show the version.                                        │
+│ --help, -h  │ * Show help information.                                   │
+╰─────────────┴────────────────────────────────────────────────────────────╯
 ```
 - [`print`](docs/commands-help/print.md)
 - [`frequency`](docs/commands-help/frequency.md)
 - [`parents`](docs/commands-help/parents.md)
+- [`impact`](docs/commands-help/impact.md)
 
 <br>
 

diff --git a/Sources/XTree/CLI/Commands/Impact.swift b/Sources/XTree/CLI/Commands/Impact.swift
@@ -4,7 +4,11 @@ extension XTree {
     struct Impact: AsyncParsableCommand {
         static var configuration = CommandConfiguration(
             commandName: "impact",
-            abstract: "Find affected parent nodes and print them out as a tree."
+            abstract: "Find affected parent nodes and print them out as a tree.",
+            discussion: """
+            \("Each node can contain:".accent)
+            \("╰─ Name".accent) \("height:explicit_children/children".white.secondary) \("info?".tertiary)
+            """
         )
 
         @OptionGroup

diff --git a/docs/commands-help/impact.md b/docs/commands-help/impact.md
@@ -0,0 +1,33 @@
+```sh
+> xtree impact --help
+
+ 🌳 Find affected parent nodes and print them out as a tree.
+    Each node can contain:
+    ╰─ Name height:explicit_children/children info?
+╭───────────────────┬────────────────────────────────────────────────────────────╮
+│ --input, -i       │ * (require) The path to the suitable file (*.xcodeproj,    │
+│                   │   Podfile.lock, *.yml/*.yaml), which will be the tree      │
+│                   │   input source.                                            │
+│ --names, -n []    │ * The names of the nodes that will be the leaves of the    │
+│                   │   tree.                                                    │
+│ --roots, -r []    │ * Keep only subtrees where the root node contains the      │
+│                   │   passed string with wildcards (*, ?).                     │
+│ --contains, -c [] │ * Keep only the nodes that contain the passed strings with │
+│                   │   wildcards (*, ?).                                        │
+│ --except, -e []   │ * Exclude nodes that contain any of the passed strings     │
+│                   │   with wildcards (*, ?).                                   │
+│ --depth, -d       │ * Limit the maximum depth of the tree.                     │
+│ --sort, -s        │ * Select the sorting method: by name, by number of         │
+│                   │   children or by height.                                   │
+│                   │                                                            │
+│ --help, -h        │ * Show help information.                                   │
+╰───────────────────┴────────────────────────────────────────────────────────────╯
+```
+
+## Example
+
+```sh
+> xtree impact -n Alamofire --input example.yaml
+```
+
+<img width="260" src="https://github.com/swiftyfinch/xtree/assets/64660122/de327838-ad62-4427-8e86-e1f00221c17c">