Compare commits

..

13 Commits

21 changed files with 369 additions and 30 deletions
+9 -4
View File
@@ -1,5 +1,7 @@
on:
workflow_dispatch:
push:
tags:
- "*"
jobs:
build-linux:
@@ -19,7 +21,9 @@ jobs:
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool Linux/build.sh
docker compose run --build \
-e XTOOL_VERSION=${{ github.ref_name }} \
--rm xtool Linux/build.sh
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
@@ -46,6 +50,7 @@ jobs:
APP_STORE_CONNECT_API_KEY_KEY: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY }}
IDENTITY_P12: ${{ secrets.IDENTITY_P12 }}
DEVELOPMENT_TEAM: ${{ secrets.DEVELOPMENT_TEAM }}
XTOOL_VERSION: ${{ github.ref_name }}
run: |
cd macOS
bundle exec fastlane package
@@ -72,6 +77,6 @@ jobs:
path: output
- name: Create and publish release
run: |
TAG="${GITHUB_REF##*/}-${GITHUB_SHA:0:7}"
gh release create "$TAG" --draft --title "Draft Release"
TAG="${{ github.ref_name }}"
gh release create "$TAG" --draft --title "v$TAG"
gh release upload "$TAG" output/**/*.{AppImage,AppImage.zsync,app.zip,app.dSYM.zip}
+31
View File
@@ -0,0 +1,31 @@
# Contributing to xtool
## Bug reports and feature requests
We welcome all bug reports and feature requests! Please create a [new issue](https://github.com/xtool-org/xtool/issues/new/choose) via GitHub.
## Documentation
The xtool documentation at <https://xtool.sh> is built with [swift-docc](https://github.com/swiftlang/swift-docc) and resides at [Documentation/xtool.docc](/Documentation/xtool.docc). It's hosted on Netlify, the configuration for which is in [netlify.toml](/netlify.toml).
When editing the DocC bundle, you can preview it with `make docs-preview`.
Once you make a pull request with your changes, we'll also generate a [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/) under your pull request. You can open this preview to see how the changes will look in production.
## Code
When making code changes, please make sure to test them on both macOS and Linux if possible. If you can also test on Windows with WSL, that is ideal.
To build xtool for debugging, run `make` in the project directory. There are a few considerations depending on your host OS:
### macOS
On macOS, you'll firstly need to have Xcode set up.
The first time you run `make`, we'll try to detect your codesigning identity. If you have multiple, you'll see an interactive prompt to select the team you want to use. The team ID is saved to `./macOS/Support/Private-Team.xcconfig`. You can run `make team` to update it (or do so by hand).
After building, a symlink to the product will be created at `./macOS/Build/xtool`. We generate an Xcode project at `./macOS/XToolMac.xcodeproj` that you can open in order to work in Xcode.
### Linux
You need to have a few dependencies on Linux; see [Dockerfile](/Dockerfile) for specifics. It's often easiest to develop within Docker itself: see [Linux/README.md](/Linux/README.md) for details.
-1
View File
@@ -1 +0,0 @@
/docs
+1 -2
View File
@@ -22,5 +22,4 @@ else
fi
"$docc" "$command" xtool.docc \
--experimental-enable-custom-templates \
--output-path docs
--experimental-enable-custom-templates
+2 -2
View File
@@ -2,14 +2,14 @@
@Metadata {
@TechnologyRoot
@TitleHeading("Command-line Tool")
@CallToAction(url: "https://github.com/xtool-org/xtool", label: "View on GitHub")
}
Cross-platform Xcode replacement.
## Overview
[View on GitHub](https://github.com/xtool-org/xtool)
xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functionality with open standards.
✅ Build a SwiftPM package into an iOS app
+4 -7
View File
@@ -5,9 +5,6 @@ shopt -s nullglob
cd "$(dirname "$0")"
# release version
export LINUXDEPLOY_OUTPUT_VERSION="latest"
if ! command -v fusermount &>/dev/null; then
# Docker doesn't support FUSE
export APPIMAGE_EXTRACT_AND_RUN=1
@@ -43,10 +40,10 @@ fi
mkdir -p staging/tmp/AppDir/usr/bin
find "${bin}"/ -name '*.resources' -print0 | xargs -0 -I {} cp -a {} "${PWD}/staging/tmp/AppDir/usr/bin/"
env \
LDAI_OUTPUT="staging/tmp/xtool-${curr_arch}.AppImage" \
LDAI_UPDATE_INFORMATION="gh-releases-zsync|xtool-org|xtool|latest|xtool-${curr_arch}.AppImage.zsync" \
./staging/linuxdeploy/linuxdeploy.AppImage \
export LINUXDEPLOY_OUTPUT_VERSION="${XTOOL_VERSION:-unversioned}"
export LDAI_OUTPUT="staging/tmp/xtool-${curr_arch}.AppImage"
export LDAI_UPDATE_INFORMATION="gh-releases-zsync|xtool-org|xtool|latest|xtool-${curr_arch}.AppImage.zsync"
./staging/linuxdeploy/linuxdeploy.AppImage \
--appdir staging/tmp/AppDir \
--output appimage \
-e "${bin}/xtool" \
+132 -2
View File
@@ -1,7 +1,135 @@
ifeq ($(shell uname -s),Darwin)
IS_MAC = 1
ifneq ($(VERBOSE),1)
ifeq ($(shell type -p xcbeautify &>/dev/null && echo 1),1)
XC_FORMAT = | xcbeautify
endif
endif
endif
ifeq ($(RELEASE),1)
INTERNAL_SWIFTFLAGS = -c release
INTERNAL_XCFLAGS = -configuration Release
else
INTERNAL_SWIFTFLAGS = -c debug
INTERNAL_XCFLAGS = -configuration Debug
endif
ALL_SWIFTFLAGS = $(INTERNAL_SWIFTFLAGS) $(SWIFTFLAGS)
ALL_XCFLAGS = $(INTERNAL_XCFLAGS) $(XCFLAGS)
TEAM_CONFIG = macOS/Support/Private-Team.xcconfig
.PHONY: all
# dev build for the current platform
all:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac
else
@+$(MAKE) linux
endif
.PHONY: clean
# clean build artifacts
clean:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac-clean
else
@+$(MAKE) linux-clean
endif
.PHONY: linux
# dev build for Linux
linux:
swift build --product xtool $(ALL_SWIFTFLAGS)
.PHONY: linux-clean
# clean build artifacts for Linux
linux-clean:
rm -rf .build
.PHONY: linux-dist
# dist build for Linux
linux-dist:
docker compose run --build --rm xtool Linux/build.sh
.PHONY: mac
# dev build for macOS
mac: project
@rm -rf macOS/Build/XcodeInstall
@set -o pipefail && cd macOS && \
xcodebuild install \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XToolMac -destination generic/platform=macOS \
-derivedDataPath Build/DerivedData \
DSTROOT="$$PWD"/Build/XcodeInstall INSTALL_PATH=/ \
$(ALL_XCFLAGS) $(XC_FORMAT)
@ln -fs XcodeInstall/xtool.app/Contents/Resources/bin/xtool macOS/Build/xtool
@echo "Output: ./macOS/Build/xtool"
.PHONY: mac-clean
# clean build artifacts for macOS
mac-clean:
rm -rf macOS/Build
.PHONY: mac-dist
# dist build for macOS
# requires a few secrets in the env (see .github/workflows/release.yml)
mac-dist:
@echo "bundle exec fastlane package"
@cd macOS && bundle exec fastlane package
.PHONY: reload
# update Xcode project and restart Xcode
reload:
killall Xcode || :
@+$(MAKE) project
xed macOS/XToolMac.xcodeproj
.PHONY: project
# update Xcode project
project: $(TEAM_CONFIG)
@echo "xcodegen"
@cd macOS && xcodegen
.PHONY: team
# update development team
team:
@+$(MAKE) -B $(TEAM_CONFIG)
# update development team if needed.
#
# will prompt interactively if there are multiple valid options.
# set DEVELOPMENT_TEAM=... to force a specific value.
$(TEAM_CONFIG):
ifeq ($(DEVELOPMENT_TEAM),)
@mkdir -p macOS/Support
@team=$$(./scripts/select-identity.sh); \
echo "echo \"DEVELOPMENT_TEAM = $$team\" > $@"; \
echo "DEVELOPMENT_TEAM = $$team" > $@
else
@mkdir -p macOS/Support
echo "DEVELOPMENT_TEAM = $(DEVELOPMENT_TEAM)" > $@
.PHONY: $(TEAM_CONFIG)
endif
.PHONY: docs
# build documentation
docs:
./Documentation/build.sh
.PHONY: docs-preview
# preview documentation
docs-preview:
./Documentation/build.sh preview
SPEC_URL = https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip
.PHONY: api update-api
.PHONY: api
# Regenerate the OpenAPI client code
api: openapi/openapi.json
swift run swift-openapi-generator generate \
openapi/openapi.json \
@@ -11,6 +139,8 @@ api: openapi/openapi.json
sed -i '' -e 's/[[:<:]]Client[[:>:]]/DeveloperAPIClient/g' $$file; \
done
.PHONY: update-api
# Update OpenAPI spec and regenerate the client code
update-api:
@+$(MAKE) -B api
+18 -1
View File
@@ -2,6 +2,19 @@
import PackageDescription
let xtoolVersion: String? = {
if let explicitVersion = Context.environment["XTOOL_VERSION"] {
return explicitVersion
} else if let info = Context.gitInformation {
let gitCommit = info.currentCommit
let gitTag = info.currentTag
let gitRef = gitTag ?? "commit \(gitCommit)"
return "\(gitRef)\(info.hasUncommittedChanges ? " (dirty)" : "")"
} else {
return nil
}
}()
let cSettings: [CSetting] = [
.define("_GNU_SOURCE", .when(platforms: [.linux])),
]
@@ -64,7 +77,11 @@ let package = Package(
dependencies: [
.product(name: "OpenSSL", package: "xtool-core")
],
cSettings: cSettings
cSettings: cSettings + (
xtoolVersion
.map { [.define("XTOOL_VERSION", to: "\"\($0)\"")] }
?? []
)
),
.target(
name: "DeveloperAPI",
+1 -1
View File
@@ -23,7 +23,7 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
### Screenshot
![A screenshot of xtool being invoked from VSCode](Sources/XToolDocs/Documentation.docc/Resources/Cover.png)
![A screenshot of xtool being invoked from VSCode](Documentation/xtool.docc/Resources/Cover.png)
### Command line interface
+1
View File
@@ -0,0 +1 @@
const char * _Nonnull xtl_version(void);
+9
View File
@@ -0,0 +1,9 @@
#include "version.h"
const char *xtl_version(void) {
#ifdef XTOOL_VERSION
return XTOOL_VERSION;
#else
return "unversioned";
#endif
}
+2 -2
View File
@@ -1299,7 +1299,6 @@ public enum Components {
/// - Remark: Generated from `#/components/schemas/App/relationships/appAvailabilityV2`.
public var appAvailabilityV2: Components.Schemas.App.RelationshipsPayload.AppAvailabilityV2Payload?
/// - Remark: Generated from `#/components/schemas/App/relationships/inAppPurchases`.
@available(*, deprecated)
public struct InAppPurchasesPayload: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/App/relationships/inAppPurchases/links`.
public var links: Components.Schemas.RelationshipLinks?
@@ -1358,7 +1357,6 @@ public enum Components {
}
}
/// - Remark: Generated from `#/components/schemas/App/relationships/inAppPurchases`.
@available(*, deprecated)
public var inAppPurchases: Components.Schemas.App.RelationshipsPayload.InAppPurchasesPayload?
/// - Remark: Generated from `#/components/schemas/App/relationships/subscriptionGroups`.
public struct SubscriptionGroupsPayload: Codable, Hashable, Sendable {
@@ -5021,6 +5019,8 @@ public enum Components {
case ios = "IOS"
case macOs = "MAC_OS"
case universal = "UNIVERSAL"
case services = "SERVICES"
case macos = "MACOS"
}
/// - Remark: Generated from `#/components/schemas/CapabilityOption`.
public struct CapabilityOption: Codable, Hashable, Sendable {
+18 -1
View File
@@ -3,6 +3,7 @@ info:
title: Overlay for App Store Connect API
version: 1.0.0
actions:
# this field is required when using the private Xcode API
- target: '$.components.schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships'
update:
properties:
@@ -20,6 +21,22 @@ actions:
required: [id, type]
required: [data]
required: [capability]
# we don't use this but it triggers a deprecation warning. see:
# https://github.com/apple/swift-openapi-generator/issues/715
- target: '$.components.schemas.App.properties.relationships.properties.inAppPurchases'
update:
deprecated: false
# openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
# misses some cases that they do, actually, return.
- target: '$.components.schemas.Device.properties.attributes.properties.deviceClass'
update:
enum: ["APPLE_VISION_PRO"]
enum:
- APPLE_VISION_PRO
- target: '$.components.schemas.BundleIdPlatform'
update:
enum:
- SERVICES
# the spec already declares MAC_OS but ASC sometimes seems to
# spell this as MACOS instead. see:
# https://github.com/xtool-org/xtool/issues/64
- MACOS
+2 -3
View File
@@ -15,15 +15,14 @@ public struct BuildSettings: Sendable {
public init(
configuration: BuildConfiguration,
triple: String,
packagePath: String = ".",
options: [String] = []
) async throws {
self.packagePath = packagePath
self.configuration = configuration
self.options = options
// TODO: allow customizing?
self.triple = "arm64-apple-ios"
self.triple = triple
// on macOS we don't explicitly install a Swift SDK but
// SwiftPM vends "implicit" Darwin SDKs as of Swift 6.1,
@@ -17,7 +17,8 @@ extension DeveloperAPIClient {
),
transport: httpClient.asOpenAPITransport,
middlewares: [
auth.middleware
auth.middleware,
LoggingMiddleware(),
]
)
}
@@ -219,3 +220,39 @@ public struct DeveloperAPIASCAuthMiddleware: ClientMiddleware {
return try await next(request, body, baseURL)
}
}
struct LoggingMiddleware: ClientMiddleware {
static let regex: NSRegularExpression? = {
guard let pat = ProcessInfo.processInfo.environment["XTL_DEV_LOG"] else { return nil }
return try? NSRegularExpression(pattern: pat)
}()
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
baseURL: URL,
operationID: String,
next: (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, body) = try await next(request, body, baseURL)
guard Self.regex?.firstMatch(
in: operationID,
range: NSRange(operationID.startIndex..., in: operationID)
) != nil
else { return (response, body) }
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
// body may only be consumable once, replace it with the collected data
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
print("\(operationID) response body -> \(text)")
}
return (response, body)
}
}
+59 -1
View File
@@ -18,6 +18,9 @@ struct PackOperation {
}
}
static let defaultTriple = "arm64-apple-ios"
var triple: String?
var buildOptions = BuildOptions(configuration: .debug)
var xcode = false
@@ -39,6 +42,7 @@ struct PackOperation {
let buildSettings = try await BuildSettings(
configuration: buildOptions.configuration,
triple: triple ?? Self.defaultTriple,
options: []
)
@@ -90,8 +94,16 @@ struct DevBuildCommand: AsyncParsableCommand {
help: "Output a .ipa file instead of a .app"
) var ipa = false
@Option(
help: ArgumentHelp(
"Custom target triple to build for",
discussion: "Defaults to '\(PackOperation.defaultTriple)'"
)
) var triple: String?
func run() async throws {
let url = try await PackOperation(
triple: triple,
buildOptions: packOptions
).run()
@@ -136,10 +148,39 @@ struct DevRunCommand: AsyncParsableCommand {
@OptionGroup var packOptions: PackOperation.BuildOptions
#if os(macOS)
@Flag(
name: .shortAndLong,
help: "Target the iOS Simulator"
) var simulator = false
var triple: String? {
if simulator {
#if arch(arm64)
return "arm64-apple-ios-simulator"
#elseif arch(x86_64)
return "x86_64-apple-ios-simulator"
#else
#error("Unsupported architecture")
#endif
}
return nil
}
#else
var triple: String? { nil }
#endif
@OptionGroup var connectionOptions: ConnectionOptions
func run() async throws {
let output = try await PackOperation(buildOptions: packOptions).run()
let output = try await PackOperation(triple: triple, buildOptions: packOptions).run()
#if os(macOS)
if simulator {
try await SimInstallOperation(path: output).run()
return
}
#endif
let token = try AuthToken.saved()
@@ -175,3 +216,20 @@ struct DevCommand: AsyncParsableCommand {
}
extension BuildConfiguration: ExpressibleByArgument {}
#if os(macOS)
struct SimInstallOperation {
var path: URL
// TODO: allow customizing this
var simulator = "booted"
func run() async throws {
let process = Process()
process.executableURL = URL(fileURLWithPath: "/usr/bin/xcrun")
process.arguments = ["simctl", "install", simulator, path.path]
try await process.runUntilExit()
print("Installed to simulator")
}
}
#endif
+5
View File
@@ -0,0 +1,5 @@
import CXKit
extension XTool {
public static let version = String(cString: xtl_version())
}
@@ -8,10 +8,11 @@ public enum XTool {
}
}
struct XToolCommand: AsyncParsableCommand {
private struct XToolCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
commandName: "xtool",
abstract: "Cross-platform Xcode replacement",
version: "xtool \(XTool.version)",
groupedSubcommands: [
CommandGroup(
name: "Configuration",
+3
View File
@@ -6,4 +6,7 @@ ENABLE_HARDENED_RUNTIME = YES
PRODUCT_NAME = xtool
PRODUCT_MODULE_NAME = XToolMac
INFOPLIST_KEY_LSApplicationCategoryType = public.app-category.developer-tools
#include? "Private-Team.xcconfig"
#include? "Private.xcconfig"
+1 -1
View File
@@ -3,7 +3,7 @@
# `swift build` in the root directory, which builds more targets than
# we need.
base = "Documentation/"
publish = "docs/"
publish = "xtool.docc/.docc-build"
command = "./build.sh"
environment = { SWIFT_VERSION = "6.1" }
ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Documentation netlify.toml"
+31
View File
@@ -0,0 +1,31 @@
#!/bin/bash
# we can't simply extract the portion in brackets because some times the Organizational Unit is different from that
# so extract that info from the certificate
function get_team {
security find-certificate -pc "$1" | openssl x509 -noout -subject | grep -o 'OU=[A-Z0-9]*' | cut -d= -f2
}
IFS=$'\n' names=($(security find-identity -vp codesigning | grep -E '(?:iPhone Developer|Apple Development):' | cut -d'"' -f2 | uniq))
if [[ "${#names[@]}" -eq 1 ]]; then
identity="${names[0]}"
else
echo "Select identity" >&2
for i in "${!names[@]}"; do
cur_identity="${names[$i]}"
cur_team="$(get_team "$cur_identity")"
printf "%s. %s '%s'\n" $((i + 1)) "$cur_team" "$cur_identity" >&2
done
# ask for choice until the user supplies a valid answer
function select_identity {
read -p "Choice (enter number): " identity_idx >&2
if [[ "$identity_idx" -lt 1 || "$identity_idx" -gt "${#names[@]}" ]]; then
select_identity
else
identity="${names[$((identity_idx - 1))]}"
fi
}
select_identity
fi
get_team "$identity"