Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
osrufung committed Mar 7, 2023
1 parent 23557a7 commit 1ad9f7b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ A Swift CLI tool that generates complexity metrics information from a Cocoapods
- Number of dependant modules
- Compare stats between different branches
- Show stats along the git history
- Show dependant targets

You can read more information about dependency complexity in our Technical article ["How to control your dependencies"](https://tech.xing.com/how-to-control-your-ios-dependencies-7690cc7b1c40).

Expand Down Expand Up @@ -145,6 +146,32 @@ jungle modules --target jungle

```

### Get dependant modules

```shell
OVERVIEW: Outputs a sorted list of targets that depends on the specified one in target

USAGE: jungle dependant --target <target> [--show-only-tests] [<directory-path>]

ARGUMENTS:
<directory-path> Path to the directory where Podfile.lock or Package.swift is located (default: .)

OPTIONS:
--target <target> The target in your Podfile or Package.swift file to be used
--show-only-tests Show only Test targets
--version Show the version.
-h, --help Show help information.

```

Example:

```shell
jungle dependant --target SamplePackage $HOME/Desktop/SamplePackage

Library, LibraryTests, SamplePackageTests


### Visualize Complexity Graphs

```shell
Expand Down
2 changes: 1 addition & 1 deletion Sources/jungle/Commands/Main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ struct Jungle: AsyncParsableCommand {
static var configuration = CommandConfiguration(
commandName: "jungle",
abstract: "SwiftPM and Cocoapods based projects complexity analyzer.",
version: "2.1.1",
version: "2.2.0",
subcommands: [HistoryCommand.self, CompareCommand.self, GraphCommand.self, ModulesCommand.self, DependantCommand.self],
defaultSubcommand: CompareCommand.self
)
Expand Down

0 comments on commit 1ad9f7b

Please sign in to comment.