feat: rename XcodeProjMapper to XcodeGraphMapper

.github/workflows/XcodeGraph.yml

@@ -2,7 +2,7 @@ name: XcodeGraph
 on:
   push:
     branches:
-      - "**"
+      - "main"
     tags-ignore:
       - "**"
     paths:
@@ -51,7 +51,7 @@ jobs:
       - name: Test on Linux
         if: matrix.os == 'ubuntu-22.04'
         # These momdules rely on some Xcode utilities like xcode-select
-        run: swift test --skip XcodeProjMapperTests --skip XcodeMetadataTests
+        run: swift test --skip XcodeGraphMapperTests --skip XcodeMetadataTests
       - name: Test
         if: matrix.os != 'ubuntu-22.04'
         run: swift test

.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    name: Publish to Cloudflare Pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+        with:
+          experimental: true
+      - name: Setup Swift
+        uses: SwiftyLab/setup-swift@latest
+        with:
+          swift-version: 6.0.3
+      - name: Build docs
+        run: mise run docs:build
+      - name: Deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: pages deploy .build/documentation --project-name=xcodegraph
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+
+concurrency:
+  group: docs-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+        with:
+          experimental: true
+      - name: Setup Swift
+        uses: SwiftyLab/setup-swift@latest
+        with:
+          swift-version: 6.0.3
+      - name: Build docs
+        run: mise run docs:build

.mise/tasks/docs/build

@@ -0,0 +1,5 @@
+#!/bin/bash
+# mise description="Build docs"
+set -euo pipefail
+
+swift package --package-path $MISE_PROJECT_ROOT --allow-writing-to-directory .build/documentation generate-documentation --disable-indexing --output-path .build/documentation --transform-for-static-hosting --enable-experimental-combined-documentation --target XcodeGraph --target XcodeGraphMapper

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.4.0] - 2025-02-05
 ### Details
 #### Feat
-- Introduce XcodeProjMapper to map XcodeProj to XcodeGraph by @ajkolean in [#87](https://github.com/tuist/XcodeGraph/pull/87)
+- Introduce XcodeGraphMapper to map XcodeProj to XcodeGraph by @ajkolean in [#87](https://github.com/tuist/XcodeGraph/pull/87)
 
 ## New Contributors
 * @ajkolean made their first contribution in [#87](https://github.com/tuist/XcodeGraph/pull/87)

Package.swift

@@ -33,7 +33,7 @@ let targets: [Target] = [
         ]
     ),
     .target(
-        name: "XcodeProjMapper",
+        name: "XcodeGraphMapper",
         dependencies: [
             "XcodeGraph",
             "XcodeMetadata",
@@ -53,9 +53,9 @@ let targets: [Target] = [
         ]
     ),
     .testTarget(
-        name: "XcodeProjMapperTests",
+        name: "XcodeGraphMapperTests",
         dependencies: [
-            "XcodeProjMapper",
+            "XcodeGraphMapper",
             .product(name: "FileSystem", package: "FileSystem"),
         ],
         swiftSettings: [
@@ -72,7 +72,7 @@ let package = Package(
             name: "XcodeGraph",
             targets: ["XcodeGraph"]
         ),
-        .library(name: "XcodeProjMapper", targets: ["XcodeProjMapper"]),
+        .library(name: "XcodeGraphMapper", targets: ["XcodeGraphMapper"]),
     ],
     dependencies: [
         .package(url: "https://github.com/Flight-School/AnyCodable", .upToNextMajor(from: "0.6.7")),
@@ -83,6 +83,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-service-context", .upToNextMajor(from: "1.0.0")),
         .package(url: "https://github.com/Kolos65/Mockable.git", .upToNextMajor(from: "0.0.11")),
         .package(url: "https://github.com/p-x9/MachOKit", .upToNextMajor(from: "0.28.0")),
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: targets
 )

README.md

@@ -23,6 +23,8 @@ let package = Package(
 
 ## XcodeGraphMapper
 
+- [Documentation](https://xcodegraph.pages.dev/documentation/XcodeGraphMapper)
+
 XcodeGraphMapper parses `.xcworkspace` or `.xcodeproj` files using `XcodeProj` and constructs a `XcodeGraph.Graph` representing their projects, targets, and dependencies:
 
 ### Usage

Sources/XcodeProjMapper/Documentation.docc/XcodeProjMapper.md → Sources/XcodeGraphMapper/Documentation.docc/XcodeProjMapper.md

@@ -1,4 +1,4 @@
-# ``XcodeProjMapper``
+# ``XcodeGraphMapper``
 
 @Metadata {
     @DisplayName("Xcode Project Mapper")
@@ -10,9 +10,9 @@ A tool that maps Xcode projects (`.xcodeproj` and `.xcworkspace`) into a structu
 
 ## Overview
 
-``XcodeProjMapper`` leverages ``XcodeProj`` to parse and navigate Xcode project files, then translates them into a domain-specific graph model (``XcodeGraph/Graph``). This model captures all essential components—projects, targets, packages, dependencies, build settings, schemes, and more—providing a high-level, language-agnostic structure for further processing.
+``XcodeGraphMapper`` leverages ``XcodeProj`` to parse and navigate Xcode project files, then translates them into a domain-specific graph model (``XcodeGraph/Graph``). This model captures all essential components—projects, targets, packages, dependencies, build settings, schemes, and more—providing a high-level, language-agnostic structure for further processing.
 
-By using this graph-based representation, you can easily analyze project configurations, visualize complex dependency graphs, or integrate advanced workflows into your build pipelines. For example, teams can leverage ``XcodeProjMapper`` to:
+By using this graph-based representation, you can easily analyze project configurations, visualize complex dependency graphs, or integrate advanced workflows into your build pipelines. For example, teams can leverage ``XcodeGraphMapper`` to:
 
 - Generate code based on discovered resources and targets.
 - Validate project configurations and detect missing bundle identifiers or invalid references.

Tests/XcodeProjMapperTests/MapperTests/Graph/GraphMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Graph/GraphMapperTests.swift

@@ -3,7 +3,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct XcodeGraphMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Package/XCPackageMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Package/XCPackageMapperTests.swift

@@ -2,7 +2,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct XCPackageMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXCopyFilesBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXCopyFilesBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXCopyFilesBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXCoreDataModelsBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXCoreDataModelsBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXCoreDataModelsBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXFrameworksBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXFrameworksBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXFrameworksBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXHeadersBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXHeadersBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXHeadersBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXResourcesBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXResourcesBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXResourcesBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXScriptsBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXScriptsBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXScriptsBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Phases/PBXSourcesBuildPhaseMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Phases/PBXSourcesBuildPhaseMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXSourcesBuildPhaseMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Project/PBXProjectMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Project/PBXProjectMapperTests.swift

@@ -2,7 +2,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXProjectMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Schemes/XCSchemeMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Schemes/XCSchemeMapperTests.swift

@@ -2,8 +2,9 @@ import AEXML
 import Path
 import Testing
 import XcodeGraph
+
+@testable import XcodeGraphMapper
 @testable import XcodeProj
-@testable import XcodeProjMapper
 
 @Suite
 struct XCSchemeMapperTests {
@@ -135,8 +136,12 @@ struct XCSchemeMapperTests {
             blueprintName: "App"
         )
         let runnable = XCScheme.BuildableProductRunnable(buildableReference: targetRef)
-        let envVar = XCScheme.EnvironmentVariable(variable: "RUN_ENV", value: "run_value", enabled: true)
-        let launchArg = XCScheme.CommandLineArguments.CommandLineArgument(name: "run_arg", enabled: true)
+        let envVar = XCScheme.EnvironmentVariable(
+            variable: "RUN_ENV", value: "run_value", enabled: true
+        )
+        let launchArg = XCScheme.CommandLineArguments.CommandLineArgument(
+            name: "run_arg", enabled: true
+        )
         let element = runnable.xmlElement()
         let launchAction = XCScheme.LaunchAction(
             runnable: try .init(element: element),

Tests/XcodeProjMapperTests/MapperTests/Settings/BuildSettingsTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Settings/BuildSettingsTests.swift

@@ -2,7 +2,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct BuildSettingsTests {

Tests/XcodeProjMapperTests/MapperTests/Settings/ConfigurationMatcherTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Settings/ConfigurationMatcherTests.swift

@@ -1,6 +1,6 @@
 import Testing
 import XcodeGraph
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct ConfigurationMatcherTests {

Tests/XcodeProjMapperTests/MapperTests/Settings/XCConfigurationMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Settings/XCConfigurationMapperTests.swift

@@ -2,7 +2,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct XCConfigurationMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Target/PBXBuildRuleMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Target/PBXBuildRuleMapperTests.swift

@@ -1,7 +1,7 @@
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXBuildRuleMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Target/PBXTargetDependencyMapper.swift → Tests/XcodeGraphMapperTests/MapperTests/Target/PBXTargetDependencyMapper.swift

@@ -2,7 +2,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct DependencyMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Target/PBXTargetMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Target/PBXTargetMapperTests.swift

@@ -4,7 +4,7 @@ import Path
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct PBXTargetMapperTests {

Tests/XcodeProjMapperTests/MapperTests/Target/TargetDependencyExtensionsTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Target/TargetDependencyExtensionsTests.swift

@@ -3,7 +3,7 @@ import Testing
 import XcodeMetadata
 import XcodeProj
 @testable import XcodeGraph
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct TargetDependencyExtensionsTests {

Tests/XcodeProjMapperTests/MapperTests/Workspace/XCWorkspaceMapperTests.swift → Tests/XcodeGraphMapperTests/MapperTests/Workspace/XCWorkspaceMapperTests.swift

@@ -4,7 +4,7 @@ import PathKit
 import Testing
 import XcodeGraph
 import XcodeProj
-@testable import XcodeProjMapper
+@testable import XcodeGraphMapper
 
 @Suite
 struct XCWorkspaceMapperTests {