jessesquires / nine41 Goto Github PK

Automate overriding the status bars for all running iOS simulators

Home Page: https://www.jessesquires.com/blog/2020/04/13/fully-automating-perfect-status-bar-overrides-for-ios-simulators/

License: MIT License

Swift 88.05% Ruby 11.95%

ios xcode xcrun simulator ios-simulator

nine41's Introduction

Nine41

Automate overriding the status bars for all running iOS simulators

About

Blog posts:

Xcode 11 shipped with simctl status_bar, a tool to override the status bar values in the simulator so you can take perfect screenshots.

However, it has some issues:

The overrides do not persist across launches of the simulator
The numerous override options are difficult to remember
There are no sensible defaults

This script fixes most of those issues. It overrides the status bars for all currently running simulators using "Apple's defaults" — full cellular bars, full wifi bars, full battery, no "carrier" name, and 9:41 for the time.

Requirements

Swift 5.9+
Xcode 15.0+

Installation

Swift Package Manager

Add Nine41 to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/jessesquires/Nine41.git", from: "3.0.0")
]

Alternatively, you can add the package directly via Xcode.

CocoaPods

pod 'Nine41'

Usage

After cloning the repo, you can create a custom bash command:

function nine41() {
  swift run --package-path /PATH/TO/Nine41/
}

Then you can run this from the command line.

Example run with 2 open simulators:

$ nine41
Fixing status bars...
✅ iPhone 8, 65A6C323-E74D-452C-B85E-7F576259E022
✅ iPhone 11, 52E8FAD0-7743-4F85-AA2E-26E4C1275F38

Example run with no open simulators:

$ nine41
Fixing status bars...
❌ No simulators are running. Launch the iOS simulator first.

Automation with Xcode build phases

As described in this post, you can automate your perfect status bars using Xcode build phases.

Add the Swift package to your Xcode project
Add a "Run Script" build phase with the following:

For Swift Package Manager installations:

/usr/bin/xcrun --sdk macosx swift run --package-path "${BUILD_ROOT}/../../SourcePackages/checkouts/Nine41"

For CocoaPods installations:

/usr/bin/xcrun --sdk macosx swift "${PODS_ROOT}/Nine41/Sources/main.swift"

Build and run. Note that simulators must be booted for the script to work, which means the very first run may not produce results but the subsequent runs will.

Contributing

Interested in making contributions to this project? Please review the guides below.

Also, consider sponsoring this project or buying my apps! ✌️

License

Released under an MIT License. See LICENSE for details.

Copyright © 2019-present Jesse Squires.

nine41's People

Contributors

Stargazers

Watchers

Forkers

chouti-dev xta vksmaini v1taly alex-x-x-x-x danielpetroianu tfe carabina tibimac j-mendes loganisitt ricsantos aoenth jkleroy iq-scm

nine41's Issues

self.waitUntilExit() hangs

Thank you so much for giving us this - really useful!
Most of the time (for me) the script hangs on self.waitUntilExit() . I'm running macOS 10.15.4 (19E287) and Xcode Version 11.4.1 (11E503a). I moved the let data = pipe.fileHandleForReading.readDataToEndOfFile() to just before the waitUntilExit() and everything seems to work just fine. Isn't this the prefered order?

"Invalid argument" error for `--time` value in Xcode 15.3

An error was encountered processing the command (domain=NSPOSIXErrorDomain, code=22):
Simulator device failed to complete the requested operation.
Invalid argument
Underlying error (domain=NSPOSIXErrorDomain, code=22):
	Invalid, non-ISO date/time string
	Invalid argument

We are providing a valid ISO date/time string, but it now expects to have fractional seconds. 🤦🏼‍♂️

Show "9:41" in other timezones

The resulting time of "9:41" on iPhone simulators is shown in Pacific Time Zone. As a developer who wants to take screenshots in Eastern Time Zone, it shows 12:41. As a temporary solution I had to manually subtract 3 * 3600 from the hard-coded time in main.swift.

Run pod lib lint on GH actions

Danger is not working

See #12 and #13

Run this script whenever the simulator is launched?

Not sure how difficult this would be.

😄 From Dave:

What I really want is for every simulator to start up every time with a perfect status bar.

See NSWorkspace.runningApplications:
https://developer.apple.com/documentation/appkit/nsworkspace/1534059-runningapplications

use key-value observing to be notified of changes to this array property

Override carrier name text to be empty string

This is now possible in Xcode 11.4

simctl status_bar now allows changing the operator (carrier) name. (54162823) (FB6985308)

https://developer.apple.com/documentation/xcode_release_notes/xcode_11_4_release_notes

Update date-time for iPad simulators based on iPad release dates

Ok, #4 got me curious about what the specific date should be for iPad.

After browsing through all the images on the various iPad and iPhone product pages, it turns out that Apple marketing materials appear to always use:

9:41 for iPhone status bar. And they never display the lock screen with a date. (We already knew this.)
9:41 AM is also used for iPads, but their status bars now also display a date since iOS 13 (or 12?). This date is always the release date of the device.

So, what would be cool is to make our script choose the correct date for each iPad simulator. We can simplify by just using the latest devices, so we would only need dates for: [iPad Pro, iPad Air, iPad, iPad Mini].

Implementation notes

I think the only way to determine this precisely is from the simulator name + iOS version? If we can't determine the actual device, then we can fallback to one of: (1) the existing date we are using (first iPhone launch), (2) the date for the very first iPad, or (3) the date of the most recently release iPad. Not sure which is better.

A list of all devices and release dates:
https://en.wikipedia.org/wiki/List_of_iOS_devices