Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosmo/shotplan
A command line tool that calls your Xcode Test Plan and creates screenshots of your app automatically.
https://github.com/cosmo/shotplan
Last synced: 14 days ago
JSON representation
A command line tool that calls your Xcode Test Plan and creates screenshots of your app automatically.
- Host: GitHub
- URL: https://github.com/cosmo/shotplan
- Owner: Cosmo
- License: mit
- Created: 2022-07-16T05:32:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-08T12:55:09.000Z (over 2 years ago)
- Last Synced: 2023-03-23T23:58:49.913Z (over 1 year ago)
- Language: Swift
- Size: 31.3 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ShotPlan (WIP)
A command line tool that calls your Xcode Test Plan and creates screenshots of your app automatically.
ShotPlan will also take care of the status bar in your screenshots.
## Installation
### [Mint](https://github.com/yonaskolb/mint)
```sh
mint install Cosmo/ShotPlan@main
```
## Requirements
ShotPlan requires xcparse to be installed.
```sh
brew install chargepoint/xcparse/xcparse
```
## Configuration
Change to your Xcode project directory and run the `shotplan init` command to create a new configuration file.
Don't forget to replace the placeholders `YOUR_SCHEME` and `YOUR_TESTPLAN`.
```sh
shotplan init -s YOUR_SCHEME -t YOUR_TESTPLAN
```
This will create a file called `ShotPlan.json` that looks like this:
```json
{
"scheme" : "YOUR_SCHEME",
"devices" : [
{
"homeStyle" : "indicator",
"displaySize" : "6.5",
"simulatorName" : "iPhone 11 Pro Max"
},
{
"homeStyle" : "button",
"displaySize" : "5.5",
"simulatorName" : "iPhone 8 Plus"
},
{
"homeStyle" : "indicator",
"displaySize" : "12.9",
"simulatorName" : "iPad Pro (12.9-inch) (5th generation)"
}
],
"testPlan" : "YOUR_TESTPLAN"
}
```
## Usage
Run the following command:
```sh
shotplan run
```
ShotPlan will create a `Screenshots` directory in your project with all the screenshots of the devices in your configuration and the screens in your Test Plan.