# flaky-utils

Additional Nix Flake utility functions for personal convenience (mainly
reducing boilerplate).

No promise on API stability.


## Usage

Functions documentation provided as comments below.

```nix
{
  description = "Example of a Flake using flaky-utils.";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-22.05";
    flake-utils.url = "github:numtide/flake-utils";
    flaky-utils.url = "git+https://cgit.pacien.net/libs/flaky-utils";
  };

  outputs = { self, nixpkgs, flake-utils, flaky-utils }:
  flake-utils.lib.eachDefaultSystem (system: let
    pkgs = import nixpkgs { inherit system; };
  in {

    # Convenience development shell providing some tools.
    #
    # The binaries made available and the environment variable set are printed
    # when entering the shell.
    #
    # The user's default shell is used instead of Bash (sacrifying a bit of
    # reproducibility for convenience).
    #
    devShell = flaky-utils.lib.mkDevShell {
      inherit pkgs;

      tools = with pkgs; [
        postgresql_14
        pgcli
      ];

      envVars = rec {
        PGDATA = "$PWD/development_database/pgdata";
        PGHOST = "$PWD/development_database";
        PGPORT = "5432";
        PGDATABASE = "app";
        DATABASE_URL = "postgresql:///${PGDATABASE}?host=${PGHOST}";
      };
    };

  });
}
```


## Contributing

Issues and patches: email the author.


## Licence and copyright

Copyright (C) 2022 Pacien TRAN-GIRARD.

This project is distributed under the terms of European Union Public Licence
version 1.2, a copy of which is provided in `./licence.txt`.