packages.dhall 6.33 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
{-
Welcome to Spacchetti local packages!

Below are instructions for how to edit this file for most use
cases, so that you don't need to know Dhall to use it.

## Warning: Don't Move This Top-Level Comment!

Due to how `dhall format` currently works, this comment's
instructions cannot appear near corresponding sections below
because `dhall format` will delete the comment. However,
it will not delete a top-level comment like this one.

## Use Cases

Most will want to do one or both of these options:
1. Override/Patch a package's dependency
2. Add a package not already in the default package set

This file will continue to work whether you use one or both options.
Instructions for each option are explained below.

### Overriding/Patching a package

Purpose:
- Change a package's dependency to a newer/older release than the
    default package set's release
- Use your own modified version of some dependency that may
    include new API, changed API, removed API by
    using your custom git repo of the library rather than
    the package set's repo

Syntax:
Replace the overrides' "{=}" (an empty record) with the following idea
The "//" or "⫽" means "merge these two records and
  when they have the same value, use the one on the right:"
-------------------------------
let override =
  { packageName =
      upstream.packageName ⫽ { updateEntity1 = "new value", updateEntity2 = "new value" }
  , packageName =
      upstream.packageName ⫽ { version = "v4.0.0" }
  , packageName =
      upstream.packageName // { repo = "https://www.example.com/path/to/new/repo.git" }
  }
-------------------------------

Example:
-------------------------------
let overrides =
  { halogen =
      upstream.halogen ⫽ { version = "master" }
  , halogen-vdom =
      upstream.halogen-vdom ⫽ { version = "v4.0.0" }
  }
-------------------------------

### Additions

Purpose:
- Add packages that aren't alread included in the default package set

Syntax:
Replace the additions' "{=}" (an empty record) with the following idea:
-------------------------------
let additions =
  { "package-name" =
       mkPackage
         [ "dependency1"
         , "dependency2"
         ]
         "https://example.com/path/to/git/repo.git"
         "tag ('v4.0.0') or branch ('master')"
  , "package-name" =
       mkPackage
         [ "dependency1"
         , "dependency2"
         ]
         "https://example.com/path/to/git/repo.git"
         "tag ('v4.0.0') or branch ('master')"
  , etc.
  }
-------------------------------

Example:
-------------------------------
let additions =
  { benchotron =
      mkPackage
        [ "arrays"
        , "exists"
        , "profunctor"
        , "strings"
        , "quickcheck"
        , "lcg"
        , "transformers"
        , "foldable-traversable"
        , "exceptions"
        , "node-fs"
        , "node-buffer"
        , "node-readline"
        , "datetime"
        , "now"
        ]
        "https://github.com/hdgarrood/purescript-benchotron.git"
        "v7.0.0"
  }
-------------------------------
-}

let mkPackage =
112
      https://raw.githubusercontent.com/purescript/package-sets/psc-0.13.2-20190804/src/mkPackage.dhall sha256:0b197efa1d397ace6eb46b243ff2d73a3da5638d8d0ac8473e8e4a8fc528cf57
113 114

let upstream =
115
      https://raw.githubusercontent.com/purescript/package-sets/psc-0.13.2-20190804/src/packages.dhall sha256:2230fc547841b54bca815eb0058414aa03ed7b675042f8b3dda644e1952824e5
116 117

let overrides =
118 119 120 121 122 123 124 125 126 127 128 129
      { thermite =
          mkPackage
          [ "aff"
          , "coroutines"
          , "web-dom"
          , "freet"
          , "profunctor-lenses"
          , "react"
          , "react-dom"
          ]
          "https://github.com/np/purescript-thermite.git"
          "hide"
130 131 132 133 134 135 136
      , globals =
          mkPackage
          [ "functions"
          , "maybe"
          ]
          "https://github.com/purescript/purescript-globals"
          "v4.1.0"
137
      }
138

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
let additions =
      { sequences =
          mkPackage
          [ "prelude"
          , "unsafe-coerce"
          , "partial"
          , "unfoldable"
          , "lazy"
          , "arrays"
          , "profunctor"
          , "maybe"
          , "tuples"
          , "newtype"
          ]
          "https://github.com/hdgarrood/purescript-sequences.git"
          "v2.1.0"
      , spec-discovery =
          mkPackage
          [ "prelude", "effect", "arrays", "spec", "node-fs" ]
          "https://github.com/purescript-spec/purescript-spec-discovery"
159
          "v4.0.0"
160 161 162 163 164
      , spec-quickcheck =
          mkPackage
          [ "prelude", "aff", "random", "quickcheck", "spec" ]
          "https://github.com/purescript-spec/purescript-spec-quickcheck"
          "v3.1.0"
165 166
      , ffi-simple =
          mkPackage
167 168 169 170 171 172 173
          [ "prelude"
          , "effect"
          , "maybe"
          , "functions"
          , "nullable"
          , "unsafe-coerce"
          ]
James Laver's avatar
James Laver committed
174
          "https://github.com/irresponsible/purescript-ffi-simple"
James Laver's avatar
James Laver committed
175
          "v0.2.4"
James Laver's avatar
James Laver committed
176 177
      , dom-simple =
          mkPackage
James Laver's avatar
James Laver committed
178 179 180 181 182 183 184 185 186 187 188
          [ "arrays"
          , "console"
          , "effect"
          , "ffi-simple"
          , "functions"
          , "nullable"
          , "prelude"
          , "unsafe-coerce"
          ]
          "https://github.com/irresponsible/purescript-dom-simple"
          "v0.2.4"
189
      , dom-filereader =
190 191 192 193
          mkPackage
          [ "aff", "arraybuffer-types", "web-file", "web-html" ]
          "https://github.com/nwolverson/purescript-dom-filereader"
          "v5.0.0"
James Laver's avatar
James Laver committed
194 195
      , reactix =
          mkPackage
196
          [ "aff"
James Laver's avatar
James Laver committed
197 198
          , "dom-simple"
          , "effect"
199
          , "ffi-simple"
James Laver's avatar
James Laver committed
200 201 202 203 204
          , "functions"
          , "nullable"
          , "prelude"
          , "unsafe-coerce"
          ]
James Laver's avatar
James Laver committed
205
          "https://github.com/irresponsible/purescript-reactix"
James Laver's avatar
James Laver committed
206
          "v0.4.2"
207 208 209 210 211
      , uint =
          mkPackage
          [ "maybe", "math", "generics-rep" ]
          "https://github.com/zaquest/purescript-uint"
          "v5.1.1"
James Laver's avatar
James Laver committed
212 213
      , uri =
          mkPackage
214 215 216 217 218 219 220 221 222
          [ "these"
          , "arrays"
          , "profunctor-lenses"
          , "unfoldable"
          , "parsing"
          , "integers"
          , "globals"
          , "generics-rep"
          ]
James Laver's avatar
James Laver committed
223 224
          "https://github.com/slamdata/purescript-uri"
          "v7.0.0"
225
       , read = mkPackage ["prelude", "maybe", "strings"]
226 227
                "https://github.com/truqu/purescript-read"
                "v1.0.1"
228 229 230
      }

in  upstream // overrides // additions