Convenience command for local package override

Open
#731 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
cli, tooling

Research direction

Start with the README section “Override a package in the package set with a local one” and inspect packages.dhall. Define how a proposed spago dev <package> command would clone the package into a project-local directory and update the overrides entry. Done means the workflow is automated for a local package override, with command behavior and project-local paths specified.

Written by the indexing model from the issue text.

Description

Thinking of adding a command such as spago dev that automates many of the steps listed in https://github.com/purescript/spago#override-a-package-in-the-package-set-with-a-local-one . For example, spago dev simple-json would:

  • Clone simple-json to a local directory, such as ./spago-local
  • Edit overrides in packages.dhall to point to this local copy.

This is inspired by Julia's workflow, which is really nice for lowering the friction of fixing dependencies. They use a global location for all overridden packages (by default, but can be changed), which is convenient if you tend to use the same overrides across projects, but I think a per-project copy would be more appropriate for PS projects.

Dominant language
PureScript
Stars
831
Forks
137
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from purescript/spago

All issues in purescript/spago

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.