You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Julian Ospald ae21dbc7fa
Improve documentation
1 month ago
..
src Improve documentation 1 month ago
CHANGELOG Bump versions 4 months ago
LICENSE Split packages into hpath{,-io,-filepath} 4 months ago
README.md Add/update READMEs 4 months ago
Setup.hs Split packages into hpath{,-io,-filepath} 4 months ago
hpath.cabal Bump versions 4 months ago
run-doctests.sh Fix run-doctests working dir 4 months ago

README.md

HPath

Gitter chat Hackage version Build Status Hackage-Deps

Support for well-typed paths in Haskell.

This package is part of the HPath suite, also check out:

Motivation

The motivation came during development of hsfm which has a pretty strict File type, but lacks a strict Path type, e.g. for user input.

The library that came closest to my needs was path, but the API turned out to be oddly complicated for my use case, so I decided to fork it.

Goals

  • well-typed paths
  • safe filepath manipulation, never using String as filepath, but ByteString

Note: this library was written for posix systems and it will probably not support other systems.

Differences to ‘path’

  • doesn’t attempt to fake IO-related information into the path, so whether a path points to a file or directory is up to your IO-code to decide...
  • uses safe ByteString for filepaths under the hood instead of unsafe String
  • fixes broken dirname
  • renames dirname/filename to basename/dirname to match the POSIX shell functions
  • allows pattern matching via unidirectional PatternSynonym
  • uses simple doctest for testing
  • allows ~/ as relative path, because on posix level ~ is just a regular filename that does NOT point to $HOME