Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnsundell/files
A nicer way to handle files & folders in Swift
https://github.com/johnsundell/files
files folders script swift swift-script xcode
Last synced: 4 days ago
JSON representation
A nicer way to handle files & folders in Swift
- Host: GitHub
- URL: https://github.com/johnsundell/files
- Owner: JohnSundell
- License: mit
- Created: 2017-01-15T18:00:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-04T09:55:43.000Z (about 2 years ago)
- Last Synced: 2024-10-29T15:48:21.072Z (3 months ago)
- Topics: files, folders, script, swift, swift-script, xcode
- Language: Swift
- Size: 313 KB
- Stars: 2,534
- Watchers: 50
- Forks: 183
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Welcome to **Files**, a compact library that provides a nicer way to handle *files* and *folders* in Swift. It’s primarily aimed at Swift scripting and tooling, but can also be embedded in applications that need to access the file system. It's essentially a thin wrapper around the `FileManager` APIs that `Foundation` provides.
## Features
- [X] Modern, object-oriented API for accessing, reading and writing files & folders.
- [X] Unified, simple `do, try, catch` error handling.
- [X] Easily construct recursive and flat sequences of files and folders.
## Examples
Iterate over the files contained in a folder:
```swift
for file in try Folder(path: "MyFolder").files {
print(file.name)
}
```
Rename all files contained in a folder:
```swift
try Folder(path: "MyFolder").files.enumerated().forEach { (index, file) in
try file.rename(to: file.nameWithoutExtension + "\(index)")
}
```
Recursively iterate over all folders in a tree:
```swift
Folder.home.subfolders.recursive.forEach { folder in
print("Name : \(folder.name), parent: \(folder.parent)")
}
```
Create, write and delete files and folders:
```swift
let folder = try Folder(path: "/users/john/folder")
let file = try folder.createFile(named: "file.json")
try file.write("{\"hello\": \"world\"}")
try file.delete()
try folder.delete()
```
Move all files in a folder to another:
```swift
let originFolder = try Folder(path: "/users/john/folderA")
let targetFolder = try Folder(path: "/users/john/folderB")
try originFolder.files.move(to: targetFolder)
```
Easy access to system folders:
```swift
Folder.current
Folder.root
Folder.library
Folder.temporary
Folder.home
Folder.documents
```
## Installation
Files can be easily used in either a Swift script, a command line tool, or in an app for iOS, macOS, tvOS or Linux.
### Using the Swift Package Manager (preferred)
To install Files for use in a Swift Package Manager-powered tool, script or server-side application, add Files as a dependency to your `Package.swift` file. For more information, please see the [Swift Package Manager documentation](https://github.com/apple/swift-package-manager/tree/master/Documentation).
```swift
.package(url: "https://github.com/JohnSundell/Files", from: "4.0.0")
```
### Using CocoaPods or Carthage
Please refer to [CocoaPods’](https://cocoapods.org) or [Carthage’s](https://github.com/Carthage/Carthage) own documentation for instructions on how to add dependencies using those tools.
### As a file
Since all of Files is implemented within a single file, you can easily use it in any project by simply dragging the file `Files.swift` into your Xcode project.
## Backstory
So, why was this made? As I've migrated most of my build tools and other scripts from languages like Bash, Ruby and Python to Swift, I've found myself lacking an easy way to deal with the file system. Sure, `FileManager` has a quite nice API, but it can be quite cumbersome to use because of its string-based nature, which makes simple scripts that move or rename files quickly become quite complex.
So, I made **Files**, to enable me to quickly handle files and folders, in an expressive way. And, since I love open source, I thought - why not package it up and share it with the community? :)
## Questions or feedback?
Feel free to [open an issue](https://github.com/JohnSundell/Files/issues/new), or find me [@johnsundell on Twitter](https://twitter.com/johnsundell).