• Stars
    star
    110
  • Rank 316,770 (Top 7 %)
  • Language
    Swift
  • License
    MIT License
  • Created over 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

File management and path analysis for Swift

Banner

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.

Continuous Integration
Amazon Linux 2
macOS 11.15
Ubuntu Bionic
Ubuntu Focal
Windows 2019 (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.2")

Documentation

  1. User Guide - A tour of Pathos for introduction purposes.
  2. API Refererence - Complete reference to Pathos public APIs.
  3. Design - Answers for why an API is designed as such.
  4. 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

More Repositories

1

Just

Swift HTTP for Humans
Swift
1,397
star
2

tre

Tree command, improved.
Rust
757
star
3

needless

A utility to find needless words in Swift function names.
Swift
175
star
4

DrString

DrString finds issues in your Swift docstrings and fixes them for you.
Swift
170
star
5

Markra

An open-source Markdown-to-JIRA syntax editor written in SwiftUI for macOS
Swift
92
star
6

Termbox

Swift Wrapper for Termbox: A Lightweight TUI Library
C
66
star
7

TOMLDecoder

From TOML to Swift Codable types.
Swift
63
star
8

git2dayone

A script for logging git commit messages in the app Day One
Shell
39
star
9

DistributionTests

Swift 3 distribution test for open-source libraries.
Makefile
23
star
10

Swift-Framework-Without-Xcode

A sample project to demonstrate how to build and link to Swift frameworks dynamically without using Xcode.
Makefile
22
star
11

Lic

Easy, safe object slicing for Swift
Swift
21
star
12

Tweet-Importer-For-Day-One

Imports Tweet Archive To Day One
Python
21
star
13

dotfiles

Nix
20
star
14

Swipe-Away

An iOS 7 demo of user interaction with UIView achieved via UIDynamics.
Objective-C
17
star
15

cURLLook

Represent your NSURLRequest with a cURL command.
Swift
16
star
16

Comprehension

List Comprehension For Swift
Swift
16
star
17

django-sophie

Just another Django-based blog engine, that runs on GAE.
Python
14
star
18

Clue

Clue is a Swift library, and a command-line tool that finds symbol references in Swift projects.
Swift
14
star
19

ea

ea: make your CLI output actionable.
Rust
13
star
20

BrainAss

A Brainfuck to WebAssembly compiler written in Haskell
Haskell
9
star
21

TerminalPaint

A project that demonstrates how to build a TUI program in Swift
Swift
9
star
22

swift-system-extras

Swift System, battery included.
Swift
9
star
23

Dye

Cross-platform terminal styling for Swift command-line interface.
Swift
8
star
24

NetTime

RFC 3339 compliant date/time data types.
Swift
8
star
25

BitArray

A space-efficient bit array with RandomAccessCollection conformance in Swift.
Swift
5
star
26

Flapcopy

A Flappy Bird inspired HTML5 game.
CoffeeScript
5
star
27

Relay

Stateless alternatives to Combine.Subject
Swift
5
star
28

DrString.vim

Vim integration for DrString
Vim Script
4
star
29

TOMLDeserializer

Replaced by https://github.com/dduan/TOMLDecoder
Swift
4
star
30

IsTTY

Helps you decide whether your file is a terminal device.
Swift
4
star
31

CoverMaker

A small macOS that generates YouTube video thumbnails from metadata, built with SwiftUI and The Composable Architecture
Swift
4
star
32

Factorino

Swift
3
star
33

swift-system-exit

`exit` system call for Swift
Swift
2
star
34

Scmark

Thin, faithful, but Swift-y wrappers for cmark.
C
2
star
35

nixSwiftPM

Nix helper for SwiftPM
Nix
2
star
36

PEG

Parsing Expression Grammar implemented in Swift.
Swift
1
star
37

AllTheSwiftFiles

Fetch all popular Swift files from Github for language feature study
Python
1
star
38

scoop-bucket

Scoop (https://scoop.sh) apps.
1
star
39

herp

Help Extract Real Phrases: A CLI Utility.
Swift
1
star
40

mmm

A interactive CLI helper for manipulating files.
Rust
1
star
41

SwiftOnNix

Scripts for generating Nix expression for the Swift toolchain.
Nix
1
star