Skip to content

Use spago for client's PS dependencies #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ Most of these features can be controlled not only from the toolbar, but also usi
git clone [email protected]:purescript/trypurescript.git
cd trypurescript/client

bower install
npm install
npm run build
npm run bundle
Expand Down
5 changes: 1 addition & 4 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
/bower_components/
/node_modules/
/.pulp-cache/
/package-lock.json
/output/
/generated-docs/
/.psc-package/
/.psc*
/.purs*
/.psa*
/.stack*
/js/index.js

.spago/
62 changes: 0 additions & 62 deletions client/bower.json

This file was deleted.

12 changes: 6 additions & 6 deletions client/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"private": true,
"scripts": {
"clean": "rimraf output && rimraf .pulp-cache",
"build": "pulp build -- --censor-lib --strict",
"bundle": "pulp build -O --to js/index.js"
"clean": "rimraf output",
"build": "spago build --purs-args '--censor-lib --strict'",
"bundle": "spago bundle-app --to js/index.js"
},
"devDependencies": {
"pulp": "^13.0.0",
"purescript-psa": "^0.7.3",
"purescript": "^0.13.6",
"rimraf": "^2.5.4"
"purescript-psa": "^0.7.3",
"rimraf": "^2.5.4",
"spago": "^0.14.0"
}
}
128 changes: 128 additions & 0 deletions client/packages.dhall
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
{-
Welcome to your new Dhall package-set!

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 overrides =
{ 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 already included in the default package set

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

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


let upstream =
https://github.com/purescript/package-sets/releases/download/psc-0.13.6-20200404/packages.dhall sha256:f239f2e215d0cbd5c203307701748581938f74c4c78f4aeffa32c11c131ef7b6

let overrides = {=}

let additions = {=}

in upstream // overrides // additions
57 changes: 57 additions & 0 deletions client/spago.dhall
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{-
Welcome to a Spago project!
You can edit this file as you like.
-}
{ name = "try-purescript"
, dependencies =
[ "arrays"
, "bifunctors"
, "console"
, "const"
, "contravariant"
, "control"
, "distributive"
, "effect"
, "either"
, "enums"
, "exceptions"
, "exists"
, "foldable-traversable"
, "foreign"
, "foreign-generic"
, "foreign-object"
, "free"
, "functions"
, "functors"
, "generics-rep"
, "globals"
, "identity"
, "integers"
, "jquery"
, "js-timers"
, "lazy"
, "math"
, "maybe"
, "ordered-collections"
, "parallel"
, "prelude"
, "profunctor"
, "proxy"
, "psci-support"
, "quickcheck"
, "random"
, "refs"
, "semirings"
, "st"
, "strings"
, "tailrec"
, "transformers"
, "tuples"
, "typelevel-prelude"
, "unfoldable"
, "validation"
, "web-html"
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are all these dependencies actually needed for the client? Or were these just the package set dependencies for what you could compile against?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list of dependencies was generated by spago init from the existing bower.json file. They might not all be needed, I'm not sure.

, packages = ./packages.dhall
, sources = [ "src/**/*.purs" ]
}