Zip
A Swift framework for zipping and unzipping files. Simple and quick to use. Built on top of minizip.
Usage
Import Zip at the top of the Swift file.
import Zip
Quick functions
The easiest way to use Zip is through quick functions. Both take local file paths as NSURLs, throw if an error is encountered and return an NSURL to the destination if successful.
do {
let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
let unzipDirectory = try Zip.quickUnzipFile(filePath) // Unzip
let zipFilePath = try Zip.quickZipFiles([filePath], fileName: "archive") // Zip
}
catch {
print("Something went wrong")
}
Advanced Zip
For more advanced usage, Zip has functions that let you set custom destination paths, work with password protected zips and use a progress handling closure. These functions throw if there is an error but don't return.
do {
let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
let documentsDirectory = FileManager.default.urls(for:.documentDirectory, in: .userDomainMask)[0]
try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password", progress: { (progress) -> () in
print(progress)
}) // Unzip
let zipFilePath = documentsFolder.appendingPathComponent("archive.zip")
try Zip.zipFiles([filePath], zipFilePath: zipFilePath, password: "password", progress: { (progress) -> () in
print(progress)
}) //Zip
}
catch {
print("Something went wrong")
}
Custom File Extensions
Zip supports '.zip' and '.cbz' files out of the box. To support additional zip-derivative file extensions:
Zip.addCustomFileExtension("file-extension-here")
[Preferred] Setting up with Swift Package Manager
To use Zip with Swift Package Manager, add it to your package's dependencies:
.package(url: "https://github.com/marmelroy/Zip.git", .upToNextMinor(from: "2.1"))
Setting up with CocoaPods
source 'https://github.com/CocoaPods/Specs.git'
pod 'Zip', '~> 2.1'
Setting up with Carthage
To integrate Zip into your Xcode project using Carthage, specify it in your Cartfile:
github "marmelroy/Zip" ~> 2.1
I couldn't proceed with the migration because the project didn't compile, so I had to manually modify the 2 offending lines reverting to previous version, then I migrated the project to swift 4 and reverted the lines.
Isn't there a better way to handle the transition to swift 4 for this project?
4 Nov 12, 2022
26 Dec 10, 2022
104 Oct 11, 2022
18 Oct 17, 2022
6 Jan 26, 2022
369 Sep 28, 2022
86 Oct 26, 2022
60 Nov 25, 2022
73 Dec 13, 2022
0 Nov 6, 2021
4 Aug 31, 2022
23 Dec 16, 2022
3 Jul 12, 2022
2 Jul 13, 2022
3 Nov 2, 2022
478 Dec 29, 2022
1.5k Dec 29, 2022
19 May 12, 2022
145 Sep 10, 2022