Contents

xing/jungle

A Swift CLI tool that generates complexity metrics information from a Cocoapods Xcode project or a SwiftPM package. Currently, that´s what you can do:

Table of contents

Mint Manual

Fetch Historic Complexities Compare Complexity Graphs Count Module Dependencies Visualize Complexity Graphs + Some tips

* Contributor License Agreement

Installation

Mint

mint install xing/jungle
mint run jungle help

Manual

git clone https://github.com/xing/jungle
cd jungle
swift build -c release
.build/release/jungle help

Usage

Fetch Historic Complexities

OVERVIEW: Displays historic complexity of the dependency graph

USAGE: jungle history [--since <since>] [--module <module>] --target <target> [--output-format <output-format>] [<directory-path>]

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

OPTIONS:
  --since <since>         Equivalent to git-log --since: Eg: '6 months ago' (default: 6 months ago)
  --module <module>       The Module to compare. If you specify something, target parameter will be ommited
  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
  --output-format <output-format>
                          csv or json (default: csv)
  --version               Show the version.
  -h, --help              Show help information.

Example:

jungle history --target App ProjectDirectory/ --since '1 week ago'

2022-08-30T15:12:14+02:00;cdb9d2ce64a;124;21063;Author;commit message
2022-09-02T11:02:12+02:00;4fdf3a157a4;124;21063;Author;commit message
Now;Current;124;21063;;

Compare Complexity Graphs

OVERVIEW: Compares the current complexity of the dependency graph to others versions in git

USAGE: jungle compare [--to <git-object> ...] [--module <module>] --target <target> [<directory-path>]

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

OPTIONS:
  --to <git-object>       The git objects to compare the current graph to. Eg: - 'main', 'my_branch', 'some_commit_hash'. (default: HEAD, main, master)
  --module <module>       The Module to compare. If you specify something, target parameter will be ommited
  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
  --version               Show the version.
  -h, --help              Show help information.

Example:


jungle compare --target App ProjectDirectory/ --to main
[
  {
    "modules" : 124,
    "complexity" : 20063,
    "name" : "Current",
    "moduleCount" : 124
  },
  {
    "modules" : 124,
    "complexity" : 21063,
    "name" : "main",
    "moduleCount" : 124
  }
]

Count Module Dependencies

OVERVIEW: Outputs a sorted list of modules dependencies count of your project

USAGE: jungle modules --target <target> [<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 (this can be a Product name in SPM)
  --version               Show the version.
  -h, --help              Show help information.

Example:

jungle modules --target jungle

4 - PodExtractor
3 - SPMExtractor
2 - DependencyGraph
0 - Shell
0 - ArgumentParser

Get dependant modules

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 (this can be a Product name in SPM)
  --show-only-tests       Show only Test targets
  --version               Show the version.
  -h, --help              Show help information.

Example:

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

Library, LibraryTests, SamplePackageTests


### Visualize Complexity Graphs

OVERVIEW: Outputs the dependency graph in DOT format

USAGE: jungle graph [--of <git-object>] [--module <module>] --target <target> [--use-multiedge] [--show-externals] [<directory-path>]

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

OPTIONS: --of <git-object> A git object representing the version to draw the graph for. Eg: - 'main', 'my_branch', 'some_commit_hash'. --module <module> The Module to compare. If you specify something, target parameter will be ommited --target <target> The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM) --use-multiedge Use multi-edge or unique-edge configuration --show-externals Show Externals modules dependencies --version Show the version. -h, --help Show help information.


Outputs DOT format which can be viewed using http://viz-js.com


#### Some tips

💡 Copy CSV (to paste in a spreadsheet) or DOT (to paste at http://viz-js.com) to the clipboard using `pbcopy`

jungle graph --target App ProjectDirectory/ | pbcopy jungle history --target App ProjectDirectory/ | pbcopy



💡 Use Graphviz tool to generate your own graphs

brew install graphviz jungle graph --target App ProjectDirectory/ | dot -Tpng -o graph.png && open graph.png

Contributing

🎁 Bug reports and pull requests for new features/ideas are most welcome!

👷🏼 We are looking forward to your pull request, we'd love to help!

You can help by doing any of the following:

  • Reviewing pull requests
  • Bringing ideas for new features
  • Answering questions on issues
  • Improving documentation

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Find the agreement [here][XING CLA] and head over to [the contributors page][contributors] and find a XING employee to contact for further instructions.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

[XING CLA]: docs/XING_CLAv2.md [contributors]: https://github.com/xing/jungle/graphs/contributors

Package Metadata

Repository: xing/jungle

Default branch: main

README: README.md