hpath/CHANGELOG

34 lines
660 B
Plaintext
Raw Normal View History

Fork chrisdone's path library I wasn't happy with the way it dealt with Dir vs File things. In his version of the library, a `Path b Dir` always ends with a trailing path separator and `Path b File` never ends with a trailing path separator. IMO, it is nonsensical to make a Dir vs File distinction on path level, although it first seems nice. Some of the reasons are: * a path is just that: a path. It is completely disconnected from IO level and even if a `Dir`/`File` type theoretically allows us to say "this path ought to point to a file", there is literally zero guarantee that it will hold true at runtime. So this basically gives a false feeling of a type-safe file distinction. * it's imprecise about Dir vs File distinction, which makes it even worse, because a directory is also a file (just not a regular file). Add symlinks to that and the confusion is complete. * it makes the API oddly complicated for use cases where we basically don't care (yet) whether something turns out to be a directory or not Still, it comes also with a few perks: * it simplifies some functions, because they now have guarantees whether a path ends in a trailing path separator or not * it may be safer for interaction with other library functions, which behave differently depending on a trailing path separator (like probably shelly) Not limited to, but also in order to fix my remarks without breaking any benefits, I did: * rename the `Dir`/`File` types to `TPS`/`NoTPS`, so it's clear we are only giving information about trailing path separators and not actual file types we don't know about yet * add a `MaybeTPS` type, which does not mess with trailing path separators and also gives no guarantees about them... then added `toNoTPS` and `toTPS` to allow type-safe conversion * make some functions accept more general types, so we don't unnecessarily force paths with trailing separators for `(</>)` for example... instead these functions now examine the paths to still have correct behavior. This is really minor overhead. You might say now "but then I can append filepath to filepath". Well, as I said... we don't know whether it's a "filepath" at all. * merge `filename` and `dirname` into `basename` and make `parent` be `dirname`, so the function names match the name of the POSIX ones, which do (almost) the same... * fix a bug in `basename` (formerly `dirname`) which broke the type guarantees * add a pattern synonym for easier pattern matching without exporting the internal Path constructor
2016-03-08 21:53:42 +00:00
0.5.8:
* First version of the fork.
2016-03-06 16:43:49 +00:00
0.5.7:
* Fix haddock problem.
2016-03-04 14:07:00 +00:00
0.5.6:
* Reject only .. and .
2016-03-04 13:50:28 +00:00
0.5.5:
* Use filepath's isValid function for additional sanity checks
2016-03-04 13:40:20 +00:00
0.5.4:
* Disable parsing of path consisting only of "."
* Add NFData instance for Path
* Some typo/docs improvements
* Add standard headers to modules
2015-11-21 18:54:27 +00:00
0.5.3:
* Added conversion functions.
2015-05-11 17:00:34 +00:00
0.2.0:
* Rename parentAbs to simply parent.
* Add dirname.
2015-05-22 09:32:41 +00:00
0.3.0:
* Removed Generic instance.
0.4.0:
* Implemented stricter parsing, disabling use of "..".
2015-05-22 09:33:34 +00:00
* Made stripDir generic over MonadThrow
2015-05-27 15:08:03 +00:00
0.5.0:
* Fix stripDir p p /= Nothing bug.
2015-06-21 10:18:45 +00:00
0.5.2:
* Removed unused DeriveGeneric.