Git Product home page Git Product logo

DEPRECATION NOTICE

This repo has been merged into purescript/package-sets

See this issue for context.

Switching with spago

If you wish to switch to the new upstream you can just run:

$ spago package-set-upgrade

(note: this will update to the latest published package-set)

Switching with psc-package

You psc-package.json should change in the following way:

  • the source key would change from https://github.com/spacchetti/spacchetti.git to https://github.com/purescript/package-sets.git
  • the set would need to be pointed to a release of the new repo, e.g. at the time of writing that is "psc-0.12.3-20190227"



Spacchetti

Build Status

Documentation Status

Mà, ho comprato una scatola di PureScript!

Dhall-driven package sets, made for forking and modifying easily. Per chi non ha paura di rimboccarsi le maniche (e arrotolare gli spaghetti).

Read the guide for more details on RTD: https://spacchetti.readthedocs.io/en/latest/

Read more about how this works here: https://github.com/justinwoo/my-blog-posts#managing-psc-package-sets-with-dhall

Are you looking for Spago? Go here: https://github.com/spacchetti/spago

The Raisin Deets

Nobody likes editing JSON. Even fewer actually like figuring out how to resolve conflicts in Git, especially if they aren't used to aborting rebases and digging up commits from reflog. Everyone complains there is no good solution for having your own patches on top of upstream changes, for when you want to add just a few of your own packages or override existing definitions.

Well, now all you have to do is complain that this repo doesn't have enough contributors, commits, maintenance, curation, etc., because those above issues are solved with the usage of Dhall to merge package definitions and Psc-Package verify on CI.

How to consume this package set

Use Spago or Psc-Package.

How files are organized

-- Package type definition
src/Package.dhall

-- function to define packages
src/mkPackage.dhall

-- packages to be included when building package set
src/packages.dhall

-- package "groups" where packages are defined in records
src/groups/[...].dhall

How to generate the package set after editing Dhall files

First, test that you can actually run make:

> make
formatted dhall files
generated to packages.json

This is how you format Dhall files in the project and generate the packages.json that needs to be checked in. Unless you plan to consume only the packages.dhall file in your repository, you must check in packages.json.

To actually use your new package set, you must create a new git tag and push it to your fork of spacchetti. Then set your package set in your project repository accordingly, per EXAMPLE:

{
  "name": "EXAMPLE",
  "set": "160618", // GIT TAG NAME
  "source": "https://github.com/spacchetti/spacchetti.git", // PACKAGE SET REPO URL
  "depends": [
    "console",
    "prelude"
  ]
}

When you set this up correctly, you will see that running psc-package install will create the file .psc-package/{GIT TAG NAME HERE}/.set/packages.json.

Testing changes to package set

To set up a test project, run make setup. Then you can test individual packages with psc-package verify PACKAGE.

Further Complaints

PRs welcome.

FAQ

How do I use this package set?

Use Spago or Psc-Package.

Can I get additional help?

Open an issue in Spago or ask on FP Slack.

Does ___ in scripts/ mean ____?

No, these are just random scripts that are used to maintain Spacchetti package sets. They are not used by Psc-Package nor are they used by Spago.

Can I use packages from Bower?

You can use anything that is a git repository, which mean every Bower dependency and others. See the local setup docs if you want to locally add them to a project: https://spacchetti.readthedocs.io/en/latest/local-setup.html

spacchetti's Projects

easy-dhall-nix icon easy-dhall-nix

Derivations for easily downloading Dhall binaries and putting them to use.

logo icon logo

Logo for the Spacchetti project

spacchetti icon spacchetti

dhall-driven package sets for psc-package. Mà, ho comprato una scatola di PureScript!

starsuit icon starsuit

A search engine for PureScript package sets

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.