Haskelly - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #go #deep-learning #linux #docker #macos #nodejs #windows #cli #vue #pytorch #ios #openai

Haskelly

(★ 151)

Haskelly is a VS Code extension that provides complete support for casual and expert Haskell development.

File Explorer

Download Latest Version (.zip)

- launch.json
- settings.json
- tasks.json
- - cabal.json
  - haskell.json
- - haskell.json
- build.gif
- completion.gif
- hover.gif
- icon.png
- - buttons.ts
  - commands.ts
- - testCode.ts
- - InitIntero.ts
  - InteroLocationDecoder.ts
  - InteroSpawn.ts
- - document.ts
  - other.ts
  - print.ts
  - promise.ts
  - syncSpawn.ts
  - workDir.ts
- extension.ts
- - promise.test.ts
- extension.test.ts
- index.ts
.gitignore
.vscodeignore
License.txt
package-lock.json
package.json
README.md
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/haskelly-dev/Haskelly

Downloads the entire project code from GitHub to your computer.

cd Haskelly

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

curl -sSL https://get.haskellstack.org/ | sh

Downloads and runs the official install script in one line — this handles the full setup automatically.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Haskelly

[Release notes](https://github.com/haskelly-dev/Haskelly/releases)  | [Roadmap](https://trello.com/b/vsMlLU4h/haskelly-features) | [Demo Video](https://www.youtube.com/watch?v=r3x64iz5xDk)

`Haskelly` is a [Visual Studio Code](https://code.visualstudio.com/) extension that supports Haskell development.

## Features

* __Code highlight__
  - Haskell (`.hs` and `.lhs`) and Cabal via automatic dependency on [Haskell Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=justusadam.language-haskell).

* __Code snippets__
  - Structures : `data`, `newtype`, etc.
  - Popular functions : `map`, `fold`, etc.

* __Type hovers__
    - ![hover](https://raw.githubusercontent.com/haskelly-dev/Haskelly/master/resources/hover.gif)

* __Jump to definition__
  - Jump to symbol definitions/declarations

* __Find references__
  - Find references within a module or depending modules. See limitations on [#62](https://github.com/haskelly-dev/Haskelly/issues/62)

* __Code completion__ :
    - Local functions and constants
    - Standard library
    - Imported modules

![completion](https://raw.githubusercontent.com/haskelly-dev/Haskelly/master/resources/completion.gif)

* __Integrated REPL, Build, Test and Run commands__
  - repl with `GHCi`
  - build with `stack`
  - run with `runHaskell`
  - test current file `prop_*` properties with `QuickCheck`
  - run full test suite with `Stack test`

## Installation

* Install the [Haskelly](https://marketplace.visualstudio.com/items?itemName=UCL.haskelly) VS Code extension.

* Install [Stack](https://www.haskellstack.org) and add it to your PATH. Note that Stack folder naming conventions must be followed for it to work correctly, i.e. capitalizing folder names.

```shell
    curl -sSL https://get.haskellstack.org/ | sh
    ```

* Install [Intero](https://github.com/commercialhaskell/intero) (code completion and type information), and [QuickCheck](https://hackage.haskell.org/package/QuickCheck) (test suite)

```shell
    stack install intero QuickCheck  # for a global installation
    stack build intero QuickCheck # for a local installation
    ```

## Configuration

Haskelly is customizable
(see `Code` > `Preferences` > `Workspace Settings`).

| Parameter                     | Description                                     | Default  |
|----------------------------   |-------------------------------------------------|----------|
| `haskelly.codeCompletion`     | Code completion enabled                         | `true`   |  
| `haskelly.buttons.ghci`       | `GHCi` button shows in the bottom bar           | `true`   |
| `haskelly.buttons.runfile`    | `Run file` button shows in the bottom bar       | `true`   |
| `haskelly.buttons.quickcheck` | `QuickCheck` button shows in the bottom bar     | `true`   |
| `haskelly.buttons.stackBuild` | `Stack build` button shows in the bottom bar    | `true`   |
| `haskelly.buttons.stackBuildParams` | Parameters passed to `stack build` command| `--fast` |
| `haskelly.buttons.stackRun`   | `Stack run` button shows in the bottom bar      | `true`   |
| `haskelly.buttons.stackRunParams` | Parameters passed to `stack run` command    | `null`   |
| `haskelly.buttons.stackTest`  | `Stack test` button shows in the bottom bar     | `true`   |
| `haskelly.buttons.stackTestParams` | Parameters passed to `stack test` command  | `null`   |
| `haskelly.snippets.important` | Hide code completion for which there's already a snippet | `false` |
| `haskelly.snippets.custom`    | Add your custom snippets following the structure of this [file](https://github.com/haskelly-dev/Haskelly/tree/master/languages/snippets/haskell.json)| `null` |
| `haskelly.exec.reuseTerminal` | Reuse the currently opened terminal to run Stack commands | false |

## Contributing

If you'd like to contribute to Haskelly, this is what you can do:

* __Bugs__: This extension is in alpha, so some bugs might be present. We would really appreciate if you
could post any issue on the Github repository [issues section](https://github.com/haskelly-dev/Haskelly/issues) or contact us at: [zcabmse@ucl.ac.uk](mailto:zcabmse@ucl.ac.uk?Subject=Haskelly%20feedback).
* __Ideas and feature requests__: We want to get everyone's opinion on what we're building so feel free to use the two mentioned channels for any comment or suggestion.
* __Documentation__: Found a typo or strangely worded sentences? Submit a PR!
* __Code__: Contribute bug fixes, features or design changes.

## License: [GNU 3](https://github.com/haskelly-dev/Haskelly/blob/master/License.txt)