Skip to content

Commit

Permalink
Fix doc and pull request template issues (tuist#6408)
Browse files Browse the repository at this point in the history
* Update get-started.md

Fix a tiny typo.

* Fix broken link

* Lint fix

* Fix lint fix command checklist guide
  • Loading branch information
Binlogo authored Jun 16, 2024
1 parent cdb9197 commit 205ba32
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Resolves https://github.com/tuist/tuist/issues/YYY
Resolves <https://github.com/tuist/tuist/issues/YYY>

### Short description 📝

> Describe here the purpose of your PR.
### How to test the changes locally 🧐

> Include a set of steps for the reviewer to test the changes locally (see [the documentation](https://docs.tuist.io/contributors/testing-strategy) for reference).
> Include a set of steps for the reviewer to test the changes locally (see [the documentation](https://docs.tuist.io/contributors/get-started) for reference).
### Contributor checklist ✅

- [ ] The code has been linted using run `mise run lint:fix`
- [ ] The code has been linted using run `mise run lint-fix`
- [ ] The change is tested via unit testing or acceptance testing, or both
- [ ] The title of the PR is formulated in a way that is usable as a changelog entry
- [ ] In case the PR introduces changes that affect users, the documentation has been updated
Expand Down
2 changes: 2 additions & 0 deletions Sources/TuistCore/Graph/GraphLoader.swift
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ public final class GraphLoader: GraphLoading {
source: .system
)
}

case let .package(product, type, _):
switch type {
case .macro:
Expand All @@ -186,6 +187,7 @@ public final class GraphLoader: GraphLoading {
case .plugin:
return try loadPackage(fromPath: path, productName: product, type: .plugin)
}

case .xctest:
return try platforms.map { platform in
try loadXCTestSDK(platform: platform)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ final class WorkspaceDescriptorGenerator: WorkspaceDescriptorGenerating {
)

return .group(groupReference)

case let .virtualGroup(name, contents):
return .group(.init(location: .container(""), name: name, children: try contents.map {
try recursiveChildElement(
Expand All @@ -246,6 +247,7 @@ final class WorkspaceDescriptorGenerator: WorkspaceDescriptorGenerating {
path: path
)
}.sorted(by: workspaceDataElementSort)))

case let .project(path: projectPath):
guard generatedProjects[projectPath] != nil else {
throw WorkspaceDescriptorGeneratorError.projectNotFound(path: projectPath)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ struct SettingsMapper {
case (.linker, .linkedFramework), (.linker, .linkedLibrary):
// Handled as dependency
continue

case (.c, .linkedFramework), (.c, .linkedLibrary), (.cxx, .linkedFramework), (.cxx, .linkedLibrary),
(.swift, .headerSearchPath), (.swift, .linkedFramework), (.swift, .linkedLibrary),
(.linker, .headerSearchPath), (.linker, .define), (_, .enableUpcomingFeature),
Expand Down
9 changes: 4 additions & 5 deletions docs/docs/contributors/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get started
titleTemplate: ':title - Contribute to Tuist'
description: Get started contributing to Tuist by following this guide.
---

# Get started

If you have experience building apps for Apple platforms, like iOS, adding code to Tuist shouldn’t be much different. There are two differences compared to developing apps that are worth mentioning:
Expand Down Expand Up @@ -31,7 +30,7 @@ To start working on the project, we can follow the steps below:
- Run `tuist install` to install the external dependencies needed by Tuist
- Run `tuist generate` to generate the Tuist Xcode project using Tuist itself

**The generated project opens automatically**. If you need to open again without generating it, run open `Tuist.xcworkspace` (or ue Finder).
**The generated project opens automatically**. If you need to open again without generating it, run open `Tuist.xcworkspace` (or use Finder).

> [!NOTE] XED .
> If you try to open the project using `xed .`, it will open the package, and not the project generated by Tuist. We recommend using the Tuist-generated project to dog-food the tool.
Expand All @@ -44,12 +43,11 @@ If you needed to edit the project, for example to add dependencies or adjust tar

### From Xcode


To run `tuist` from the generated Xcode project, edit the `tuist` scheme, and set the arguments that you'd like to pass to the command. For example, to run the `tuist generate` command, you can set the arguments to `generate --no-open` to prevent the project from opening after the generation.

![An example of a scheme configuration to run the generate command with Tuist](./scheme-arguments.png)

You'll also have to set the working directory to the root of the project being generated. You can do that either by using the `--path` argument, which all the commmands accept, or configuring the working directory in the scheme as shown below:
You'll also have to set the working directory to the root of the project being generated. You can do that either by using the `--path` argument, which all the commands accept, or configuring the working directory in the scheme as shown below:

![An example of how to set the working directory to run Tuist](./scheme-working-directory.png)

Expand All @@ -63,4 +61,5 @@ Although `tuist` provides a [run command](/guide/automation/run) it does not sup
```bash
swift build --product ProjectDescription
swift run tuist generate --path /path/to/project --no-open
```
```

0 comments on commit 205ba32

Please sign in to comment.