hasufell / hpath Goto Github PK

View Code? Open in Web Editor NEW

16.0 4.0 6.0 1.5 MB

Typed filepath in haskell

License: Other

Haskell 99.44% C 0.17% Shell 0.39%

posix filepath dirname filepath-manipulation files haskell

hpath's Introduction

HPath libraries

Set of libraries to deal with filepaths and files.

Motivation

filepaths should be type-safe (absolute, relative, ...)
filepaths should be ByteString under the hood, see Abstract FilePath Proposal (AFPP)
file high-level operations should be platform-specific, exception-stable, safe and as atomic as possible

Projects

hpath: Support for well-typed paths
hpath-filepath: ByteString based filepath manipulation (can be used without hpath)
hpath-directory: High-level IO operations for files/directories on raw ByteString filepaths (use hpath-io for the type-safe path version)
hpath-io: High-level IO operations for files/directories utilizing type-safe Path
hpath-posix: Some low-level POSIX glue code that is not in 'unix'

hpath's People

Contributors

Stargazers

Watchers

Forkers

gwils amesgen mmhat tomsmeding pranaysashank

hpath's Issues

Release 0.9.3

https://github.com/hasufell/hpath/milestone/1

Export closeFd

So we don't need to import unix-bytestring.

Errors in the documentation of parseRel?

According to the documentation of parseRel:

Note that filepath may contain any number of ./ but may not consist solely of ./.

but apparently isJust $ parseRel "./" evaluates to True. Am I missing something?

btrfs support

could be achieved with https://hackage.haskell.org/package/btrfs

Consider using streamly for "lazy" file writing/reading

TODO

Use streamly-posix for dircontents

Use filepath-bytestring

https://hackage.haskell.org/package/filepath-bytestring could substitute our posix-paths fork

Windows support

Yes, we want that now, but IMO this will depend on a sane AFPP implementation, which has been discussed https://discourse.haskell.org/t/reviving-the-abstract-filepath-proposal-afpp-in-user-space/2344

CLC approval is pending, WIP implementation is at https://github.com/hasufell/abstract-filepath

handle trailing path separators differently?

Do we want to force trailing path separators off?

If not, how can we make sure that all functions make sense (e.g. basename or maybe something like takeFileName)?

Allow to create temporary files

is _period locale dependend?

https://hackage.haskell.org/package/word8-0.1.3/docs/Data-Word8.html#v:_period

If so, need to document at least, otherwise our splitExtension functions etc will misbehave.

"Path Fn </> Path Fn" is broken

We probably need to use type families to resolve this.

Use safe-exceptions

https://hackage.haskell.org/package/safe-exceptions-0.1.7.0/docs/Control-Exception-Safe.html

dirname (p </> a) == dirname p

nope. in fact this is only true for some relatively small set of a values.

filepath-bytestring does not follow an open-development model? hpath-filepath/README.md

In hpath-filepath/README.md we can read There is also a similar library filepath-bytestring, but it doesn't follow an open development model and is cross-platform, which this library is not interested in.

What do you mean by "doesn't follow an open development model"? It seems to be open-source.