From 5f9b460e0d583e772225b6bac79a79164cab1965 Mon Sep 17 00:00:00 2001 From: "John C. Lavelle" Date: Sun, 18 Oct 2020 20:09:47 -0400 Subject: [PATCH] Scripts to run examples & generate docs --- examples/spago.dhall | 2 +- nix/sources.json | 38 +++++++++ nix/sources.nix | 171 +++++++++++++++++++++++++++++++++++++++++ package.json | 15 ++-- scripts/mkDocs.fish | 3 + scripts/mkExample.fish | 5 ++ shell.nix | 12 +++ 7 files changed, 235 insertions(+), 11 deletions(-) create mode 100644 nix/sources.json create mode 100644 nix/sources.nix create mode 100644 scripts/mkDocs.fish create mode 100644 scripts/mkExample.fish create mode 100644 shell.nix diff --git a/examples/spago.dhall b/examples/spago.dhall index c3df6ba..5235754 100644 --- a/examples/spago.dhall +++ b/examples/spago.dhall @@ -2,7 +2,7 @@ Welcome to a Spago project! You can edit this file as you like. -} -{ name = "my-project" +{ name = "snap-examples" , dependencies = [ "console", "effect", "psci-support", "snap" ] , packages = ./packages.dhall , sources = [ "./**/*.purs" ] diff --git a/nix/sources.json b/nix/sources.json new file mode 100644 index 0000000..77aa613 --- /dev/null +++ b/nix/sources.json @@ -0,0 +1,38 @@ +{ + "niv": { + "branch": "master", + "description": "Easy dependency management for Nix projects", + "homepage": "https://github.com/nmattia/niv", + "owner": "nmattia", + "repo": "niv", + "rev": "9d35b9e4837ab88517210b1701127612c260eccf", + "sha256": "0q50xhnm8g2yfyakrh0nly4swyygxpi0a8cb9gp65wcakcgvzvdh", + "type": "tarball", + "url": "https://github.com/nmattia/niv/archive/9d35b9e4837ab88517210b1701127612c260eccf.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + }, + "nixpkgs": { + "branch": "release-20.03", + "description": "Nix Packages collection", + "homepage": "", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "f702aab2d9cae14c554a4fa873a0665f99554fc9", + "sha256": "15fzr98ymm64j9wc7slcrlikzgxq3znrmn6mnkz5kks01s9fff8q", + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/f702aab2d9cae14c554a4fa873a0665f99554fc9.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + }, + "nixpkgs-unstable": { + "branch": "nixpkgs-unstable", + "description": "Nix Packages collection", + "homepage": "", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "cfed29bfcb28259376713005d176a6f82951014a", + "sha256": "034m892hxygminkj326y7l3bp4xhx0v154jcmla7wdfqd23dk5xm", + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/cfed29bfcb28259376713005d176a6f82951014a.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 0000000..b796fff --- /dev/null +++ b/nix/sources.nix @@ -0,0 +1,171 @@ +# This file has been generated by Niv. + +let + + # + # The fetchers. fetch_ fetches specs of type . + # + + fetch_file = pkgs: name: spec: + let + name' = sanitizeName name + "-src"; + in + if spec.builtin or true then + builtins_fetchurl { inherit (spec) url sha256; name = name'; } + else + pkgs.fetchurl { inherit (spec) url sha256; name = name'; }; + + fetch_tarball = pkgs: name: spec: + let + name' = sanitizeName 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 = name: spec: + let + ref = + if spec ? ref then spec.ref else + if spec ? branch then "refs/heads/${spec.branch}" else + if spec ? tag then "refs/tags/${spec.tag}" else + abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!"; + in + builtins.fetchGit { url = spec.repo; inherit (spec) rev; inherit 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 + # + + # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695 + sanitizeName = name: + ( + concatMapStrings (s: if builtins.isList s then "-" else s) + ( + builtins.split "[^[:alnum:]+._?=-]+" + ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name) + ) + ); + + # The set of packages used when specs are fetched using non-builtins. + mkPkgs = sources: system: + let + sourcesNixpkgs = + import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; }; + 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 name spec + else if spec.type == "tarball" then fetch_tarball pkgs name spec + else if spec.type == "git" then fetch_git name 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}"; + + # If the environment variable NIV_OVERRIDE_${name} is set, then use + # the path directly as opposed to the fetched source. + replace = name: drv: + let + saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name; + ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}"; + in + if ersatz == "" then drv else ersatz; + + # 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)); + concatMapStrings = f: list: concatStrings (map f list); + concatStrings = builtins.concatStringsSep ""; + + # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331 + optionalAttrs = cond: as: if cond then as else {}; + + # fetchTarball version that is compatible between all the versions of Nix + builtins_fetchTarball = { url, name ? null, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchTarball; + in + if lessThan nixVersion "1.12" then + fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; })) + else + fetchTarball attrs; + + # fetchurl version that is compatible between all the versions of Nix + builtins_fetchurl = { url, name ? null, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchurl; + in + if lessThan nixVersion "1.12" then + fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; })) + 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 = replace name (fetch config.pkgs name spec); } + ) config.sources; + + # The "config" used by the fetchers + mkConfig = + { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null + , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile) + , system ? builtins.currentSystem + , pkgs ? mkPkgs sources system + }: 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/package.json b/package.json index 71e6c10..cb8057c 100644 --- a/package.json +++ b/package.json @@ -1,16 +1,11 @@ { "scripts": { "build": "spago build", - "build:todomvc": "spago bundle-app --main Examples.TodoMVC.Main --to bundle/todomvc/bundle.js", - "todomvc": "npm run build:todomvc && npx parcel examples/todomvc/index.html", - "build:transactionalform": "spago bundle-app --main Examples.TransactionalForm.Main --to bundle/transactionalform/bundle.js", - "transactionalform": "npm run build:transactionalform && npx parcel examples/transactionalform/index.html", - "build:cattron": "spago bundle-app --main Examples.CatTron.Main --to bundle/cattron/bundle.js", - "cattron": "npm run build:cattron && npx parcel examples/cattron/index.html", - "build:reducer": "spago bundle-app --main Examples.Reducer.Main --to bundle/reducer/bundle.js", - "reducer": "npm run build:reducer && npx parcel examples/reducer/index.html", - "build:routing": "spago bundle-app --main Examples.Routing.Main --to bundle/routing/bundle.js", - "routing": "npm run build:routing && npx parcel examples/routing/index.html" + "todomvc": "fish scripts/mkExample.fish Examples.TodoMVC.Main todomvc", + "transactionalform": "fish scripts/mkExample.fish Examples.TransactionalForm.Main transactionalform", + "cattron": "fish scripts/mkExample.fish Examples.CatTron.Main cattron", + "reducer": "fish scripts/mkExample.fish Examples.Reducer.Main reducer", + "routing": "fish scripts/mkExample.fish Examples.Routing.Main routing" }, "dependencies": { "react": "^16.13.1", diff --git a/scripts/mkDocs.fish b/scripts/mkDocs.fish new file mode 100644 index 0000000..367ce7e --- /dev/null +++ b/scripts/mkDocs.fish @@ -0,0 +1,3 @@ +set root (realpath (dirname (status --current-filename)))/.. +cd $root/examples +spago docs diff --git a/scripts/mkExample.fish b/scripts/mkExample.fish new file mode 100644 index 0000000..a9dec9d --- /dev/null +++ b/scripts/mkExample.fish @@ -0,0 +1,5 @@ +set root (realpath (dirname (status --current-filename)))/.. +cd $root/examples +spago bundle-app --main $argv[1] --to $root/bundle/$argv[2]/bundle.js +cd $root +npx parcel $root/examples/$argv[2]/index.html diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..9d6eb1a --- /dev/null +++ b/shell.nix @@ -0,0 +1,12 @@ +let + sources = import ./nix/sources.nix; + pkgs = import sources.nixpkgs-unstable {}; +in +pkgs.mkShell { + buildInputs = with pkgs; [ + purescript + nodejs + spago + fish + ]; +}