Skip to content

friedbrice/simple-haskell

Repository files navigation

SimpleHaskell

A low-feature Haskell package for Sublime Text

Description and Goals

This package aims to support Haskell development on Sublime Text without relying on specific build tools or project structure.

Right now, this package focuses on fixing issues with syntax highlighting and providing some rudimentary completions.

Future directions might involve adding a simple build system based on ghcid and slightly-more intelligent code completion.

Getting Started

Once my Package Control PR goes through, you can install this as you would install any other Sublime Text 3 package.

Until then, clone the repository, and from the project root, run one of the following commands.

For macOS:

cp ./* ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/User/

For Linux:

cp ./* ~/.config/sublime-text-3/Packages/User/

It should also work in Windows, but I don't know the location of the User package or how to copy files.

Open a Haskell source file (for example, the provided syntax-test.hs) and try it out.

Copyright and Contributing

Syntax highlighting is based on the default Haskell.sublime-syntax file included with Sublime Text.

Multi-line string support by SQbQxeKd3JHD8.

Copyright (c) 2018 Anthony Brice and Daniel Brice, except as otherwise noted.

Permission granted to anyone who posesses the software to use, distribute, and modify.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

Pull requests welcomed! While I don't have time to work on feature requests, I will happily consider any pull requests and either merge them or give feedback.

Versioning Scheme

Releases will be identified via Git tags, which will always be in the format

v{{ MAJOR }}.{{ MINOR }}.{{ PATCH }}

where MAJOR, MINOR, and PATCH are non-negative integers.

Release version numbers are chosen by considering the following rules, in short-circuit order:

  • Whenever existing assertions in the test suit are changed or removed, we will bump the MAJOR version (with MINOR and PATCH rolling over to 0).

  • Whenever new assertions are added that enhance the granularity of syntax highlighting, we will bump the MINOR version (with PATCH rolling over to 0).

  • Whenever a bug is fixed, with or without adding assertions, we will bump the PATCH version.

It's worth noting that the distinction between MINOR bumps and PATCH bumps is somewhat vague, sometimes making the decision a matter of taste. The rule defining a MAJOR bump, however, is unambiguous.

About

A low-feature Haskell package for Sublime Text

Resources

Stars

Watchers

Forks

Packages

No packages published