Fileable.swift/README.md

1.9 KiB

FileKit

Build Status Carthage compatible iOS 10+ Linux supported Swift 4

Fileable is file utilities for Swift. It enables to mange files or directories efficiently and easily.

Installation

CocoaPods

At now, we aim to register this library to CocoaPods official repository. However, this library is currently under construction process. Thus, you have to configure Podfile manually to get this library from this github repository.

pod 'https://github.com/shotastage/Fileable.git'

Carthage

You can use this library with Carthage by simply putting this text to Cartfile.

github "shotastage/Fileable"

⌘ APIs

Function or Computed property
var pwd: String Get current directory path as a string.
var home: Strings Get home directory path.
var isFile: Bool Check the file exists or not.
var isDir: Bool Check the directory exists or not.
func ext(path: String) -> Bool Check the directory exists or not.
func cd(path: String) throws Change directory like a cd command.
func mkdir(path: String) throws Make directory.
func rm(target: String) throws Remove directory or file.
func mv(from fromPath: String, to toPath: String) Move file or directory.
func touch(_ path: String) throws Create empty file.

License

Fileable is licensed under the MIT. You can use this library free of charge. Please include copyright notie in your program. See LICENSE for detail.