https://github.com/purescript/package-sets
PureScript packages for Spago and Psc-Package
https://github.com/purescript/package-sets
package-set purescript
Last synced: 3 months ago
JSON representation
PureScript packages for Spago and Psc-Package
- Host: GitHub
- URL: https://github.com/purescript/package-sets
- Owner: purescript
- License: bsd-3-clause
- Created: 2016-09-24T20:33:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T07:29:41.000Z (7 months ago)
- Last Synced: 2024-10-29T21:05:40.631Z (7 months ago)
- Topics: package-set, purescript
- Language: Dhall
- Homepage:
- Size: 2.19 MB
- Stars: 195
- Watchers: 11
- Forks: 312
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Package Sets
A curated list of PureScript packages for the `spago` and `psc-package` package managers.
:warning: This repository predates the [PureScript Registry](https://github.com/purescript/registry) and now exists only as a mirror to support legacy versions of package managers that use the package sets. To register your packages or add them to the package sets, please visit the registry. This repository no longer accepts pull requests or issues.
- [What is a package-set?](#what-is-a-package-set)
- [Add your package](#adding-your-package)
- [How do I use package-sets with `spago`?](#how-do-i-use-package-sets-with-spago)
- [How do I use package-sets with `psc-package`?](#how-do-i-use-package-sets-with-psc-package)
## What is a package set?
A package set is a collection of packages in which there is only one version for each package, and the entire collection of packages compiles successfully together. A package set ensures you can always install a package from the set without introducing a conflict in your dependencies.
If you use a package manager based on package sets, that means that to install a package:
1. The package must be in the package set
2. The package's dependencies and transitive dependencies must also be in the package set
## Adding your package
This repository aims to be a good collection of packages you can depend on. The package sets here are produced by the [PureScript Registry](https://github.com/purescript/registry), and we welcome all packages that can be successfully registered.
If you would like to add your new package to the package sets, please see the registry instructions for registering your package (it will automatically be added to the package sets, unless it fails to compile with the current package set). If your package has been dropped from the package sets and you would like to manually re-add it, please see the registry instructions for submitting a package sets update.
## How do I use `package-sets` with `spago`?
[`spago`][spago] is a package manager and build tool for PureScript which uses Dhall package sets. This makes them easy to extend and override.
With `spago` the package-set address is specified in the `upstream` variable of your local `packages.dhall`, which will usually import a remote `packages.dhall`, e.g. the one from this repo. You can change the package-set version you are using by running `spago upgrade-set`, or if you want to point to a particular version, `spago upgrade-set --tag `.
## How do I use `package-sets` with psc-package?
[`psc-package`][psc-package] is a package manager for PureScript that works essentially by running a bunch of git commands. It is not maintained by the PureScript core team and we recommend using Spago instead.
With `psc-package` the package-set address is set in the `source` field of a `psc-package.json` file, which should list the URL of a repository with a `packages.json` file in the root (such as this one). Your configuration should look something like this:
```json
{
"name": "project-name",
"set": "set-name",
"source": "https://github.com/purescript/package-sets.git",
"depends": ["aff", "console", "prelude"]
}
```
[spago]: https://github.com/purescript/spago
[psc-package]: https://github.com/purescript/psc-package