https://github.com/cypherpoet/xcteststarterkit

Lightweight Starter Utilities for Swift project testing with XCTest
https://github.com/cypherpoet/xcteststarterkit

swift swift-packages swift-testing tdd testing xctest

Last synced: 16 days ago
JSON representation

Lightweight Starter Utilities for Swift project testing with XCTest

• Host: GitHub
• URL: https://github.com/cypherpoet/xcteststarterkit
• Owner: CypherPoet
• License: mit
• Created: 2021-02-25T04:38:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-20T20:30:14.000Z (over 3 years ago)
• Last Synced: 2024-12-18T06:34:16.784Z (about 2 months ago)
• Topics: swift, swift-packages, swift-testing, tdd, testing, xctest
• Language: Swift
• Homepage:
• Size: 4.29 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# XCTestStarterKit



   





    

    

    

    

    

    

    

    

    

      

    

    

        

    





_Lightweight starter utilities for Swift project testing with XCTest._



## Installation

### Xcode Projects

Select `File` -> `Swift Packages` -> `Add Package Dependency` and enter `https://github.com/CypherPoet/XCTestStarterKit`.

### Swift Package Manager Projects

You can add `XCTestStarterKit` as a package dependency in your `Package.swift` file:

```swift

let package = Package(

    //...

    dependencies: [

        .package(url: "https://github.com/CypherPoet/XCTestStarterKit", .exact("0.0.3")),

    ],

    //...

)

```

From there, refer to `XCTestStarterKit` as a "target dependency" in any of _your_ package's targets that need it. (This will likely be a test target.)

```swift

targets: [

    .testTarget(

        name: "YourProjectTests",

        dependencies: [

            "YourProject",

            "XCTestStarterKit",

        ],

        path: "Tests/",

    ...

]

```

Then simply `import XCTestStarterKit` wherever you’d like to use it.

## Contributing

Contributions to `XCTestStarterKit` are most welcome. Check out some of the [issue templates](./.github/ISSUE_TEMPLATE/) for more info.

## 💻 Developing

### Requirements

- Xcode 12.5+ (Recommended)

### 📜 Generating Documentation

Documentation is generated by [Jazzy](https://github.com/realm/jazzy). Installation instructions can be found [here](https://github.com/realm/jazzy#installation), and as soon as you have it set up, docs can be generated simply by running `jazzy` from the command line.

📝 Note that this will only generate the `docs` folder for you to view locally. This folder is being ignored by `git`, as an [action](./.github/workflows/PublishDocumentation.yml) exists to automatically generate docs at the root level and serve them on the project's `gh-pages` branch.

## 🏷 License

`XCTestStarterKit` is available under the MIT license. See the [LICENSE file](./LICENSE) for more info.