fsprojects / fsprojects/Paket

RFC: Allow `paket.local` to `include` snippets stored in other files

Open
#3,620 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
F#
Stars
2.1k
Forks
528
Avg merge
1d 12m
Merged PRs (30d)
54

Description

Use Case

When depending on a lot of nuget packages, build from a few different source repositories, managing paket.local becomes cumbersome. Assuming we had a mechanism to create some paket.local snippets directly when paket pack'ing, as outlined in #3619, bringing them together in a given target repo could be easier.

Proposal

Bring an include token to paket.local that just sources the given file.
E.g.

nuget Argu -> source C:\github\Argu\bin version 1.0.0
include c:\git\Dependency1\Bin\nugets\paket.local.inc
include c:\git\Dependency2\Bin\nugets\paket.local.inc
include c:\git\Dependency3\Bin\nugets\paket.local.inc
nuget Fake group Build -> source c:\github\FAKE\bin
Known workarounds

Again, some bash magic

cat ../{Dependency1,Dependency2,Dependency3}/bin/nugets/paket.local.inc > paket.local

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review the proposed paket.local and paket.local.inc examples first, including how multiple dependency snippets should be sourced. Define the include behavior and its path-handling rules, then verify that a combined paket.local can consume the listed snippets without the shell workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.