From 263e44a2c0f638fb830d5acab2ee972ade46ad02 Mon Sep 17 00:00:00 2001 From: Steven Vandevelde Date: Sat, 1 Aug 2020 18:53:04 +0200 Subject: [PATCH] Setup Nix environment --- .envrc | 1 + .tool-versions | 2 - README.md | 16 ++---- nix/sources.json | 26 +++++++++ nix/sources.nix | 138 +++++++++++++++++++++++++++++++++++++++++++++++ shell.nix | 25 +++++++++ 6 files changed, 193 insertions(+), 15 deletions(-) create mode 100644 .envrc delete mode 100644 .tool-versions create mode 100644 nix/sources.json create mode 100644 nix/sources.nix create mode 100644 shell.nix diff --git a/.envrc b/.envrc new file mode 100644 index 00000000..051d09d2 --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +eval "$(lorri direnv)" diff --git a/.tool-versions b/.tool-versions deleted file mode 100644 index 06ee12f1..00000000 --- a/.tool-versions +++ /dev/null @@ -1,2 +0,0 @@ -elm 0.19.1 -nodejs 14.6.0 diff --git a/README.md b/README.md index 8ab987b9..6556a165 100644 --- a/README.md +++ b/README.md @@ -57,24 +57,14 @@ In short: ### Building it yourself -For version numbers, see `.tool-versions` and `stack.yaml`. -All of these, except the last one, can be install using [homebrew](https://brew.sh/). - -- [Elm](https://elm-lang.org/) programming language -- [Haskell](https://docs.haskellstack.org/en/stable/README/) programming language -- [Node.js](https://nodejs.org/) programming language with the [Yarn](https://yarnpkg.com/) package manager -- [Just](https://github.com/casey/just) command runner (improved `make`) -- [Devd](https://github.com/cortesi/devd) web server for development (optional) -- [Elm Format](https://github.com/avh4/elm-format) elm code formatter (optional) -- [Watchexec](https://github.com/watchexec/watchexec) watching for file changes (optional) -- [Elm Proofread](https://github.com/icidasset/elm-proofread) documentation tests (optional) +This project uses [Nix](https://nixos.org/features.html) to manage the project's environment. If you'd like to build this project without Nix, check out the dependencies in the `shell.nix` file (most are available through Homebrew as well). ```shell # 🍱 -# 1. Install programming languages: -# Elm 0.19.1 & Haskell (Stack), see links above +# 1. Setup Nix environment +# https://nixos.org/download.html # 2. Install dependencies yarn install diff --git a/nix/sources.json b/nix/sources.json new file mode 100644 index 00000000..1e8c2e42 --- /dev/null +++ b/nix/sources.json @@ -0,0 +1,26 @@ +{ + "niv": { + "branch": "master", + "description": "Easy dependency management for Nix projects", + "homepage": "https://github.com/nmattia/niv", + "owner": "nmattia", + "repo": "niv", + "rev": "ab9cc41caf44d1f1d465d8028e4bc0096fd73238", + "sha256": "17k52n8zwp832cqifsc4458mhy4044wmk22f807171hf6p7l4xvr", + "type": "tarball", + "url": "https://github.com/nmattia/niv/archive/ab9cc41caf44d1f1d465d8028e4bc0096fd73238.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + }, + "nixpkgs": { + "branch": "nixpkgs-unstable", + "description": "Nix Packages collection", + "homepage": null, + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "5ad1cdafe15d4ea79ae6abcddc360dd2de35b44e", + "sha256": "1nn602v3ssj79rxdfl3ical10c1d632vji9nv2h0dqslmycg4aws", + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/5ad1cdafe15d4ea79ae6abcddc360dd2de35b44e.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + } +} diff --git a/nix/sources.nix b/nix/sources.nix new file mode 100644 index 00000000..7bd0f3ea --- /dev/null +++ b/nix/sources.nix @@ -0,0 +1,138 @@ +# This file has been generated by Niv. + +let + + # + # The fetchers. fetch_ fetches specs of type . + # + + fetch_file = pkgs: spec: + if spec.builtin or true then + builtins_fetchurl { inherit (spec) url sha256; } + else + pkgs.fetchurl { inherit (spec) url sha256; }; + + fetch_tarball = pkgs: name: spec: + let + ok = str: ! builtins.isNull (builtins.match "[a-zA-Z0-9+-._?=]" str); + # sanitize the name, though nix will still fail if name starts with period + name' = stringAsChars (x: if ! ok x then "-" else x) "${name}-src"; + in + if spec.builtin or true then + builtins_fetchTarball { name = name'; inherit (spec) url sha256; } + else + pkgs.fetchzip { name = name'; inherit (spec) url sha256; }; + + fetch_git = spec: + builtins.fetchGit { url = spec.repo; inherit (spec) rev ref; }; + + fetch_local = spec: spec.path; + + fetch_builtin-tarball = name: throw + ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`. + $ niv modify ${name} -a type=tarball -a builtin=true''; + + fetch_builtin-url = name: throw + ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`. + $ niv modify ${name} -a type=file -a builtin=true''; + + # + # Various helpers + # + + # The set of packages used when specs are fetched using non-builtins. + mkPkgs = sources: + let + sourcesNixpkgs = + import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) {}; + hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath; + hasThisAsNixpkgsPath = == ./.; + in + if builtins.hasAttr "nixpkgs" sources + then sourcesNixpkgs + else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then + import {} + else + abort + '' + Please specify either (through -I or NIX_PATH=nixpkgs=...) or + add a package called "nixpkgs" to your sources.json. + ''; + + # The actual fetching function. + fetch = pkgs: name: spec: + + if ! builtins.hasAttr "type" spec then + abort "ERROR: niv spec ${name} does not have a 'type' attribute" + else if spec.type == "file" then fetch_file pkgs spec + else if spec.type == "tarball" then fetch_tarball pkgs name spec + else if spec.type == "git" then fetch_git spec + else if spec.type == "local" then fetch_local spec + else if spec.type == "builtin-tarball" then fetch_builtin-tarball name + else if spec.type == "builtin-url" then fetch_builtin-url name + else + abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}"; + + # Ports of functions for older nix versions + + # a Nix version of mapAttrs if the built-in doesn't exist + mapAttrs = builtins.mapAttrs or ( + f: set: with builtins; + listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set)) + ); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295 + range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257 + stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1)); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269 + stringAsChars = f: s: concatStrings (map f (stringToCharacters s)); + concatStrings = builtins.concatStringsSep ""; + + # fetchTarball version that is compatible between all the versions of Nix + builtins_fetchTarball = { url, name, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchTarball; + in + if lessThan nixVersion "1.12" then + fetchTarball { inherit name url; } + else + fetchTarball attrs; + + # fetchurl version that is compatible between all the versions of Nix + builtins_fetchurl = { url, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchurl; + in + if lessThan nixVersion "1.12" then + fetchurl { inherit url; } + else + fetchurl attrs; + + # Create the final "sources" from the config + mkSources = config: + mapAttrs ( + name: spec: + if builtins.hasAttr "outPath" spec + then abort + "The values in sources.json should not have an 'outPath' attribute" + else + spec // { outPath = fetch config.pkgs name spec; } + ) config.sources; + + # The "config" used by the fetchers + mkConfig = + { sourcesFile ? ./sources.json + , sources ? builtins.fromJSON (builtins.readFile sourcesFile) + , pkgs ? mkPkgs sources + }: rec { + # The sources, i.e. the attribute set of spec name to spec + inherit sources; + + # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers + inherit pkgs; + }; +in +mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); } diff --git a/shell.nix b/shell.nix new file mode 100644 index 00000000..6aad01db --- /dev/null +++ b/shell.nix @@ -0,0 +1,25 @@ +let + + sources = import ./nix/sources.nix; + pkgs = import sources.nixpkgs {}; + +in + + pkgs.mkShell { + buildInputs = [ + + # Dev Tools + pkgs.curl + pkgs.devd + pkgs.just + pkgs.watchexec + + # Language Specific + pkgs.elmPackages.elm + pkgs.elmPackages.elm-format + pkgs.haskellPackages.stack + pkgs.nodejs-14_x + pkgs.yarn + + ]; + } -- 2.51.2