Giter Club home page Giter Club logo

hix's Introduction

About

Hix is a toolkit for Haskell development that uses Nix to provide a unified, declarative interface for a range of build related tasks:

  • Reproducible environments and dependency overrides
  • Cabal file generation
  • Hackage upload
  • Rapid-recompilation testing with ghcid
  • Haskell Language Server
  • CTags generation
  • Virtual Machines for testing
  • Compatibility checks for multiple GHC versions

To learn more, please visit the documentation page.

tldr

You can convert an existing project with Cabal files by executing this command in the project root:

nix run 'github:tek/hix?ref=0.5.6

You can create a new project in the current directory:

nix run 'github:tek/hix?ref=0.5.6

The manual process consists of first adding Hix to your Haskell project flake by specifying the input:

{
  inputs.hix.url = "github:tek/hix?ref=0.5.6";
}

Then configure your project with NixOS module options:

{
  description = "Example";
  inputs.hix.url = "github:tek/hix?ref=0.5.6";
  outputs = {hix, ...}: hix.lib.flake {
    packages.parser = {
      src = ./.;
      library = {
        enable = true;
        dependencies = ["aeson ^>= 2.0" "bytestring"];
      };
      executable.enable = true;
      test.enable = true;
    };
  };
}

Now generate Cabal files with:

nix run .#gen-cabal

Build the package with nix build, or run the tests in test/Main.hs in GHCid:

nix run .#ghcid -- -p parser

hix's People

Contributors

tek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.