Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 3.11 KB

README.md

File metadata and controls

72 lines (53 loc) · 3.11 KB
Raw

🗜 SnapshotTestingHEIC

Build Status

An extension to SnapshotTesting which allows you to create HEIC images. The benefit of using HEIC instead of PNG is that it can store as much as image quality as PNG, but with a smaller file size. You can verify this by looking at SnapshotTestingHEICTests.

Usage

Once installed, no additional configuration is required. You can import the SnapshotTestingHEIC module, call SnapshotTesting following their usage guide and simply provide our imageHEIC strategy as below.

import XCTest
import SnapshotTesting
import SnapshotTestingHEIC

class MyViewControllerTests: XCTestCase {
  func testMyViewController() {
    let vc = MyViewController()
    assertSnapshot(matching: vc, as: .imageHEIC)
  }
}

Installation

Xcode 11

⚠️ Warning: By default, Xcode will try to add the SnapshotTestingHEIC package to your project's main application/framework target. Please ensure that SnapshotTestingHEIC is added to a test target instead, as documented in the last step, below.

  1. From the File menu, navigate through Swift Packages and select Add Package Dependency….
  2. Enter package repository URL: https://github.com/alexey1312/SnapshotTestingHEIC
  3. Confirm the version and let Xcode resolve the package
  4. On the final dialog, update SnapshotTestingHEIC's Add to Target column to a test target that will contain snapshot tests (if you have more than one test target, you can later add SnapshotTestingHEIC to them by manually linking the library in its build phase)

Swift Package Manager

If you want to use SnapshotTestingHEIC in any other project that uses Swift Package Manager, add the package as a dependency in Package.swift:

dependencies: [
  .package(url: "https://github.com/alexey1312/SnapshotTestingHEIC.git", from: "1.0.0"),
]

Next, add SnapshotTestingHEIC as a dependency of your test target:

targets: [
  .target(
    name: "MyApp"
  ),
  
  .testTarget(
    name: "MyAppTests", 
    dependencies: [
      .target(name: "MyApp"),
      .product(name: "SnapshotTestingHEIC", package: "SnapshotTestingHEIC"),
    ]
  ),
]

Other

We do not currently support distribution through CocoaPods or Carthage.

License

This library is released under the MIT license. See LICENSE for details.