mirror of
https://github.com/yonaskolb/XcodeGen.git
synced 2024-07-07 09:06:32 +03:00
Remove GraphViz feature (#1485)
* Remove GraphViz to pass build on Xcode 16 * Update documentations
This commit is contained in:
Kohki Miki
GitHub
parent
f51719ce29
commit
7eb5e9bd06
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
## Next Version
|
||||
|
||||
- Removed `xcodegen dump --type graphviz` feature. @giginet
|
||||
|
||||
## 2.41.0
|
||||
|
||||
### Added
|
||||
|
|
|
|||
|
|
@ -18,15 +18,6 @@
|
|||
"version" : "0.0.6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"identity" : "graphviz",
|
||||
"kind" : "remoteSourceControl",
|
||||
"location" : "https://github.com/SwiftDocOrg/GraphViz.git",
|
||||
"state" : {
|
||||
"revision" : "70bebcf4597b9ce33e19816d6bbd4ba9b7bdf038",
|
||||
"version" : "0.2.0"
|
||||
}
|
||||
},
|
||||
{
|
||||
"identity" : "jsonutilities",
|
||||
"kind" : "remoteSourceControl",
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ let package = Package(
|
|||
.package(url: "https://github.com/tuist/XcodeProj.git", exact: "8.13.0"),
|
||||
.package(url: "https://github.com/jakeheis/SwiftCLI.git", from: "6.0.3"),
|
||||
.package(url: "https://github.com/mxcl/Version", from: "2.0.0"),
|
||||
.package(url: "https://github.com/SwiftDocOrg/GraphViz.git", exact: "0.2.0"),
|
||||
.package(url: "https://github.com/freddi-kit/ArtifactBundleGen", exact: "0.0.6")
|
||||
],
|
||||
targets: [
|
||||
|
|
@ -41,7 +40,6 @@ let package = Package(
|
|||
"XcodeProj",
|
||||
"PathKit",
|
||||
"XcodeGenCore",
|
||||
"GraphViz",
|
||||
], resources: [
|
||||
.copy("SettingPresets")
|
||||
]),
|
||||
|
|
|
|||
22
README.md
22
README.md
|
|
@ -35,7 +35,6 @@ The project spec is a YAML or JSON file that defines your targets, configuration
|
|||
- ✅ Distribute your spec amongst multiple files for easy **sharing** and overriding
|
||||
- ✅ Easily create **multi-platform** frameworks
|
||||
- ✅ Integrate **Carthage** frameworks without any work
|
||||
- ✅ Export **Dependency Diagrams** to view in [Graphviz](https://www.graphviz.org)
|
||||
|
||||
Given an example project spec:
|
||||
|
||||
|
|
@ -138,27 +137,6 @@ Options:
|
|||
|
||||
There are other commands as well such as `xcodegen dump` which lets one output the resolved spec in many different formats, or write it to a file. Use `xcodegen help` to see more detailed usage information.
|
||||
|
||||
## Dependency Diagrams
|
||||
<details>
|
||||
<summary>Click to expand!</summary>
|
||||
|
||||
#### How to export dependency diagrams:
|
||||
|
||||
To stdout:
|
||||
|
||||
```
|
||||
xcodegen dump --type graphviz
|
||||
```
|
||||
|
||||
To a file:
|
||||
|
||||
```
|
||||
xcodegen dump --type graphviz --file Graph.viz
|
||||
```
|
||||
|
||||
During implementation, `graphviz` formatting was validated using [GraphvizOnline](https://dreampuf.github.io/GraphvizOnline/), [WebGraphviz](http://www.webgraphviz.com), and [Graphviz on MacOS](https://graphviz.org).
|
||||
</details>
|
||||
|
||||
## Editing
|
||||
```shell
|
||||
git clone https://github.com/yonaskolb/XcodeGen.git
|
||||
|
|
|
|||
|
|
@ -41,8 +41,6 @@ class DumpCommand: ProjectCommand {
|
|||
output = try Yams.dump(object: project.toJSONDictionary())
|
||||
case .summary:
|
||||
output = project.debugDescription
|
||||
case .graphviz:
|
||||
output = GraphVizGenerator().generateModuleGraphViz(targets: project.targets)
|
||||
}
|
||||
|
||||
if let file = file {
|
||||
|
|
@ -61,7 +59,6 @@ private enum DumpType: String, ConvertibleFromString, CaseIterable {
|
|||
case parsedJSON = "parsed-json"
|
||||
case parsedYaml = "parsed-yaml"
|
||||
case summary
|
||||
case graphviz
|
||||
|
||||
static var defaultValue: DumpType { .yaml }
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,66 +0,0 @@
|
|||
import DOT
|
||||
import Foundation
|
||||
import GraphViz
|
||||
import ProjectSpec
|
||||
|
||||
extension Dependency {
|
||||
var graphVizName: String {
|
||||
switch self.type {
|
||||
case .bundle, .package, .sdk, .framework, .carthage:
|
||||
return "[\(self.type)]\\n\(reference)"
|
||||
case .target:
|
||||
return reference
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension Dependency.DependencyType: CustomStringConvertible {
|
||||
public var description: String {
|
||||
switch self {
|
||||
case .bundle: return "bundle"
|
||||
case .package: return "package"
|
||||
case .framework: return "framework"
|
||||
case .carthage: return "carthage"
|
||||
case .sdk: return "sdk"
|
||||
case .target: return "target"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension Node {
|
||||
init(target: Target) {
|
||||
self.init(target.name)
|
||||
self.shape = .box
|
||||
}
|
||||
|
||||
init(dependency: Dependency) {
|
||||
self.init(dependency.reference)
|
||||
self.shape = .box
|
||||
self.label = dependency.graphVizName
|
||||
}
|
||||
}
|
||||
|
||||
public class GraphVizGenerator {
|
||||
|
||||
public init() {}
|
||||
|
||||
public func generateModuleGraphViz(targets: [Target]) -> String {
|
||||
return DOTEncoder().encode(generateGraph(targets: targets))
|
||||
}
|
||||
|
||||
func generateGraph(targets: [Target]) -> Graph {
|
||||
var graph = Graph(directed: true)
|
||||
targets.forEach { target in
|
||||
target.dependencies.forEach { dependency in
|
||||
let from = Node(target: target)
|
||||
graph.append(from)
|
||||
let to = Node(dependency: dependency)
|
||||
graph.append(to)
|
||||
var edge = Edge(from: from, to: to)
|
||||
edge.style = .dashed
|
||||
graph.append(edge)
|
||||
}
|
||||
}
|
||||
return graph
|
||||
}
|
||||
}
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
import ProjectSpec
|
||||
import Spectre
|
||||
@testable import XcodeGenKit
|
||||
import XCTest
|
||||
|
||||
private let app = Target(
|
||||
name: "MyApp",
|
||||
type: .application,
|
||||
platform: .iOS,
|
||||
settings: Settings(buildSettings: ["SETTING_1": "VALUE"]),
|
||||
dependencies: [
|
||||
Dependency(type: .target, reference: "MyInternalFramework"),
|
||||
Dependency(type: .bundle, reference: "Resources"),
|
||||
Dependency(type: .carthage(findFrameworks: true, linkType: .static), reference: "MyStaticFramework"),
|
||||
Dependency(type: .carthage(findFrameworks: true, linkType: .dynamic), reference: "MyDynamicFramework"),
|
||||
Dependency(type: .framework, reference: "MyExternalFramework"),
|
||||
Dependency(type: .package(products: ["MyPackage"]), reference: "MyPackage"),
|
||||
Dependency(type: .sdk(root: "MySDK"), reference: "MySDK"),
|
||||
]
|
||||
)
|
||||
|
||||
private let framework = Target(
|
||||
name: "MyFramework",
|
||||
type: .framework,
|
||||
platform: .iOS,
|
||||
settings: Settings(buildSettings: ["SETTING_2": "VALUE"])
|
||||
)
|
||||
|
||||
private let uiTest = Target(
|
||||
name: "MyAppUITests",
|
||||
type: .uiTestBundle,
|
||||
platform: .iOS,
|
||||
settings: Settings(buildSettings: ["SETTING_3": "VALUE"]),
|
||||
dependencies: [Dependency(type: .target, reference: "MyApp")]
|
||||
)
|
||||
|
||||
private let targets = [app, framework, uiTest]
|
||||
|
||||
class GraphVizGeneratorTests: XCTestCase {
|
||||
|
||||
func testGraphOutput() throws {
|
||||
describe {
|
||||
let graph = GraphVizGenerator().generateGraph(targets: targets)
|
||||
$0.it("generates the expected number of nodes") {
|
||||
try expect(graph.nodes.count) == 16
|
||||
}
|
||||
$0.it("generates box nodes") {
|
||||
try expect(graph.nodes.filter { $0.shape == .box }.count) == 16
|
||||
}
|
||||
$0.it("generates the expected carthage nodes") {
|
||||
try expect(graph.nodes.filter { $0.label?.contains("[carthage]") ?? false }.count) == 2
|
||||
}
|
||||
$0.it("generates the expected sdk nodes") {
|
||||
try expect(graph.nodes.filter { $0.label?.contains("[sdk]") ?? false }.count) == 1
|
||||
}
|
||||
$0.it("generates the expected Framework nodes") {
|
||||
try expect(graph.nodes.filter { $0.label?.contains("[framework]") ?? false }.count) == 1
|
||||
}
|
||||
$0.it("generates the expected package nodes") {
|
||||
try expect(graph.nodes.filter { $0.label?.contains("[package]") ?? false }.count) == 1
|
||||
}
|
||||
$0.it("generates the expected bundle nodes") {
|
||||
try expect(graph.nodes.filter { $0.label?.contains("[bundle]") ?? false }.count) == 1
|
||||
}
|
||||
$0.it("generates the expected edges") {
|
||||
try expect(graph.edges.count) == 8
|
||||
}
|
||||
$0.it("generates dashed edges") {
|
||||
try expect(graph.edges.filter { $0.style == .dashed }.count) == 8
|
||||
}
|
||||
$0.it("generates the expected output") {
|
||||
let output = GraphVizGenerator().generateModuleGraphViz(targets: targets)
|
||||
try expect(output) == """
|
||||
digraph {
|
||||
MyApp [shape=box]
|
||||
MyInternalFramework [label=MyInternalFramework shape=box]
|
||||
MyApp [shape=box]
|
||||
Resources [label="[bundle]\\nResources" shape=box]
|
||||
MyApp [shape=box]
|
||||
MyStaticFramework [label="[carthage]\\nMyStaticFramework" shape=box]
|
||||
MyApp [shape=box]
|
||||
MyDynamicFramework [label="[carthage]\\nMyDynamicFramework" shape=box]
|
||||
MyApp [shape=box]
|
||||
MyExternalFramework [label="[framework]\\nMyExternalFramework" shape=box]
|
||||
MyApp [shape=box]
|
||||
MyPackage [label="[package]\\nMyPackage" shape=box]
|
||||
MyApp [shape=box]
|
||||
MySDK [label="[sdk]\\nMySDK" shape=box]
|
||||
MyAppUITests [shape=box]
|
||||
MyApp [label=MyApp shape=box]
|
||||
MyApp -> MyInternalFramework [style=dashed]
|
||||
MyApp -> Resources [style=dashed]
|
||||
MyApp -> MyStaticFramework [style=dashed]
|
||||
MyApp -> MyDynamicFramework [style=dashed]
|
||||
MyApp -> MyExternalFramework [style=dashed]
|
||||
MyApp -> MyPackage [style=dashed]
|
||||
MyApp -> MySDK [style=dashed]
|
||||
MyAppUITests -> MyApp [style=dashed]
|
||||
}
|
||||
"""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user