https://github.com/wasp-lang/strong-path

Strongly typed paths in Haskell
https://github.com/wasp-lang/strong-path

Last synced: 3 months ago
JSON representation

Strongly typed paths in Haskell

• Host: GitHub
• URL: https://github.com/wasp-lang/strong-path
• Owner: wasp-lang
• License: mit
• Created: 2020-07-31T17:02:08.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-17T09:21:37.000Z (almost 2 years ago)
• Last Synced: 2024-05-16T16:43:49.020Z (6 months ago)
• Language: Haskell
• Size: 85 KB
• Stars: 14
• Watchers: 9
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StrongPath

[![CI](https://github.com/wasp-lang/strong-path/workflows/CI/badge.svg?branch=main)](https://github.com/wasp-lang/strong-path/actions/workflows/ci.yaml?query=branch%3Amain)

[![Documentation](https://img.shields.io/badge/Docs-Haddock-blue)](https://hackage.haskell.org/package/strong-path/docs/StrongPath.html)

[![Hackage](https://img.shields.io/hackage/v/strong-path.svg)](https://hackage.haskell.org/package/strong-path)

[![Stackage LTS](http://stackage.org/package/strong-path/badge/lts)](http://stackage.org/lts/package/strong-path)

[![Stackage Nightly](http://stackage.org/package/strong-path/badge/nightly)](http://stackage.org/nightly/package/strong-path)

Strongly typed file paths in Haskell.

This library provides a strongly typed representation of file paths, providing more safety during compile time while also making code more readable, compared to the standard solution (`FilePath`, which is really just `String`).

Without `StrongPath`:

```hs

getBashProfile :: IO FilePath

```

With `StrongPath`:

```hs

getBashProfile :: IO (Path System (Rel HomeDir) (File BashProfile))

```

Simple but complete example:

```hs

import StrongPath (Path, System, Abs, Dir, parseAbsDir)

data HomeDir

getHomeDirPath :: IO (Path System Abs (Dir HomeDir))

getHomeDirPath = getLine >>= fromJust . parseAbsDir

```

Check [documentation](https://hackage.haskell.org/package/strong-path/docs/StrongPath.html) for more details!

## Documentation

Detailed documentation, including rich examples and API is written via Haddock.

Check out the latest documentation on Hackage: [Documentation](https://hackage.haskell.org/package/strong-path/docs/StrongPath.html).

You can also build and view the Haddock documentation yourself if you wish, by running `stack haddock --open`.

## Contributing / development

We are using `ormolu` for code formatting. In order for the PR to pass, it needs to be formatted by `ormolu`.

`strong-path` is `Stack` project, so make sure you have `stack` installed on your machine.

`stack build` to build the project, `stack test` to run the tests.

`stack build --file-watch --haddock` to rebuild documentation as you change it.

### Publishing to Hackage

First, make sure to update the version of package in package.yaml, if needed.

Then, `stack sdist` to build publishable .tar.gz., and then we need to upload it manually to Hackage.

Check if Hackage correctly built the Haddock docs -> if not, you need to upload them manually (check Hackage webpage for instructions, it should be smth like `cabal v2-haddock --haddock-for-hackage --enable-doc` and then `cabal upload -d --publish `).

We should also tag the commit in git with version tag (e.g. v1.0.0.0) so we know which version of code was used to produce that release.