Compare commits

...

14 Commits

51 changed files with 324 additions and 51 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: ''
---
+5 -3
View File
@@ -19,12 +19,14 @@ jobs:
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool bash -c "Linux/build.sh && mv Linux/packages/xtool{,-${{ matrix.host.arch }}}.AppImage"
docker compose run --build --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
path: |
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage.zsync
build-mac:
runs-on: macos-15
permissions:
@@ -72,4 +74,4 @@ jobs:
run: |
TAG="${GITHUB_REF##*/}-${GITHUB_SHA:0:7}"
gh release create "$TAG" --draft --title "Draft Release"
gh release upload "$TAG" output/**/*.{AppImage,app.zip,app.dSYM.zip}
gh release upload "$TAG" output/**/*.{AppImage,AppImage.zsync,app.zip,app.dSYM.zip}
+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.
+9 -5
View File
@@ -5,8 +5,8 @@ shopt -s nullglob
cd "$(dirname "$0")"
# installer version
export LINUXDEPLOY_OUTPUT_VERSION="1.0.0"
# release version
export LINUXDEPLOY_OUTPUT_VERSION="latest"
if ! command -v fusermount &>/dev/null; then
# Docker doesn't support FUSE
@@ -21,6 +21,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 +34,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 +43,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 \
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 \
--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
+1
View File
@@ -0,0 +1 @@
/docs
+11
View File
@@ -0,0 +1,11 @@
#!/bin/bash
set -euo pipefail
cd "$(dirname "$0")"
rm -rf docs
swift package --allow-writing-to-package-directory \
generate-documentation --target XToolDocs --disable-indexing \
--output-path docs
+3
View File
@@ -161,5 +161,8 @@ let package = Package(
],
cSettings: cSettings
),
.executableTarget(
name: "XToolDocs"
),
]
)
+4 -4
View File
@@ -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/Windows)](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](Sources/XToolDocs/Documentation.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.
@@ -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(
@@ -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,9 +1,15 @@
# ``xtool``
# ``XToolDocs``
@Metadata {
@DisplayName("xtool")
}
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

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

View File
+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 -33
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,36 +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.createDirectory(at: sdksDir, withIntermediateDirectories: true)
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 {
@@ -210,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()
}
@@ -222,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
}
}
+1 -1
View File
@@ -29,7 +29,7 @@ struct SetupOperation {
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.")
+37
View File
@@ -0,0 +1,37 @@
[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 = "Netlify/"
publish = "docs/"
command = "./build.sh"
environment = { SWIFT_VERSION = "6.1" }
ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Sources/XToolDocs Netlify netlify.toml"
[[redirects]]
from = "/"
to = "/documentation/xtooldocs/"
status = 302
force = true
[[redirects]]
from = "/documentation"
to = "/documentation/xtooldocs/"
status = 302
force = true
[[redirects]]
from = "/tutorials"
to = "/tutorials/toc"
status = 302
force = true
[[redirects]]
from = "/documentation/xtool/*"
to = "/documentation/xtooldocs/:splat"
status = 302
[[redirects]]
from = "/tutorials/xtool/*"
to = "/tutorials/xtooldocs/:splat"
status = 302