https://github.com/friedbrice/runhs

Stack wrapper for single-file Haskell programs.
https://github.com/friedbrice/runhs

Last synced: 21 days ago
JSON representation

Stack wrapper for single-file Haskell programs.

• Host: GitHub
• URL: https://github.com/friedbrice/runhs
• Owner: friedbrice
• Created: 2020-07-27T00:03:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-29T22:13:53.000Z (almost 2 years ago)
• Last Synced: 2024-09-17T10:09:03.474Z (about 2 months ago)
• Language: Haskell
• Size: 53.7 KB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# runhs

Stack wrapper for single-file Haskell programs.

Declare package dependencies in the source code of your single-file Haskell program. Easily and reliably run your program, compile it, or load it in GHCi or Ghcid.

## Install

1. First, install [Stack](https://haskellstack.org).

2. Add Stack's install directory to your `PATH`.

  * **Windows:** Installing Stack automatically adds its install directory to your `PATH`.

  * **Most Linux:** `echo 'export PATH="${HOME}/.local/bin:${PATH}"' >> ~/.profile && export PATH="${HOME}/.local/bin:${PATH}"`

  * **MacOS Pre-Catalina:** `echo 'export PATH="${HOME}/.local/bin:${PATH}"' >> ~/.bash_profile && export PATH="${HOME}/.local/bin:${PATH}"`

  * **MacOS Catalina and newer:** `echo 'export PATH="${HOME}/.local/bin:${PATH}"' >> ~/.zshrc && export PATH="${HOME}/.local/bin:${PATH}"`

3. Finally, use one of the following install methods.

  * **Stack (recommended):** `stack install runhs`

  * **Download:** Download the appropriate executable for your platform from the [Releases page](https://github.com/friedbrice/runhs/releases/), unzip it, and put it somewhere on your `PATH`.

## Usage

Add a block comment (the _front matter_) at the start of any single-file Haskell program in the following format:

```

{-

resolver: lts-16.6

packages:

  - bytestring

  - containers

-}

```

The front matter must be the first block comment in your file, and the comment delimiters `{-` and `-}` must appear on their own lines, just as above.

The `resolver` property is required and must be a valid [Stackage resolver](https://www.stackage.org/snapshots). The `packages` property is required if your Haskell program depends on external packages, but may be omitted if your Haskell program does not.

Once you have the appropriate front matter at the top of your file, you may load your program in _Watch Mode_ or in _Interactive Mode_ (a.k.a. _REPL Mode_) in GHCi, or run your program as a script, or compile your program, using the following command format.

```

runhs (watch|repl|script|compile)  []

```

## Copyright and License

Copyright (C) 2020-2021 Daniel Brice

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  * Neither the name of Daniel Brice nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.