https://github.com/phpirates/haskell-template-project

A template project using Haskell, Stack, Cabal, Tasty, HUnit, Travis, Haddock.
https://github.com/phpirates/haskell-template-project

haddock haskell stack tasty travis-ci

Last synced: 2 months ago
JSON representation

A template project using Haskell, Stack, Cabal, Tasty, HUnit, Travis, Haddock.

• Host: GitHub
• URL: https://github.com/phpirates/haskell-template-project
• Owner: PHPirates
• License: isc
• Created: 2018-07-07T15:00:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-07T15:42:45.000Z (almost 6 years ago)
• Last Synced: 2025-02-10T22:30:08.338Z (4 months ago)
• Topics: haddock, haskell, stack, tasty, travis-ci
• Language: Haskell
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://travis-ci.com/PHPirates/haskell-template-project.svg?branch=master

    :target: https://travis-ci.com/PHPirates/haskell-template-project

.. image:: https://coveralls.io/repos/github/PHPirates/haskell-template-project/badge.svg?branch=master

    :target: https://coveralls.io/github/PHPirates/haskell-template-project?branch=master

Uses:

- Haskell_, a functional programming language

- Stack_, a build tool which includes dependency and test management

- Cabal_, a build system used by Stack

- Tasty_, a test framework

- HUnit_, a test runner which can be configured by Tasty

- Travis_, a continuous integration service which can build Haskell projects which use Stack

- Haddock_, a tool for generating documentation

- Coveralls_, an online service which shows coverage statistics

- SHC_, Stack HPC Coveralls is a Stack integration which uploads data to Coveralls

- Intellij-Haskell_, which allows to run Haskell and all of the above in IntelliJ. Not required to run this template project.

Instructions to install Haskell and the IntelliJ Haskell plugin at StackOverflow_.

The test framework Tasty_ is used, because it seems more recently maintained than 'test-framework'. Another option could have been Hspec. Tasty includes HUnit, made by Hspec.

    "Tasty lets you combine your unit tests, golden tests, QuickCheck/SmallCheck properties, and any other types of tests into a single test suite."

Updating dependencies

---------------------

Check Stackage_ to see what the latest resolver is, and change that in `stack.yml`.

.. _Stackage: https://www.stackage.org/lts

.. _Haskell: https://www.haskell.org

.. _StackOverflow: https://stackoverflow.com/a/51009817/4126843

.. _Stack: https://github.com/commercialhaskell/stack

.. _Cabal: https://github.com/haskell/cabal

.. _HUnit: https://github.com/hspec/HUnit

.. _Tasty: https://github.com/feuerbach/tasty

.. _Travis: https://travis-ci.com

.. _Haddock: https://github.com/haskell/haddock

.. _Intellij-Haskell: https://github.com/rikvdkleij/intellij-haskell

.. _Coveralls: https://coveralls.io

.. _SHC: https://github.com/rubik/stack-hpc-coveralls