Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/polac24/xcbuildanalyzer

SwiftUI application to analyze Xcode build system graph (Experimental)
https://github.com/polac24/xcbuildanalyzer

build-systems build-tool xcode

Last synced: 2 months ago
JSON representation

SwiftUI application to analyze Xcode build system graph (Experimental)

Host: GitHub
URL: https://github.com/polac24/xcbuildanalyzer
Owner: polac24
License: other
Created: 2023-06-18T18:25:05.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-09T01:36:01.000Z (11 months ago)
Last Synced: 2024-10-16T00:31:33.961Z (2 months ago)
Topics: build-systems, build-tool, xcode
Language: Swift
Homepage:
Size: 2.86 MB
Stars: 71
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: Readme.md
- License: LICENSE

Awesome Lists containing this project

README

# ![icon](docs/img/icon.png) XCBuildAnalyzer

macOS app to inspect Xcode's build system graph

## Description

XCBuildAnalyzer is a standalone macOS app that renders the Xcode build system graph with some (limited) timing data. Analyzing the graph might be useful to understand dependencies between particular steps and why does build system invalidates previous build results.

The tool relies on a build manifest json file that is always generated in the project DerivedData directory.

![Demo](docs/img/demo.gif)

## Getting Started

[Inspecting Xcode’s build system graph at ease](https://medium.com/@londeix/inspecting-xcodes-build-system-graph-at-ease-e96573d5d340) blogpost on medium.com

To analyze your most recent build system graph, drag&drop a project file to the application area. Depending on a size of a project and nodes in a graph, it may take some time but usually should finish within couple of seconds.

On a left pane you will see graph nodes aggregated by target names (if applicable). The build graph is very often massive so to improve the reliability and performance, analyzing a subgraph is recommended.

Selecting a node will render a view with all input and output nodes in the center view.

![Main graph](docs/img/graph.png)

If a node has some hidden input or outputs that were skipped for brevity, the node's icon ⤡ or ⤢ allow expanding them.

![Expanding nodes](docs/img/expand.png)

Selecting multiple nodes (using ⌘ or ⇧) in a left view draws the possible subgraph that includes all nodes.

Screenshot

![Expanding nodes](docs/img/subgraph.png)

On a right pane, you can inspect step details including input/output nodes, step tool, ENV variables etc.

Screenshot

![Expanding nodes](docs/img/details.png)

If a build timing data was found along the build manifest, steps that were triggered in the most recent build have timing data. Look for 🔨 icons to found nodes that were recently executed.

Screenshot

![Expanding nodes](docs/img/timing.png)

![Expanding nodes](docs/img/executed.png)

#### Cycles

If a cycle has been found in the graph, affected nodes have a warning sign. Selecting them draws the full cycle (with some few side nodes):

![Expanding nodes](docs/img/cycle_warning.png)

Screenshot

![Expanding nodes](docs/img/cycle.png)

#### Comparing build graphs between builds

By default, XCBuildAnalyzer finds the most recent graph manifest found in the DerivedData, but if you want to analyze or compare specific build graphs, you can drag&drop raw `manifest.json` files from `DerivedData/ProjectName/Build/Intermediates.noindex/XCBuildData/{build_hash}.xcbuilddata/manifest.json`.

> [!NOTE]
> Keep in mind for raw manifest mode, timing data is not available

### Requirements

* Building a project at least once with Xcode

### Supported formats

- [x] `*.xcodeproj`
- [x] `.xcworkspace`
- [x] `Package.swift`
- [x] `manifest.json`

### Installing

#### Running from a binary

* Open the most recent [released version](https://github.com/polac24/XCBuildAnalyzer/releases)
* Download&unzip the binary
* Run XCBuildAnalyzer.app

#### Building a project locally

1. Download node.js dependencies, by calling `scripts/dependencies.sh` (npm required)
1. open BuildAnalyzer.xcodeproj
1. [Optional] pick BuildAnalyzer scheme
1. Run the app with ⌘+R

## Authors

Contributors names and contact info:

* Bartosz Polaczyk [@polac24](https://github.com/polac24)

## License

This project is licensed under the [Apache License](LICENSE)

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
```

## Acknowledgments

* [SQLite.swift](https://github.com/stephencelis/SQLite.swift)
* [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift)
* [d3-graphviz](https://github.com/magjac/d3-graphviz)

This product includes software developed by the "Marcin Krzyzanowski" (http://krzyzanowskim.com/)