Created
December 18, 2018 06:41
-
-
Save btrepp/c55143fed5f510b7e19097f68ef538ad to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{- | |
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 = | |
https://raw.githubusercontent.com/spacchetti/spacchetti/20181209/src/mkPackage.dhall sha256:8e1c6636f8a089f972b21cde0cef4b33fa36a2e503ad4c77928aabf92d2d4ec9 | |
let upstream = | |
https://raw.githubusercontent.com/spacchetti/spacchetti/20181209/src/packages.dhall sha256:c63285af67ae74feb2f6eb67521712441928d2726ea10e2040774849ca765027 | |
let overrides = {=} | |
let additions = {=} | |
in upstream Ô½¢ overrides Ô½¢ additions |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment