Compare commits

..

48 Commits

100 changed files with 2609 additions and 314 deletions
+37
View File
@@ -0,0 +1,37 @@
---
name: Bug report
about: Report a bug
title: ''
labels: bug
assignees: ''
---
## Description
A clear and concise description of what the bug is.
## Environment
Please provide as much of the following information as is relevant.
Host OS (macOS/Linux/WSL):
Host OS version:
<!-- macOS: Apple Logo > About this Mac -->
<!-- Linux: -->
<!-- cat /etc/*-release -->
<!-- Windows: -->
<!-- Get-WinVer; wsl -l -v -->
iOS device version:
<!-- Settings > General > About > iOS Version -->
Swift version:
<!-- swift --version -->
SDK version:
<!-- macOS: -->
<!-- xcodebuild -version; xcrun -sdk iphoneos -show-sdk-version -->
<!-- Linux/WSL: -->
<!-- swift sdk configure darwin arm64-apple-ios --show-configuration | grep -o 'iPhoneOS[0-9.]*\.sdk$' -->
+10
View File
@@ -0,0 +1,10 @@
---
name: Feature request
about: Suggest an idea
title: ''
labels: enhancement
assignees: ''
---
+13 -1
View File
@@ -16,7 +16,7 @@ jobs:
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool -c "swift build --product xtool"
docker compose run --build --rm xtool swift build --product xtool
build-macos:
runs-on: macos-15
steps:
@@ -25,3 +25,15 @@ jobs:
- name: Build
run: |
swift build --product xtool
build-ios:
runs-on: macos-15
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
run: |
set -o pipefail \
&& xcodebuild build \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XKit -destination generic/platform=iOS \
| xcbeautify
-49
View File
@@ -1,49 +0,0 @@
on:
workflow_dispatch:
jobs:
build:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool -c "Linux/build.sh && mv Linux/packages/xtool{,-${{ matrix.host.arch }}}.AppImage"
- name: Upload artifact
id: upload_artifact
uses: actions/upload-artifact@v4
with:
name: xtool-${{ matrix.host.arch }}
path: Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
release:
needs: build
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
- name: Download artifact
id: download_artifact
uses: actions/download-artifact@v4
with:
pattern: xtool-*
path: output
- name: Create and publish release
id: publish_release
run: |
TAG="${GITHUB_REF##*/}-${GITHUB_SHA:0:7}"
gh release create "$TAG" --draft --title "Draft Release"
gh release upload "$TAG" output/**/*.AppImage
+82
View File
@@ -0,0 +1,82 @@
on:
push:
tags:
- "*"
jobs:
build-linux:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build \
-e XTOOL_VERSION=${{ github.ref_name }} \
--rm xtool Linux/build.sh
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: xtool-${{ matrix.host.arch }}
path: |
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage.zsync
build-mac:
runs-on: macos-15
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
working-directory: macOS
bundler-cache: true
- name: Build
env:
APP_STORE_CONNECT_API_KEY_KEY_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY_ID }}
APP_STORE_CONNECT_API_KEY_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_ISSUER_ID }}
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
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: xtool-mac
path: |
macOS/Build/Output/xtool.app.zip
macOS/Build/Output/xtool.app.dSYM.zip
release:
needs: [build-linux, build-mac]
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
- name: Download artifact
uses: actions/download-artifact@v4
with:
pattern: xtool-*
path: output
- name: Create and publish release
run: |
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}
-14
View File
@@ -1,14 +0,0 @@
version: 1
builder:
configs:
- scheme: xtool
platform: macosSpm
documentation_targets:
- xtool
- scheme: xtool
platform: macosXcodebuild
# - scheme: xtool
# platform: linux
# image: # TODO: we need to use our own Docker image for this
- scheme: XKit
platform: ios
+128
View File
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
conduct@xtool.sh.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
+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.
+3 -3
View File
@@ -1,7 +1,7 @@
# Note: We use 20.04 since AppImage recommends building on the
# Note: We use 22.04 since AppImage recommends building on the
# oldest configuration that you support
FROM swift:6.1-focal AS build-base
FROM swift:6.1-jammy AS build-base
RUN apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
@@ -94,4 +94,4 @@ ENV USBMUXD_SOCKET_ADDRESS=host.docker.internal:27015
WORKDIR /xtool
ENTRYPOINT [ "/bin/bash" ]
CMD [ "/bin/bash" ]
+25
View File
@@ -0,0 +1,25 @@
#!/bin/bash
set -euo pipefail
cd "$(dirname "$0")"
rm -rf docs
if type -p xcrun &>/dev/null; then
docc="$(xcrun -f docc)"
else
docc="docc"
fi
if [[ $# == 0 ]]; then
command="convert"
elif [[ $# == 1 && ( "$1" == "preview" || "$1" == "convert" ) ]]; then
command="$1"
else
echo "Usage: $0 [convert|preview]"
exit 1
fi
"$docc" "$command" xtool.docc \
--experimental-enable-custom-templates
@@ -21,7 +21,7 @@ You can update your app's bundle ID by editing the `bundleID` field in `xtool.ym
> Note:
>
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `SC-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `XTL-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
>
> With additional engineering effort, this limitation could be lifted for paid Developer Program users by leveraging wildcard provisioning profiles. If you have a concrete use case for this and/or wish to contribute, please [file an issue](https://github.com/xtool-org/xtool/issues/new).
@@ -1,6 +1,6 @@
@Tutorial(time: 30) {
@Intro(title: "Build your first iOS app on Linux") {
Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux machine.
@Intro(title: "Build your first iOS app on Linux / Windows") {
Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux/Windows machine.
}
@Section(title: "Create an xtool project") {
@@ -118,7 +118,7 @@
@Step {
Follow the instructions to configure [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp/blob/242609dcad55824d9eb23269c0aeead187fd0faa/Documentation/Editor%20Integration.md) for your IDE.
For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode).
For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode). If you're on Windows, make sure you're [connected to the WSL remote](https://code.visualstudio.com/docs/remote/wsl).
@Image(source: "SwiftExtension", alt: "Swift extension for VSCode")
}
@@ -1,13 +1,19 @@
# Installation (Linux)
# Installation (Linux/Windows)
Set up xtool for iOS app development on Linux.
Set up xtool for iOS app development on Linux or Windows.
## Overview
This article outlines the steps to install `xtool` and begin developing iOS apps on Linux.
This article outlines the steps to install `xtool` and begin developing iOS apps on Linux (or Windows via WSL).
## Prerequisites
### WSL (for Windows users)
If you're on Windows, you can use xtool via [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL).
Once you install WSL, you'll also need to set up USB passthrough. See Microsoft's instructions on [installing USBIPD](https://learn.microsoft.com/en-us/windows/wsl/connect-usb). Make sure you're able to bind your iOS device to WSL via USB.
### Swift
Install the Swift 6.1 toolchain for your Linux distribution from <https://swift.org/install/linux>.
@@ -58,6 +64,10 @@ sudo apt-get install usbmuxd
Download **Xcode 16.3** from <https://developer.apple.com/services-account/download?path=/Developer_Tools/Xcode_16.3/Xcode_16.3.xip>. Note the path where `Xcode_16.3.xip` is saved.
> Note:
>
> The URL above requires authentication, so make sure to visit it in your browser rather than running `curl`. You'll be asked to log in with your Apple ID and accept the license agreement to download Xcode.
## Installation
### 1. Download xtool
@@ -29,27 +29,19 @@ swift --version
## Installation
### 1. Build xtool
### 1. Download xtool
You currently have to build xtool from source on macOS, via Swift Package Manager.
If you have [Homebrew](https://brew.sh), you can install xtool with
```bash
git clone https://github.com/xtool-org/xtool
# Cloning into 'xtool'...
# Resolving deltas: 100% (1795/1795), done.
cd xtool
swift build -c release --product xtool
# Building for production...
# [503/503] Linking xtool
# Build of product 'xtool' complete! (67.64s)
sudo ln -s "$PWD/.build/release/xtool" /usr/local/bin/xtool
brew install xtool-org/tap/xtool
```
> Important:
Otherwise, you can download `xtool.app` from the [latest GitHub release](https://github.com/xtool-org/xtool/releases/latest). After moving it into `/Applications`, launch it and run the suggested script to add the `xtool` command to your `PATH`.
> Note:
>
> The SwiftPM build currently references relative libraries and resources. This means you can't just `mv` the built `xtool` binary, hence the usage of `ln` to symlink instead. Make sure you **don't delete the directory where you cloned xtool**.
>
> The plan is to make macOS installation easier and more self-contained in the future by shipping xtool as a `.app`, Homebrew Cask, etc. If you would like to contribute, feel free to reach out via [GitHub Issues](https://github.com/xtool-org/xtool/issues/new).
> If you install xtool manually, you'll also need to check for new GitHub releases and update it yourself. If you're interested in contributing support for auto-updates through Sparkle, pull requests are appreciated. See [issue #34 on GitHub](https://github.com/xtool-org/xtool/issues/34).
Confirm that xtool is installed correctly:

Before

Width:  |  Height:  |  Size: 286 KiB

After

Width:  |  Height:  |  Size: 286 KiB

Before

Width:  |  Height:  |  Size: 948 KiB

After

Width:  |  Height:  |  Size: 948 KiB

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 5.0 MiB

After

Width:  |  Height:  |  Size: 5.0 MiB

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

Before

Width:  |  Height:  |  Size: 316 KiB

After

Width:  |  Height:  |  Size: 316 KiB

Before

Width:  |  Height:  |  Size: 232 KiB

After

Width:  |  Height:  |  Size: 232 KiB

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 142 KiB

Before

Width:  |  Height:  |  Size: 2.3 MiB

After

Width:  |  Height:  |  Size: 2.3 MiB

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 127 KiB

+19
View File
@@ -0,0 +1,19 @@
<style>
footer {
display: flex;
justify-content: center;
padding: 0.5rem 0.8rem;
background-color: var(--color-fill-secondary);
text-align: center;
}
a, a:visited {
color: var(--color-text);
}
</style>
<footer>
<span>
&copy; xtool maintainers. This site is powered by <a href="https://www.netlify.com">Netlify</a>.
</span>
</footer>
@@ -1,4 +1,10 @@
# ``xtool``
# xtool
@Metadata {
@TechnologyRoot
@TitleHeading("Command-line Tool")
@CallToAction(url: "https://github.com/xtool-org/xtool", label: "View on GitHub")
}
Cross-platform Xcode replacement.
+7 -6
View File
@@ -5,9 +5,6 @@ shopt -s nullglob
cd "$(dirname "$0")"
# installer version
export LINUXDEPLOY_OUTPUT_VERSION="1.0.0"
if ! command -v fusermount &>/dev/null; then
# Docker doesn't support FUSE
export APPIMAGE_EXTRACT_AND_RUN=1
@@ -21,6 +18,7 @@ bin="$(swift build --package-path .. -c release --show-bin-path)"
strip "${bin}/xtool"
curr_git_info="$(curl -fsSL https://api.github.com/repos/linuxdeploy/linuxdeploy/git/refs/tags/continuous)"
curr_arch="$(uname -m)"
if [[ -f staging/linuxdeploy/git.json ]]; then
if ! cmp -s staging/linuxdeploy/git.json <(echo "$curr_git_info"); then
@@ -33,7 +31,7 @@ else
fi
if [[ ! -f staging/linuxdeploy/linuxdeploy.AppImage ]]; then
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-$(arch).AppImage" \
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${curr_arch}.AppImage" \
-o staging/linuxdeploy/linuxdeploy.AppImage
chmod +x staging/linuxdeploy/linuxdeploy.AppImage
echo "$curr_git_info" > staging/linuxdeploy/git.json
@@ -42,14 +40,17 @@ fi
mkdir -p staging/tmp/AppDir/usr/bin
find "${bin}"/ -name '*.resources' -print0 | xargs -0 -I {} cp -a {} "${PWD}/staging/tmp/AppDir/usr/bin/"
LDAI_OUTPUT="staging/tmp/xtool.AppImage" ./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" \
-d xtool.desktop \
-i xtool.png
mkdir -p packages
mv -f staging/tmp/xtool.AppImage packages/xtool.AppImage
mv -f "staging/tmp/xtool-${curr_arch}.AppImage" "./xtool-${curr_arch}.AppImage.zsync" packages/
rm -rf staging/tmp
+134 -4
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,11 +139,13 @@ 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
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml
npx bump-cli overlay openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml > openapi/openapi.json
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/patch.js
node Sources/DeveloperAPI/patch.js < openapi/base.json > openapi/openapi.json
openapi/base.json:
@mkdir -p openapi
+19 -2
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,14 +77,18 @@ let package = Package(
dependencies: [
.product(name: "OpenSSL", package: "xtool-core")
],
cSettings: cSettings
cSettings: cSettings + (
xtoolVersion
.map { [.define("XTOOL_VERSION", to: "\"\($0)\"")] }
?? []
)
),
.target(
name: "DeveloperAPI",
dependencies: [
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
],
exclude: ["openapi-generator-config.yaml", "openapi-overlay.yaml"]
exclude: ["openapi-generator-config.yaml", "patch.js"]
),
.target(
name: "XKit",
+5 -5
View File
@@ -1,6 +1,6 @@
# xtool
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux and macOS.
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, and macOS.
## Overview
@@ -15,15 +15,15 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- [Installation (Linux)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
- [Installation (macOS)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://swiftpackageindex.com/xtool-org/xtool/tutorials/xtool/first-app)!
- [Installation (Linux/Windows)](https://xtool.sh/documentation/xtooldocs/installation-linux)
- [Installation (macOS)](https://xtool.sh/documentation/xtooldocs/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://xtool.sh/tutorials/xtooldocs/first-app)!
## Examples
### Screenshot
![A screenshot of xtool being invoked from VSCode](Sources/xtool/Documentation.docc/Resources/Cover.png)
![A screenshot of xtool being invoked from VSCode](Documentation/xtool.docc/Resources/Cover.png)
### Command line interface
+5
View File
@@ -0,0 +1,5 @@
# Security Policy
## Reporting a Vulnerability
To report a vulnerability, please use GitHub's ["Report a Vulnerability"](https://github.com/xtool-org/xtool/security/advisories/new) tab. We'll be in touch regarding next steps.
+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
}
+201
View File
@@ -2017,6 +2017,207 @@ public struct DeveloperAPIClient: APIProtocol {
}
)
}
/// - Remark: HTTP `PATCH /v1/certificates/{id}`.
/// - Remark: Generated from `#/paths//v1/certificates/{id}/patch(certificates_updateInstance)`.
public func certificatesUpdateInstance(_ input: Operations.CertificatesUpdateInstance.Input) async throws -> Operations.CertificatesUpdateInstance.Output {
try await client.send(
input: input,
forOperation: Operations.CertificatesUpdateInstance.id,
serializer: { input in
let path = try converter.renderedPath(
template: "/v1/certificates/{}",
parameters: [
input.path.id
]
)
var request: HTTPTypes.HTTPRequest = .init(
soar_path: path,
method: .patch
)
suppressMutabilityWarning(&request)
converter.setAcceptHeader(
in: &request.headerFields,
contentTypes: input.headers.accept
)
let body: OpenAPIRuntime.HTTPBody?
switch input.body {
case let .json(value):
body = try converter.setRequiredRequestBodyAsJSON(
value,
headerFields: &request.headerFields,
contentType: "application/json; charset=utf-8"
)
}
return (request, body)
},
deserializer: { response, responseBody in
switch response.status.code {
case 200:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.Ok.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.CertificateResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .ok(.init(body: body))
case 400:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.BadRequest.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .badRequest(.init(body: body))
case 401:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.Unauthorized.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .unauthorized(.init(body: body))
case 403:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.Forbidden.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .forbidden(.init(body: body))
case 404:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.NotFound.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .notFound(.init(body: body))
case 409:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.Conflict.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .conflict(.init(body: body))
case 422:
let contentType = converter.extractContentTypeIfPresent(in: response.headerFields)
let body: Operations.CertificatesUpdateInstance.Output.UnprocessableContent.Body
let chosenContentType = try converter.bestContentType(
received: contentType,
options: [
"application/json"
]
)
switch chosenContentType {
case "application/json":
body = try await converter.getResponseBodyAsJSON(
Components.Schemas.ErrorResponse.self,
from: responseBody,
transforming: { value in
.json(value)
}
)
default:
preconditionFailure("bestContentType chose an invalid content type.")
}
return .unprocessableContent(.init(body: body))
default:
return .undocumented(
statusCode: response.status.code,
.init(
headerFields: response.headerFields,
body: responseBody
)
)
}
}
)
}
/// - Remark: HTTP `DELETE /v1/certificates/{id}`.
/// - Remark: Generated from `#/paths//v1/certificates/{id}/delete(certificates_deleteInstance)`.
public func certificatesDeleteInstance(_ input: Operations.CertificatesDeleteInstance.Input) async throws -> Operations.CertificatesDeleteInstance.Output {
File diff suppressed because it is too large Load Diff
-22
View File
@@ -1,22 +0,0 @@
overlay: 1.0.0
info:
title: Overlay for App Store Connect API
version: 1.0.0
actions:
- target: '$.components.schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships'
update:
properties:
capability:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum: [capabilities]
id:
"$ref": "#/components/schemas/CapabilityType"
required: [id, type]
required: [data]
required: [capability]
+59
View File
@@ -0,0 +1,59 @@
#!/usr/bin/env node
import fs from 'fs';
function makeOpen(enumSchema) {
const copy = structuredClone(enumSchema);
Object.keys(enumSchema).forEach(k => delete enumSchema[k]);
Object.assign(enumSchema, {
anyOf: [
copy,
{ type: 'string' },
]
})
}
function format(schema) {
const schemas = schema.components.schemas;
// this field is required when using the private Xcode API
const capabilityCreateRelationships = schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships;
capabilityCreateRelationships.properties.capability = {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
type: {
type: 'string',
enum: ['capabilities'],
},
id: { $ref: '#/components/schemas/CapabilityType' },
},
required: ['id', 'type'],
},
},
required: ['data'],
}
capabilityCreateRelationships.required.push('capability');
// we don't use this but it triggers a deprecation warning. see:
// https://github.com/apple/swift-openapi-generator/issues/715
schemas.App.properties.relationships.properties.inAppPurchases.deprecated = false;
// openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
// misses some cases that they do, actually, return.
// https://swiftpackageindex.com/apple/swift-openapi-generator/1.7.2/documentation/swift-openapi-generator/useful-openapi-patterns#Open-enums-and-oneOfs
makeOpen(schemas.BundleIdPlatform);
makeOpen(schemas.CapabilityType);
makeOpen(schemas.CertificateType);
makeOpen(schemas.Device.properties.attributes.properties.deviceClass);
return schema;
}
const text = fs.readFileSync(process.stdin.fd, 'utf8');
const json = JSON.parse(text);
const formatted = format(json);
const formattedText = JSON.stringify(formatted);
console.log(formattedText);
+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,
@@ -13,7 +13,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
public enum Error: LocalizedError {
case invalidApp(URL)
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
@@ -25,16 +24,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
), $0
)
}
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
@@ -68,7 +57,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
_type: .bundleIds,
attributes: .init(
name: name,
platform: .ios,
platform: .init(.ios),
identifier: newBundleID
)
)
@@ -115,9 +104,13 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
.ok
}
} else {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
// DeveloperServices doesn't allow deleting these capabilities
let requiredCapabilities: Set<Components.Schemas.CapabilityType.Value1Payload> = [.inAppPurchase]
if let capType = cap.attributes?.capabilityType?.value1, !requiredCapabilities.contains(capType) {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
}
}
}
for (typ, settings) in wantedCapabilities {
@@ -232,20 +225,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
)
}
private func getTeamIsFree() async throws -> Bool {
switch context.auth {
case .appStoreConnect:
return false
case .xcode(let authData):
let client = DeveloperServicesClient(authData: authData)
let request = DeveloperServicesListTeamsRequest()
let teams = try await client.send(request)
guard let team = teams.first(where: { $0.id == authData.teamID })
else { throw Error.teamNotFound(authData.teamID) }
return team.isFree
}
}
// keyed by sanitized bundle ID
private func getCurrentAppIDs() async throws -> [String: Components.Schemas.BundleId] {
let bundleIDs = try await context.developerAPIClient.bundleIdsGetCollection().ok.body.json.data
@@ -265,7 +244,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
apps += plugins.implicitContents.filter { $0.pathExtension.lowercased() == "appex" }
}
async let isFreeTeamTask = getTeamIsFree()
async let isFreeTeamTask = context.auth.team()?.isFree == true
async let appIDsTask = getCurrentAppIDs()
let (isFreeTeam, appIDs) = try await (isFreeTeamTask, appIDsTask)
@@ -15,11 +15,11 @@ public struct DeveloperServicesCapability: Sendable, Hashable {
public var settings: [Components.Schemas.CapabilitySetting]?
public init(
_ capabilityType: Components.Schemas.CapabilityType,
_ capabilityType: Components.Schemas.CapabilityType.Value1Payload,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = capabilityType
self.capabilityType = .init(capabilityType)
self.isFree = isFree
self.settings = settings
}
@@ -54,7 +54,7 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_type: .certificates,
attributes: .init(
csrContent: csr.pemString,
certificateType: .development
certificateType: .init(.development)
)
)))
)
@@ -72,19 +72,21 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_ certificates: [DeveloperServicesCertificate],
requireConfirmation: Bool
) async throws -> SigningInfo {
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
if try await context.auth.team()?.isFree == true {
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
}
try await group.waitForAll()
}
try await group.waitForAll()
}
let signingInfo = try await createCertificate()
signingInfoManager[self.context.auth.identityID] = signingInfo
@@ -17,7 +17,8 @@ extension DeveloperAPIClient {
),
transport: httpClient.asOpenAPITransport,
middlewares: [
auth.middleware
auth.middleware,
LoggingMiddleware(),
]
)
}
@@ -219,3 +220,63 @@ 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)
}
}
// syntactic sugar to make it nicer to work with `anyOf:` types
public protocol OpenAPIExtensibleEnum {
associatedtype Value1Payload: RawRepresentable<String>, Codable, Hashable, Sendable, CaseIterable
var value1: Value1Payload? { get set }
var value2: String? { get set }
init(value1: Value1Payload?, value2: String?)
}
extension OpenAPIExtensibleEnum {
public var rawValue: String {
value2!
}
public init(_ value: Value1Payload) {
self.init(value1: value, value2: nil)
}
}
extension Components.Schemas.BundleIdPlatform: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityType: OpenAPIExtensibleEnum {}
extension Components.Schemas.CertificateType: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload: OpenAPIExtensibleEnum {}
@@ -34,7 +34,6 @@ public struct DeveloperServicesLoginManager: Sendable {
private func logIn(
withLoginData loginData: GrandSlamLoginData
) async throws -> DeveloperServicesLoginToken {
print("Fetching tokens")
let tokens = try await GrandSlamFetchAppTokensOperation(
client: client,
apps: [.xcode],
@@ -50,7 +49,6 @@ public struct DeveloperServicesLoginManager: Sendable {
password: String,
twoFactorDelegate: TwoFactorAuthDelegate
) async throws -> DeveloperServicesLoginToken {
print("Starting login")
let loginData = try await GrandSlamAuthenticateOperation(
client: client,
// GSA requires Apple IDs in lowercase for SRP
@@ -0,0 +1,59 @@
import Foundation
private actor DeveloperServicesTeamFetcher {
static let shared = DeveloperServicesTeamFetcher()
private var cache: [DeveloperServicesTeam.ID: Task<DeveloperServicesTeam, Error>] = [:]
private init() {}
func teams(forXcodeLogin auth: XcodeAuthData) async throws -> DeveloperServicesTeam {
let teamID = auth.teamID
if let cached = cache[teamID] {
return try await cached.value
}
let task = Task {
let client = DeveloperServicesClient(authData: auth)
let teams = try await client.send(DeveloperServicesListTeamsRequest())
guard let team = teams.first(where: { $0.id == teamID })
else { throw Errors.teamNotFound(teamID) }
return team
}
cache[auth.teamID] = task
return try await task.value
}
enum Errors: LocalizedError {
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
}
extension XcodeAuthData {
public func team() async throws -> DeveloperServicesTeam {
try await DeveloperServicesTeamFetcher.shared.teams(forXcodeLogin: self)
}
}
extension DeveloperAPIAuthData {
public func team() async throws -> DeveloperServicesTeam? {
switch self {
case .appStoreConnect: nil
case .xcode(let auth): try await auth.team()
}
}
}
@@ -27,7 +27,7 @@ public struct DeveloperServicesFetchDeviceOperation: DeveloperServicesOperation
_type: .devices,
attributes: .init(
name: self.context.deviceName,
platform: .ios,
platform: .init(.ios),
udid: self.context.udid
)
)))
@@ -78,7 +78,7 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
data: .init(
_type: .profiles,
attributes: .init(
name: "SC profile \(bundleID.id)",
name: "XTL profile \(bundleID.id)",
profileType: .iosAppDevelopment
),
relationships: .init(
@@ -9,7 +9,7 @@
import Foundation
public struct DeveloperServicesTeam: Decodable, Sendable {
public struct ID: RawRepresentable, Decodable, Sendable {
public struct ID: RawRepresentable, Decodable, Sendable, Hashable {
public let rawValue: String
public init(rawValue: String) { self.rawValue = rawValue }
}
@@ -129,6 +129,15 @@ public actor XADIProvider: RawADIProvider {
}
})
let file = adiDirectory.appending(path: "adi.pb")
// adi saves the file as 0o034 (group wx, public r) by default
// which is a... strange choice that prevents us from reading
// or writing by default. Since we're the owner, we can easily
// change this though.
try FileManager.default.setAttributes(
// rw for owner
[.posixPermissions: 0o600],
ofItemAtPath: file.path
)
return try Data(contentsOf: file)
}
}
@@ -148,9 +157,6 @@ public actor XADIProvider: RawADIProvider {
let adiDirectory = directory.appending(path: "adi")
try? FileManager.default.createDirectory(at: adiDirectory, withIntermediateDirectories: true)
let adiFile = adiDirectory.appending(path: "adi.pb")
// this file may be saved as write-protected, but we can still remove it
// and then overwrite it.
try? FileManager.default.removeItem(at: adiFile)
try provisioningInfo.write(to: adiFile)
try check(xadi_OTPRequest(
@@ -65,8 +65,6 @@ struct GrandSlamAuthenticateOperation {
}
private func authenticate(isRetry: Bool) async throws -> GrandSlamLoginData {
print("Doing SRP stuff")
var srpClient = SRPClient()
srpClient.add(string: GrandSlamAuthInitRequest.protocols.joined(separator: ","))
@@ -118,8 +116,6 @@ struct GrandSlamAuthenticateOperation {
)
}
print("Got loginData")
return loginData
}
@@ -64,7 +64,6 @@ struct GrandSlamFetchAppTokensOperation {
func perform() async throws -> [AppTokenKey: Token] {
let checksum = AppTokens.checksum(withSK: loginData.sk, adsid: loginData.adsid, apps: apps.map { $0.rawValue })
print("Got checksum")
let appTokensRequest = GrandSlamAppTokensRequest(
username: loginData.adsid,
apps: apps,
@@ -72,9 +71,7 @@ struct GrandSlamFetchAppTokensOperation {
idmsToken: loginData.idmsToken,
checksum: checksum
)
print("Sending tokens req")
let response = try await client.send(appTokensRequest)
print("Handling tokens resp")
return try await self.handle(response: response)
}
+6 -2
View File
@@ -72,7 +72,7 @@ public actor Connection {
private static let pool = WeakPool<ConnectionDescriptor, Connection, Error>()
private var handle: AnyObject?
private let heartbeatHandler: HeartbeatHandler
private let heartbeatHandler: HeartbeatHandler?
private let udid: String
public let device: Device
public let client: LockdownClient
@@ -101,8 +101,12 @@ public actor Connection {
client = try LockdownClient(device: device, label: Self.label, performHandshake: true)
#if os(iOS)
progress(3/4)
heartbeatHandler = try await HeartbeatHandler(device: device, client: client)
#else
heartbeatHandler = nil
#endif
progress(4/4)
}
@@ -122,7 +126,7 @@ public actor Connection {
}
deinit {
heartbeatHandler.stop()
heartbeatHandler?.stop()
// we could nil out connections[udid] here but that might lead to
// weird race conditions against Connection.connection that seem
// like a nightmare to diagnose, and storing an empty box for a
@@ -55,7 +55,7 @@ public actor IntegratedInstaller {
private var appInstaller: AppInstaller?
private let tempDir = FileManager.default.temporaryDirectoryShim
.appendingPathComponent("com.kabiroberai.xtool.Staging")
.appendingPathComponent("sh.xtool.Staging")
private var stage: String?
@@ -299,7 +299,7 @@ public actor IntegratedInstaller {
try await self.updateStage(to: "Packaging", initialProgress: nil)
let ipa = try await compressor.compress(
directory: appDir.deletingLastPathComponent(),
directory: payload,
progress: { progress in
self.queueUpdateTask {
$0.updateProgressIgnoringCancellation(to: progress)
-5
View File
@@ -98,13 +98,8 @@ struct AuthOperation {
twoFactorDelegate: authDelegate
)
print("Got full login token")
let client = DeveloperServicesClient(loginToken: token)
let teams = try await client.send(DeveloperServicesListTeamsRequest())
print("Got teams")
let team = try await Console.choose(
from: teams,
onNoElement: {
+103 -3
View File
@@ -2,6 +2,7 @@ import Foundation
import ArgumentParser
import PackLib
import XKit
import Dependencies
struct PackOperation {
struct BuildOptions: ParsableArguments {
@@ -17,6 +18,9 @@ struct PackOperation {
}
}
static let defaultTriple = "arm64-apple-ios"
var triple: String?
var buildOptions = BuildOptions(configuration: .debug)
var xcode = false
@@ -38,6 +42,7 @@ struct PackOperation {
let buildSettings = try await BuildSettings(
configuration: buildOptions.configuration,
triple: triple ?? Self.defaultTriple,
options: []
)
@@ -85,8 +90,50 @@ struct DevBuildCommand: AsyncParsableCommand {
@OptionGroup var packOptions: PackOperation.BuildOptions
@Flag(
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 {
try await PackOperation(buildOptions: packOptions).run()
let url = try await PackOperation(
triple: triple,
buildOptions: packOptions
).run()
let finalURL: URL
if ipa {
@Dependency(\.zipCompressor) var compressor
finalURL = url.deletingPathExtension().appendingPathExtension("ipa")
let tmpDir = try TemporaryDirectory(name: "sh.xtool.tmp")
let payloadDir = tmpDir.url.appendingPathComponent("Payload", isDirectory: true)
try FileManager.default.createDirectory(
at: payloadDir,
withIntermediateDirectories: true
)
try FileManager.default.moveItem(at: url, to: payloadDir.appendingPathComponent(url.lastPathComponent))
let ipaURL = try await compressor.compress(directory: payloadDir) { progress in
if let progress {
let percent = Int(progress * 100)
print("\rPackaging... \(percent)%", terminator: "")
} else {
print("\rPackaging...", terminator: "")
}
}
print()
try? FileManager.default.removeItem(at: finalURL)
try FileManager.default.moveItem(at: ipaURL, to: finalURL)
} else {
finalURL = url
}
print("Wrote to \(finalURL.path)")
}
}
@@ -101,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()
@@ -122,7 +198,14 @@ struct DevRunCommand: AsyncParsableCommand {
defer { print() }
try await installer.install(app: output)
do {
try await installer.install(app: output)
} catch let error as CancellationError {
throw error
} catch {
print("\nError: \(error)")
throw ExitCode.failure
}
}
}
@@ -140,3 +223,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
+4 -2
View File
@@ -34,9 +34,11 @@ struct InstallCommand: AsyncParsableCommand {
do {
try await installer.install(app: URL(fileURLWithPath: path))
print("\nSuccessfully installed!")
} catch let error as CancellationError {
throw error
} catch {
print("\nFailed :(")
print("Error: \(error)")
print("\nError: \(error)")
throw ExitCode.failure
}
}
}
+1 -2
View File
@@ -79,7 +79,7 @@ struct NewCommand: AsyncParsableCommand {
.macOS(.v14),
],
products: [
// An xtool project should contain exactly one library target,
// An xtool project should contain exactly one library product,
// representing the main app.
.library(
name: "\(moduleName)",
@@ -116,7 +116,6 @@ struct NewCommand: AsyncParsableCommand {
.netrc
/xtool
/.sourcekit-lsp
"""
),
@@ -15,7 +15,7 @@ extension ZIPCompressor: DependencyKey {
let zip = Process()
zip.executableURL = try await ToolRegistry.locate("zip")
zip.currentDirectoryURL = dir.deletingLastPathComponent()
zip.arguments = ["-yqru0", dest.path, "Payload"]
zip.arguments = ["-yqru0", dest.path, dir.lastPathComponent]
try await zip.runUntilExit()
return dest
+2 -2
View File
@@ -149,7 +149,7 @@ struct SDKBuilder {
}
private func installToolset(in output: URL) async throws {
// tag from https://github.com/kabiroberai/darwin-tools-linux-llvm
// tag from https://github.com/xtool-org/darwin-tools-linux-llvm
let darwinToolsVersion = "1.0.1"
let toolsetDir = output.appendingPathComponent("toolset")
@@ -169,7 +169,7 @@ struct SDKBuilder {
@Dependency(\.httpClient) var httpClient
let url = URL(string: """
https://github.com/kabiroberai/darwin-tools-linux-llvm/releases/download/\
https://github.com/xtool-org/darwin-tools-linux-llvm/releases/download/\
v\(darwinToolsVersion)/toolset-\(arch.rawValue).tar.gz
""")!
let (response, body) = try await httpClient.send(HTTPRequest(url: url))
+62 -32
View File
@@ -13,6 +13,7 @@ struct SDKCommand: AsyncParsableCommand {
DevSDKInstallCommand.self,
DevSDKRemoveCommand.self,
DevSDKBuildCommand.self,
DevSDKStatusCommand.self,
],
defaultSubcommand: DevSDKInstallCommand.self
)
@@ -98,7 +99,7 @@ struct DevSDKRemoveCommand: AsyncParsableCommand {
)
func run() async throws {
guard let sdk = try DarwinSDK.current() else {
guard let sdk = try await DarwinSDK.current() else {
throw Console.Error("Cannot remove SDK: no Darwin SDK installed")
}
try sdk.remove()
@@ -106,11 +107,22 @@ struct DevSDKRemoveCommand: AsyncParsableCommand {
}
}
struct DarwinSDK {
private static let sdksDir = URL(fileURLWithPath: NSHomeDirectory())
.appendingPathComponent(".swiftpm/swift-sdks")
.resolvingSymlinksInPath()
struct DevSDKStatusCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
commandName: "status",
abstract: "Get the status of the Darwin Swift SDK"
)
func run() async throws {
if let sdk = try await DarwinSDK.current() {
print("Installed at \(sdk.bundle.path)")
} else {
print("Not installed")
}
}
}
struct DarwinSDK {
let bundle: URL
let version: String
@@ -126,35 +138,55 @@ struct DarwinSDK {
}
}
@discardableResult
static func install(movingFrom path: String) throws -> DarwinSDK {
static func install(from path: String) async throws {
// we can't just move into ~/.swiftpm/swift-sdks because the swiftpm directory
// location depends on factors like $XDG_CONFIG_HOME. Rather than replicating
// SwiftPM's logic, which may change, it's more reliable to directly invoke
// `swift sdk install`. See: https://github.com/xtool-org/xtool/pull/40
let url = URL(fileURLWithPath: path)
guard DarwinSDK(bundle: url) != nil else { throw Console.Error("Invalid Darwin SDK at '\(path)'")}
let targetURL = sdksDir.appendingPathComponent("darwin.artifactbundle")
if targetURL.exists {
throw Console.Error("Darwin SDK is already installed at '\(targetURL.path)'. Please remove it first.")
}
try FileManager.default.moveItem(at: url, to: targetURL)
guard let sdk = DarwinSDK(bundle: targetURL) else {
throw Console.Error("Darwin SDK failed to install")
}
return sdk
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "install", url.path]
try await process.runUntilExit()
}
static func current() throws -> DarwinSDK? {
let sdks = (try? FileManager.default.contentsOfDirectory(at: sdksDir, includingPropertiesForKeys: nil)) ?? []
let darwinSDKs = sdks.compactMap { DarwinSDK(bundle: $0) }
switch darwinSDKs.count {
case 0:
static func current() async throws -> DarwinSDK? {
let output = Pipe()
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "configure", "darwin", "arm64-apple-ios", "--show-configuration"]
process.standardOutput = output
process.standardError = FileHandle.nullDevice
async let outputData = Data(reading: output.fileHandleForReading)
do {
try await process.runUntilExit()
} catch Process.Failure.exit {
return nil
case 1:
return darwinSDKs[0]
default:
throw Console.Error("""
You have multiple copies of the Darwin SDK installed. Please delete all but one to continue.
\(darwinSDKs.map { "- \($0.bundle.path) (version '\($0.version)')" }.joined(separator: "\n"))
""")
}
// should be something like
// swiftResourcesPath: /home/user/.swiftpm/swift-sdks/darwin.artifactbundle/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift
let resourcesPathPrefix = "swiftResourcesPath: "
let outputString = String(decoding: try await outputData, as: UTF8.self)
guard let resourcesPath = outputString
.split(separator: "\n")
.first(where: { $0.hasPrefix(resourcesPathPrefix) })?
.dropFirst(resourcesPathPrefix.count)
else { return nil }
var resourcesURL = URL(fileURLWithPath: String(resourcesPath))
for _ in 0..<6 {
resourcesURL = resourcesURL.deletingLastPathComponent()
}
return DarwinSDK(bundle: resourcesURL)
}
func isUpToDate() -> Bool {
@@ -209,7 +241,7 @@ struct InstallSDKOperation {
#if os(macOS)
print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
#else
if let sdk = try DarwinSDK.current() {
if let sdk = try await DarwinSDK.current() {
print("Removing existing SDK...")
try sdk.remove()
}
@@ -221,12 +253,10 @@ struct InstallSDKOperation {
let builder = SDKBuilder(input: input, outputPath: tempDir.url.path, arch: arch)
let sdkPath = try await builder.buildSDK()
try DarwinSDK.install(movingFrom: sdkPath)
try await DarwinSDK.install(from: sdkPath)
// don't destroy tempDir before this point
withExtendedLifetime(tempDir) {}
print("Installed darwin.artifactbundle")
#endif
}
}
+4 -2
View File
@@ -25,9 +25,11 @@ struct SetupOperation {
try await AuthOperation(logoutFromExisting: false, quiet: quiet).run()
#if os(macOS)
print("Skipping Darwin SDK setup since we're on macOS.")
if !quiet {
print("Skipping Darwin SDK setup since we're on macOS.")
}
#else
switch try DarwinSDK.current()?.isUpToDate() {
switch try await DarwinSDK.current()?.isUpToDate() {
case true?:
if !quiet {
print("Darwin SDK is up to date.")
+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",
-4
View File
@@ -9,13 +9,9 @@ enum XToolMain {
static func main() async throws {
prepareDependencies { dependencies in
#warning("Improve persistence mechanism")
// for macOS, we can use KeychainStorage but we need to sign with entitlements.
// for Windows, we could use dpapi.h or wincred.h.
// for Linux, maybe use libsecret?
// see https://github.com/atom/node-keytar
// #if os(macOS)
// dependencies.keyValueStorage = KeychainStorage(service: "com.kabiroberai.xtool-keychain.credentials")
// #endif
}
try await XTool.run()
}
+7
View File
@@ -0,0 +1,7 @@
/XToolMac.xcodeproj
Private*.xcconfig
/fastlane/README.md
/fastlane/report.xml
/Build
/Private
+1
View File
@@ -0,0 +1 @@
3.4.3
+9
View File
@@ -0,0 +1,9 @@
source 'https://rubygems.org'
gem 'fastlane'
gem 'fastlane-plugin-xcodegen'
# https://github.com/fastlane/fastlane/issues/29183#issuecomment-2567093826
gem "abbrev"
gem "mutex_m"
gem "ostruct"
+236
View File
@@ -0,0 +1,236 @@
GEM
remote: https://rubygems.org/
specs:
CFPropertyList (3.0.7)
base64
nkf
rexml
abbrev (0.1.2)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
artifactory (3.0.17)
atomos (0.1.3)
aws-eventstream (1.3.2)
aws-partitions (1.1102.0)
aws-sdk-core (3.223.0)
aws-eventstream (~> 1, >= 1.3.0)
aws-partitions (~> 1, >= 1.992.0)
aws-sigv4 (~> 1.9)
base64
jmespath (~> 1, >= 1.6.1)
logger
aws-sdk-kms (1.100.0)
aws-sdk-core (~> 3, >= 3.216.0)
aws-sigv4 (~> 1.5)
aws-sdk-s3 (1.185.0)
aws-sdk-core (~> 3, >= 3.216.0)
aws-sdk-kms (~> 1)
aws-sigv4 (~> 1.5)
aws-sigv4 (1.11.0)
aws-eventstream (~> 1, >= 1.0.2)
babosa (1.0.4)
base64 (0.2.0)
claide (1.1.0)
colored (1.2)
colored2 (3.1.2)
commander (4.6.0)
highline (~> 2.0.0)
declarative (0.0.20)
digest-crc (0.7.0)
rake (>= 12.0.0, < 14.0.0)
domain_name (0.6.20240107)
dotenv (2.8.1)
emoji_regex (3.2.3)
excon (0.112.0)
faraday (1.10.4)
faraday-em_http (~> 1.0)
faraday-em_synchrony (~> 1.0)
faraday-excon (~> 1.1)
faraday-httpclient (~> 1.0)
faraday-multipart (~> 1.0)
faraday-net_http (~> 1.0)
faraday-net_http_persistent (~> 1.0)
faraday-patron (~> 1.0)
faraday-rack (~> 1.0)
faraday-retry (~> 1.0)
ruby2_keywords (>= 0.0.4)
faraday-cookie_jar (0.0.7)
faraday (>= 0.8.0)
http-cookie (~> 1.0.0)
faraday-em_http (1.0.0)
faraday-em_synchrony (1.0.0)
faraday-excon (1.1.0)
faraday-httpclient (1.0.1)
faraday-multipart (1.1.0)
multipart-post (~> 2.0)
faraday-net_http (1.0.2)
faraday-net_http_persistent (1.2.0)
faraday-patron (1.0.0)
faraday-rack (1.0.0)
faraday-retry (1.0.3)
faraday_middleware (1.2.1)
faraday (~> 1.0)
fastimage (2.4.0)
fastlane (2.227.2)
CFPropertyList (>= 2.3, < 4.0.0)
addressable (>= 2.8, < 3.0.0)
artifactory (~> 3.0)
aws-sdk-s3 (~> 1.0)
babosa (>= 1.0.3, < 2.0.0)
bundler (>= 1.12.0, < 3.0.0)
colored (~> 1.2)
commander (~> 4.6)
dotenv (>= 2.1.1, < 3.0.0)
emoji_regex (>= 0.1, < 4.0)
excon (>= 0.71.0, < 1.0.0)
faraday (~> 1.0)
faraday-cookie_jar (~> 0.0.6)
faraday_middleware (~> 1.0)
fastimage (>= 2.1.0, < 3.0.0)
fastlane-sirp (>= 1.0.0)
gh_inspector (>= 1.1.2, < 2.0.0)
google-apis-androidpublisher_v3 (~> 0.3)
google-apis-playcustomapp_v1 (~> 0.1)
google-cloud-env (>= 1.6.0, < 2.0.0)
google-cloud-storage (~> 1.31)
highline (~> 2.0)
http-cookie (~> 1.0.5)
json (< 3.0.0)
jwt (>= 2.1.0, < 3)
mini_magick (>= 4.9.4, < 5.0.0)
multipart-post (>= 2.0.0, < 3.0.0)
naturally (~> 2.2)
optparse (>= 0.1.1, < 1.0.0)
plist (>= 3.1.0, < 4.0.0)
rubyzip (>= 2.0.0, < 3.0.0)
security (= 0.1.5)
simctl (~> 1.6.3)
terminal-notifier (>= 2.0.0, < 3.0.0)
terminal-table (~> 3)
tty-screen (>= 0.6.3, < 1.0.0)
tty-spinner (>= 0.8.0, < 1.0.0)
word_wrap (~> 1.0.0)
xcodeproj (>= 1.13.0, < 2.0.0)
xcpretty (~> 0.4.1)
xcpretty-travis-formatter (>= 0.0.3, < 2.0.0)
fastlane-plugin-brew (0.1.1)
fastlane-plugin-xcodegen (1.1.0)
fastlane-plugin-brew (~> 0.1.1)
fastlane-sirp (1.0.0)
sysrandom (~> 1.0)
gh_inspector (1.1.3)
google-apis-androidpublisher_v3 (0.54.0)
google-apis-core (>= 0.11.0, < 2.a)
google-apis-core (0.11.3)
addressable (~> 2.5, >= 2.5.1)
googleauth (>= 0.16.2, < 2.a)
httpclient (>= 2.8.1, < 3.a)
mini_mime (~> 1.0)
representable (~> 3.0)
retriable (>= 2.0, < 4.a)
rexml
google-apis-iamcredentials_v1 (0.17.0)
google-apis-core (>= 0.11.0, < 2.a)
google-apis-playcustomapp_v1 (0.13.0)
google-apis-core (>= 0.11.0, < 2.a)
google-apis-storage_v1 (0.31.0)
google-apis-core (>= 0.11.0, < 2.a)
google-cloud-core (1.8.0)
google-cloud-env (>= 1.0, < 3.a)
google-cloud-errors (~> 1.0)
google-cloud-env (1.6.0)
faraday (>= 0.17.3, < 3.0)
google-cloud-errors (1.5.0)
google-cloud-storage (1.47.0)
addressable (~> 2.8)
digest-crc (~> 0.4)
google-apis-iamcredentials_v1 (~> 0.1)
google-apis-storage_v1 (~> 0.31.0)
google-cloud-core (~> 1.6)
googleauth (>= 0.16.2, < 2.a)
mini_mime (~> 1.0)
googleauth (1.8.1)
faraday (>= 0.17.3, < 3.a)
jwt (>= 1.4, < 3.0)
multi_json (~> 1.11)
os (>= 0.9, < 2.0)
signet (>= 0.16, < 2.a)
highline (2.0.3)
http-cookie (1.0.8)
domain_name (~> 0.5)
httpclient (2.9.0)
mutex_m
jmespath (1.6.2)
json (2.11.3)
jwt (2.10.1)
base64
logger (1.7.0)
mini_magick (4.13.2)
mini_mime (1.1.5)
multi_json (1.15.0)
multipart-post (2.4.1)
mutex_m (0.3.0)
nanaimo (0.4.0)
naturally (2.2.1)
nkf (0.2.0)
optparse (0.6.0)
os (1.1.4)
ostruct (0.6.1)
plist (3.7.2)
public_suffix (6.0.2)
rake (13.2.1)
representable (3.2.0)
declarative (< 0.1.0)
trailblazer-option (>= 0.1.1, < 0.2.0)
uber (< 0.2.0)
retriable (3.1.2)
rexml (3.4.1)
rouge (3.28.0)
ruby2_keywords (0.0.5)
rubyzip (2.4.1)
security (0.1.5)
signet (0.20.0)
addressable (~> 2.8)
faraday (>= 0.17.5, < 3.a)
jwt (>= 1.5, < 3.0)
multi_json (~> 1.10)
simctl (1.6.10)
CFPropertyList
naturally
sysrandom (1.0.5)
terminal-notifier (2.0.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
trailblazer-option (0.1.2)
tty-cursor (0.7.1)
tty-screen (0.8.2)
tty-spinner (0.9.3)
tty-cursor (~> 0.7)
uber (0.1.0)
unicode-display_width (2.6.0)
word_wrap (1.0.0)
xcodeproj (1.27.0)
CFPropertyList (>= 2.3.3, < 4.0)
atomos (~> 0.1.3)
claide (>= 1.0.2, < 2.0)
colored2 (~> 3.1)
nanaimo (~> 0.4.0)
rexml (>= 3.3.6, < 4.0)
xcpretty (0.4.1)
rouge (~> 3.28.0)
xcpretty-travis-formatter (1.0.1)
xcpretty (~> 0.2, >= 0.0.7)
PLATFORMS
arm64-darwin-24
ruby
DEPENDENCIES
abbrev
fastlane
fastlane-plugin-xcodegen
mutex_m
ostruct
BUNDLED WITH
2.6.7
+11
View File
@@ -0,0 +1,11 @@
# macOS Packaging
xtool is packaged as a .app bundle on macOS, so that we can add entitlements and use the keychain.
Ideally we'd dogfood xtool to package xtool, but it only supports iOS apps right now. Someday, hopefully.
## Building
1. Install [XcodeGen](https://github.com/yonaskolb/XcodeGen)
2. Run `xcodegen` inside this (`./macOS`) directory
3. Open the Xcode project and build the `XToolMac` scheme
+22
View File
@@ -0,0 +1,22 @@
#!/bin/bash
# https://github.com/microsoft/vscode/blob/509cc674f24d87a298d56518c318de67bda357cb/resources/darwin/bin/code.sh
function app_realpath() {
SOURCE="$1"
while [ -h "$SOURCE" ]; do
DIR=$(/usr/bin/dirname "$SOURCE")
SOURCE=$(/usr/bin/readlink "$SOURCE")
[[ "$SOURCE" != /* ]] && SOURCE="$DIR/$SOURCE"
done
SOURCE_DIR="$( cd -P "$( /usr/bin/dirname "$SOURCE" )" >/dev/null 2>&1 && echo "$PWD" )"
echo "${SOURCE_DIR%%${SOURCE_DIR#*.app}}"
}
APP_PATH="$(app_realpath "${BASH_SOURCE[0]}")"
if [ -z "$APP_PATH" ]; then
echo "Unable to determine app path from symlink : ${BASH_SOURCE[0]}"
exit 1
fi
XTL_CLI=1 "$APP_PATH/Contents/MacOS/xtool" "$@"
+12
View File
@@ -0,0 +1,12 @@
GENERATE_INFOPLIST_FILE = YES
CODE_SIGN_ENTITLEMENTS = Support/XToolMac.entitlements
CODE_SIGN_STYLE = Automatic
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
View File
@@ -0,0 +1 @@
#include "Base.xcconfig"
+1
View File
@@ -0,0 +1 @@
#include "Base.xcconfig"
+10
View File
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>keychain-access-groups</key>
<array>
<string>$(AppIdentifierPrefix)sh.xtool.keychain</string>
</array>
</dict>
</plist>
+24
View File
@@ -0,0 +1,24 @@
import Foundation
import Dependencies
import XToolSupport
import XKit
@main enum XToolMacMain {
static func main() async throws {
// the bin/xtool script invokes us with this env var, allowing us to
// detect command-line invocations vs a UI app launch
if ProcessInfo.processInfo.environment["XTL_CLI"] == "1" {
try await runXTool()
} else {
XToolMacUI.main()
}
}
private static func runXTool() async throws {
try await withDependencies {
$0.keyValueStorage = KeychainStorage(service: "sh.xtool.keychain.credentials")
} operation: {
try await XTool.run()
}
}
}
+79
View File
@@ -0,0 +1,79 @@
import SwiftUI
struct XToolMacUI: App {
var body: some Scene {
WindowGroup {
ContentView()
}
.disableWindowResizingIfPossible()
}
}
private struct ContentView: View {
private static let command = """
sudo ln -fs /Applications/xtool.app/Contents/Resources/bin/xtool /usr/local/bin/xtool
"""
var body: some View {
VStack(alignment: .leading, spacing: 16) {
StepView(1) {
Text("Move this app into your `/Applications` folder.")
}
StepView(2) {
VStack(alignment: .leading, spacing: 16) {
Text("Symlink xtool into a location on your `PATH`.")
Text(Self.command)
.font(.body.monospaced())
.textSelection(.enabled)
Button("Copy Command") {
NSPasteboard.general.clearContents()
NSPasteboard.general.setString(Self.command, forType: .string)
}
}
}
}
.padding()
.padding(.vertical)
.frame(width: 500)
.fixedSize()
.navigationTitle("xtool")
}
}
private struct StepView<Content: View>: View {
let number: Int
let content: Content
init(_ number: Int, @ViewBuilder content: () -> Content) {
self.number = number
self.content = content()
}
var body: some View {
HStack(alignment: .firstTextBaseline) {
Text("\(number)")
.foregroundStyle(.background)
.padding(8)
.background(.secondary, in: .circle)
content
}
}
}
extension Scene {
fileprivate func disableWindowResizingIfPossible() -> some Scene {
if #available(macOS 13, *) {
return self.windowResizability(.contentSize)
} else {
return self
}
}
}
#Preview {
ContentView()
}
+1
View File
@@ -0,0 +1 @@
app_identifier("sh.xtool.XToolMac")
+66
View File
@@ -0,0 +1,66 @@
default_platform(:mac)
ENV["FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT"] = "120"
lane :package do
xcodegen
# Config is controlled via env vars
app_store_connect_api_key(
is_key_content_base64: true,
)
create_keychain(
name: "xtool.keychain",
password: "",
unlock: true,
)
unlock_keychain(
path: "xtool.keychain",
password: "",
)
Tempfile.create(["Identity", ".p12"]) do |file|
file.write(Base64.decode64(ENV["IDENTITY_P12"]))
file.close
import_certificate(
certificate_path: file.path,
keychain_name: "xtool.keychain",
keychain_password: "",
)
end
sigh(
platform: "macos",
output_path: "./Build/Signing",
force: true,
developer_id: true,
)
update_code_signing_settings(
use_automatic_signing: false,
team_id: ENV["DEVELOPMENT_TEAM"],
code_sign_identity: "Developer ID Application",
profile_name: lane_context[SharedValues::SIGH_NAME],
)
gym(
export_method: "developer-id",
output_directory: "./Build/Output",
)
notarize(
package: "./Build/Output/xtool.app",
)
# we need to re-package after notarization and stapling.
# we have to use `ditto --sequesterRsrc` rather than zip
# because the default strategy stores resource forks as
# ._Foo but codesigning doesn't like that, and instead
# wants them in __MACOSX.
sh(
"ditto", "-c", "-k", "--keepParent", "--sequesterRsrc",
"../Build/Output/xtool.app", "../Build/Output/xtool.app.zip",
)
end
+27
View File
@@ -0,0 +1,27 @@
name: XToolMac
options:
bundleIdPrefix: sh.xtool
packages:
xtool:
path: ..
group: ""
fileGroups:
- Support
targets:
XToolMac:
type: application
platform: macOS
deploymentTarget: "12.0"
sources:
- path: XToolMac
- path: Resources/xtool
buildPhase:
copyFiles:
destination: resources
subpath: bin
configFiles:
Debug: Support/Debug.xcconfig
Release: Support/Release.xcconfig
dependencies:
- package: xtool
product: XToolSupport
+44
View File
@@ -0,0 +1,44 @@
[build]
# by setting a custom base directory, we prevent Netlify from running
# `swift build` in the root directory, which builds more targets than
# we need.
base = "Documentation/"
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"
[[redirects]]
from = "/"
to = "/documentation/xtool/"
status = 302
force = true
[[redirects]]
from = "/documentation"
to = "/documentation/xtool/"
status = 302
force = true
[[redirects]]
from = "/tutorials"
to = "/tutorials/xtool"
status = 302
force = true
# --- Backwards compatibility ---
[[redirects]]
from = "/tutorials/toc"
to = "/tutorials/xtool"
status = 302
[[redirects]]
from = "/documentation/xtooldocs/*"
to = "/documentation/xtool/:splat"
status = 302
[[redirects]]
from = "/tutorials/xtooldocs/*"
to = "/tutorials/xtool/:splat"
status = 302
+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"