|
| 1 | +{- |
| 2 | +Welcome to your new Dhall package-set! |
| 3 | + |
| 4 | +Below are instructions for how to edit this file for most use |
| 5 | +cases, so that you don't need to know Dhall to use it. |
| 6 | + |
| 7 | +## Warning: Don't Move This Top-Level Comment! |
| 8 | + |
| 9 | +Due to how `dhall format` currently works, this comment's |
| 10 | +instructions cannot appear near corresponding sections below |
| 11 | +because `dhall format` will delete the comment. However, |
| 12 | +it will not delete a top-level comment like this one. |
| 13 | + |
| 14 | +## Use Cases |
| 15 | + |
| 16 | +Most will want to do one or both of these options: |
| 17 | +1. Override/Patch a package's dependency |
| 18 | +2. Add a package not already in the default package set |
| 19 | + |
| 20 | +This file will continue to work whether you use one or both options. |
| 21 | +Instructions for each option are explained below. |
| 22 | + |
| 23 | +### Overriding/Patching a package |
| 24 | + |
| 25 | +Purpose: |
| 26 | +- Change a package's dependency to a newer/older release than the |
| 27 | + default package set's release |
| 28 | +- Use your own modified version of some dependency that may |
| 29 | + include new API, changed API, removed API by |
| 30 | + using your custom git repo of the library rather than |
| 31 | + the package set's repo |
| 32 | + |
| 33 | +Syntax: |
| 34 | +Replace the overrides' "{=}" (an empty record) with the following idea |
| 35 | +The "//" means "merge these two records and |
| 36 | + when they have the same value, use the one on the right:" |
| 37 | +------------------------------- |
| 38 | +let override = |
| 39 | + { packageName = |
| 40 | + upstream.packageName // { updateEntity1 = "new value", updateEntity2 = "new value" } |
| 41 | + , packageName = |
| 42 | + upstream.packageName // { version = "v4.0.0" } |
| 43 | + , packageName = |
| 44 | + upstream.packageName // { repo = "https://www.example.com/path/to/new/repo.git" } |
| 45 | + } |
| 46 | +------------------------------- |
| 47 | + |
| 48 | +Example: |
| 49 | +------------------------------- |
| 50 | +let overrides = |
| 51 | + { halogen = |
| 52 | + upstream.halogen // { version = "master" } |
| 53 | + , halogen-vdom = |
| 54 | + upstream.halogen-vdom // { version = "v4.0.0" } |
| 55 | + } |
| 56 | +------------------------------- |
| 57 | + |
| 58 | +### Additions |
| 59 | + |
| 60 | +Purpose: |
| 61 | +- Add packages that aren't already included in the default package set |
| 62 | + |
| 63 | +Syntax: |
| 64 | +Replace the additions' "{=}" (an empty record) with the following idea: |
| 65 | +------------------------------- |
| 66 | +let additions = |
| 67 | + { package-name = |
| 68 | + { dependencies = |
| 69 | + [ "dependency1" |
| 70 | + , "dependency2" |
| 71 | + ] |
| 72 | + , repo = |
| 73 | + "https://example.com/path/to/git/repo.git" |
| 74 | + , version = |
| 75 | + "tag ('v4.0.0') or branch ('master')" |
| 76 | + } |
| 77 | + , package-name = |
| 78 | + { dependencies = |
| 79 | + [ "dependency1" |
| 80 | + , "dependency2" |
| 81 | + ] |
| 82 | + , repo = |
| 83 | + "https://example.com/path/to/git/repo.git" |
| 84 | + , version = |
| 85 | + "tag ('v4.0.0') or branch ('master')" |
| 86 | + } |
| 87 | + , etc. |
| 88 | + } |
| 89 | +------------------------------- |
| 90 | + |
| 91 | +Example: |
| 92 | +------------------------------- |
| 93 | +let additions = |
| 94 | + { benchotron = |
| 95 | + { dependencies = |
| 96 | + [ "arrays" |
| 97 | + , "exists" |
| 98 | + , "profunctor" |
| 99 | + , "strings" |
| 100 | + , "quickcheck" |
| 101 | + , "lcg" |
| 102 | + , "transformers" |
| 103 | + , "foldable-traversable" |
| 104 | + , "exceptions" |
| 105 | + , "node-fs" |
| 106 | + , "node-buffer" |
| 107 | + , "node-readline" |
| 108 | + , "datetime" |
| 109 | + , "now" |
| 110 | + ] |
| 111 | + , repo = |
| 112 | + "https://github.com/hdgarrood/purescript-benchotron.git" |
| 113 | + , version = |
| 114 | + "v7.0.0" |
| 115 | + } |
| 116 | + } |
| 117 | +------------------------------- |
| 118 | +-} |
| 119 | + |
| 120 | + |
| 121 | +let upstream = |
| 122 | + https://github.com/purescript/package-sets/releases/download/psc-0.13.6-20200226/packages.dhall sha256:3a52562e05b31a7b51d12d5b228ccbe567c527781a88e9028ab42374ab55c0f1 |
| 123 | + |
| 124 | +let overrides = {=} |
| 125 | + |
| 126 | +let additions = {=} |
| 127 | + |
| 128 | +in upstream // overrides // additions |
0 commit comments