-
Notifications
You must be signed in to change notification settings - Fork 0
Set up Tuist project, AGENTS.md, and GitHub CI #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| test: | ||
| name: Build & Test | ||
| runs-on: macos-26 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: jdx/mise-action@v3 | ||
| - run: tuist test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [tools] | ||
| tuist = "4.40.0" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Stuff – Repository Shape | ||
|
|
||
| ## Build system | ||
|
|
||
| | Tool | Version | Pinned via | | ||
| |-------|---------|--------------| | ||
| | Tuist | 4.40.0 | `.mise.toml` | | ||
|
|
||
| Tuist manifests live at the repo root (`Project.swift`, `Tuist.swift`). | ||
| Run `./ide` (or `./ide -i` to also install dependencies) to regenerate the | ||
| Xcode project. | ||
|
|
||
| ## Targets | ||
|
|
||
| _No apps or modules yet._ Add targets to `Project.swift` using `macApp()` or `framework()` helpers. | ||
|
|
||
| ## Deployment | ||
|
|
||
| | Platform | Minimum OS | | ||
| |------------------------------|-------------| | ||
| | iPhone, iPad, Mac Catalyst | iOS 26.0 | | ||
| | macOS (native) | macOS 26.0 | | ||
|
|
||
| ## Directory layout | ||
|
|
||
| ``` | ||
| <TargetName>/ | ||
| Sources/ – production code | ||
| Tests/ – unit tests (Swift Testing, not XCTest) | ||
| Resources/ – asset catalogs, etc. (apps only) | ||
| ``` | ||
|
|
||
| ## Conventions | ||
|
|
||
| - **Swift Testing** (`import Testing`) for all unit tests – do not use XCTest. | ||
| - Generated `.xcodeproj` and `Derived/` are git-ignored; never commit them. | ||
| - Bundle IDs follow `com.stuff.<suffix>`. | ||
|
|
||
| ## Plans | ||
|
|
||
| Implementation plans go in `Plans/` and are named | ||
| `<NNN>-<YYYY-MM-DD>-<slug>.md`. |
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import ProjectDescription | ||
|
|
||
| let macDestinations: Destinations = [.mac] | ||
| let macDeployment: DeploymentTargets = .macOS("26.0") | ||
|
|
||
| func framework( | ||
| _ name: String, | ||
| bundleIdSuffix: String, | ||
| dependencies: [TargetDependency] = [] | ||
| ) -> [Target] { | ||
| [ | ||
| .target( | ||
| name: name, | ||
| destinations: macDestinations, | ||
| product: .framework, | ||
| bundleId: "com.stuff.\(bundleIdSuffix)", | ||
| deploymentTargets: macDeployment, | ||
| sources: ["\(name)/Sources/**"], | ||
| dependencies: dependencies | ||
| ), | ||
| .target( | ||
| name: "\(name)Tests", | ||
| destinations: macDestinations, | ||
| product: .unitTests, | ||
| bundleId: "com.stuff.\(bundleIdSuffix).tests", | ||
| deploymentTargets: macDeployment, | ||
| sources: ["\(name)/Tests/**"], | ||
| dependencies: [.target(name: name)] | ||
| ), | ||
| ] | ||
| } | ||
|
|
||
| func macApp( | ||
| _ name: String, | ||
| bundleIdSuffix: String, | ||
| infoPlist: [String: Plist.Value] = [:], | ||
| dependencies: [TargetDependency] = [] | ||
| ) -> [Target] { | ||
| [ | ||
| .target( | ||
| name: name, | ||
| destinations: macDestinations, | ||
| product: .app, | ||
| bundleId: "com.stuff.\(bundleIdSuffix)", | ||
| deploymentTargets: macDeployment, | ||
| infoPlist: .extendingDefault(with: infoPlist), | ||
| sources: ["\(name)/Sources/**"], | ||
| resources: ["\(name)/Resources/**"], | ||
| dependencies: dependencies | ||
| ), | ||
| .target( | ||
| name: "\(name)Tests", | ||
| destinations: macDestinations, | ||
| product: .unitTests, | ||
| bundleId: "com.stuff.\(bundleIdSuffix).tests", | ||
| deploymentTargets: macDeployment, | ||
| sources: ["\(name)/Tests/**"], | ||
| dependencies: [.target(name: name)] | ||
| ), | ||
| ] | ||
| } | ||
|
|
||
| let project = Project( | ||
| name: "Stuff", | ||
| options: .options( | ||
| defaultKnownRegions: ["en"], | ||
| developmentRegion: "en" | ||
| ), | ||
| targets: [] | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,36 @@ | ||
| # Stuff | ||
| Random apps and stuff | ||
|
|
||
| Random apps and stuff. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Xcode 26+ | ||
| - [mise](https://mise.jdx.dev) (manages Tuist version) | ||
| - iOS 26.0+ | ||
|
|
||
| ## Getting started | ||
|
|
||
| ```bash | ||
| # Install mise (if needed) | ||
| brew install mise | ||
|
|
||
| # Generate the Xcode project | ||
| ./ide | ||
|
|
||
| # Or install dependencies first, then generate | ||
| ./ide -i | ||
| ``` | ||
|
|
||
| ## Project structure | ||
|
|
||
| ``` | ||
| Project.swift Tuist project manifest | ||
| Tuist.swift Tuist configuration | ||
| .mise.toml Pins Tuist 4.40.0 | ||
| ide Dev script – regenerates Xcode project | ||
| AGENTS.md Repository shape for AI agents | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Apache 2.0 – see [LICENSE](LICENSE). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| import ProjectDescription | ||
|
|
||
| let config = Config() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| #!/bin/bash | ||
| set -euo pipefail | ||
|
|
||
| INSTALL=false | ||
|
|
||
| for arg in "$@"; do | ||
| case "$arg" in | ||
| -i|--install) | ||
| INSTALL=true | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| if [ "$INSTALL" = true ]; then | ||
| echo "==> tuist install" | ||
| mise exec -- tuist install | ||
| fi | ||
|
|
||
| echo "==> tuist generate" | ||
| mise exec -- tuist generate |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Framework helper destinations incompatible with macApp targets
Medium Severity
The
framework()helper usesmobileDestinations([.iPhone, .iPad, .macCatalyst]) whilemacApp()usesmacDestinations([.mac]). Since.macCatalystand.macare distinct Tuist destinations with incompatible platform binaries, a native Mac app created withmacApp()cannot depend on a framework created withframework(). The two primary helpers documented inAGENTS.mdas the way to add targets cannot actually compose together.Additional Locations (1)
Project.swift#L35-L64