Pathos offers cross-platform virtual file system APIs for Swift.
Pathos is implement from ground-up with on each OS's native API. It has zero dependencies.
Windows support is currently considered experimental.
| Swift 5.3 & 5.3.1 |
|---|
 |
 |
 |
 |
 |
 (Experimental) |
For a taste of Pathos, let's generate a static site from Markdown!
import Pathos
// Set the CWD and execute a closure
try Path("markdown-source-dir").asWorkingDirectory {
// Build the site in a unique, temporary directory
let temporaryRoot = try Path.makeTemporaryDirectory()
// Joining path components that works across OSes.
// E.g. `articles/**/*.md` on POSIX systems.
let pattern = Path("articles") + "**" + "*.md"
// Use glob to find files that matches the pattern
for markdown in try pattern.glob() {
// path/to/file.md => path/to/file
let url = markdown.base
// path that contains index.html
let htmlDirectory = temporaryRoot + url
// make a directory, including multiple levels
try htmlDirectory.makeDirectory(withParents: true)
// read content of a file
let source = try markdown.readUTF8String()
// write out the html, imagine `markdown2html` exists
try (htmlDirectory + "index.html").write(utf8: markdown2html(source))
}
// all done! move the built site to output directory
try temporaryRoot.move(to: "output")
}
// CWD is restored after the closure is done
As you can see, Pathos offers a whole suite of APIs for inspecting and manipulating the file system. Programs built with Pathos compile and work on all supported OS without the need to use #if OS() in the source.
There are more Examples for the curious.
Installation
With SwiftPM
.package(url: "http://github.com/dduan/Pathos", from: "0.4.0")
Documentation
- User Guide - A tour of Pathos for introduction purposes.
- API Refererence - Complete reference to Pathos public APIs.
- Design - Answers for why an API is designed as such.
- Change Log - Change logs for all Pathos versions.
You may also checkout the Example apps.
License
Pathos is released under the MIT license. See LICENSE.md
3 Aug 30, 2022
5.2k Jan 2, 2023
890 Jan 6, 2023
2.3k Dec 30, 2022
1.9k Dec 27, 2022
32 Dec 21, 2022
2.2k Jan 7, 2023
3k Jan 3, 2023
9.5k Dec 31, 2022
3.6k Dec 29, 2022
178 Sep 16, 2022
187 Dec 19, 2022
18 Aug 10, 2022
44 Dec 17, 2022
22 Nov 14, 2022
1 Jan 5, 2022
0 Nov 9, 2021
1.4k Jan 5, 2023
717 Dec 19, 2022
1k Dec 19, 2022
1.2k Dec 27, 2022
131 Jan 10, 2022
8 Oct 3, 2022
9 Sep 6, 2022
1.5k Dec 16, 2022
14 Sep 24, 2022