Skip to content

Latest commit

 

History

History
490 lines (342 loc) · 15.5 KB

dependencies-file.md

File metadata and controls

490 lines (342 loc) · 15.5 KB

The paket.dependencies file

The paket.dependencies file is used to specify rules regarding your application's dependencies. It contains top level dependencies from all projects in the solution, while paket.references file specifies dependencies for particular project.

To give you an overview, consider the following paket.dependencies file:

source https://api.nuget.org/v3/index.json

// NuGet packages
nuget NUnit ~> 2.6.3
nuget FAKE ~> 3.4
nuget DotNetZip >= 1.9

// Files from GitHub repositories.
github forki/FsUnit FsUnit.fs

// Gist files.
gist Thorium/1972349 timestamp.fs

// HTTP resources.
http http://www.fssnip.net/1n decrypt.fs

The file specifies that Paket's NuGet dependencies should be downloaded from nuget.org and that projects require:

Paket uses this definition to compute a concrete dependency resolution, which also includes transitive dependencies. The resulting dependency graph is then persisted to the paket.lock file.

Only direct dependencies should be listed; you can use the paket simplify command to remove transitive dependencies.

Sources

Paket supports the following source types:

Global options

Required Paket version

It is possible to require a specific Paket version for a paket.dependencies file. This can be achieved by a line which starts with version followed by a requested paket.exe version and optionally bootstrapper command line arguments:

version 3.24.1

source https://api.nuget.org/v3/index.json
nuget FAKE
nuget FSharp.Core ~> 4

or

version 3.24.1 --prefer-nuget

source https://api.nuget.org/v3/index.json
nuget FAKE
nuget FSharp.Core ~> 4

Strict references

Paket usually adds all direct and transitive dependencies that are listed in paket.references files to project files next to the respective paket.references file. In strict mode it will only add direct dependencies and you need to add transitive dependencies yourself to paket.references.

references: strict
source https://nuget.org/api/v2

nuget Newtonsoft.Json ~> 6.0
nuget UnionArgParser ~> 0.7

Note that the resolution phase is not affected by this option, it will still resolve, lock and download all transitive references.

Prerelease versions

If you want to depend on prereleases then Paket can assist you.

source https://nuget.org/api/v2

nuget xunit prerelease
nuget xunit.runner.visualstudio prerelease

More details and information about prerelease channels can be found here.

Framework restrictions

Sometimes you do not want to generate dependencies for other .NET Framework versions than the ones your projects use. You can control this in the paket.dependencies file:

// Download and install only for .NET 3.5 and .NET 4.0.
framework: net35, net40

source https://nuget.org/api/v2

nuget Example >= 2.0

Which may be translated to:

Paket, I only compile for net35 and net40, please leave out all other stuff I don't need to compile for this set of frameworks.

The supported framework identifiers include:

  • .NET Framework: net{version}
  • .NET Core: netcoreapp{version}
  • .NET Standard: netstandard{version}
  • .NET Framework for Unity: net{version}-Unity {Web|Micro|Subset|Full} v{version}
  • Mono for Android: monoandroid{version}
  • Mono for Mac: monomac
  • MonoTouch: monotouch
  • Native: native or native({buildmode},{platform})
  • Xamarin for Mac: xamarinmac
  • Xamarin for iOS: xamarinios
  • Xamarin for watchOS: xamarinwatchos
  • Xamarin for tvOS: xamarintvos
  • Universal Windows Platform: uap{version}
  • Windows: win{version}
  • Windows Phone: wp{version}
  • Windows Phone App: wpa{version}
  • Silverlight: sl{version}
  • Tizen: tizen{version}

Automatic framework detection

Paket is able to detect the target frameworks from your projects and then limit the installation to these. You can control this in the paket.dependencies file:

// Only the target frameworks that are used in projects.
framework: auto-detect

source https://nuget.org/api/v2

nuget Example >= 2.0

If you change the target framework of the projects then you need to run paket install again.

External lock files

Paket is able to consume external paket.lock files. External lock files allow to pin dependencies to the versions that are used on a target runtime platform like Azure Functions.

In the paket.dependencies file you can use external_lock and point to a http resource or a local file:

source https://nuget.org/api/v2

external_lock https://myUrl/azurefunctions-v1-paket.lock

nuget Example >= 2.0

The paket install process will pin all dependencies to exactly the versions from the external paket.lock file.

Disable packages folder

With the net netcore release and the switch to provide more and more netstandard-only packages the Paket team noticed a dramatic increase of the well known "packages" folder. Historically one way was to tell Paket that you only want to compile for framework: net45. However, this doesn't prevent netstandard dependencies in all situations. On the other side more features are provided by Paket and the packages folder has become more and more redundant:

  • Load scripts can reference the files in the global cache
  • csproj/fsproj files can references files in the global cache
  • netcore project files don't require any explicit dll-references

Therefore, the paket team decided to make the "packages" folder opt-out.

You can opt-out of generating the packages folder by using the storage option:

// Do not extract into the "packages" folder but use a globally shared directory
storage: none
source https://nuget.org/api/v2

nuget jQuery

The option may be overriden by packages. However, the behavior is undefined and may change (please open an issue if you depend on the current behavior or we break you).

The storage option has three values:

  • storage: packages (the default, relevant for FAKE 5 where the default for inline-dependencies is storage: none)
  • storage: none disable the packages folder and use the global NuGet cache (default in FAKE 5 inline-dependencies)
  • storage: symlink use the packages folder but use symlinks instead of physical files
// make a symlink instead copy the packages.
storage: symlink
source https://nuget.org/api/v2

nuget jQuery

In this mode, paket will use a directory symbolic link (soft) between nuget cache and packages folder. Symlink option can save a disk space on CI server. Before setting this option, configure the user rights assignment / create symbolic links and check your security prerequisites : https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links

Known issue : "You do not have sufficient privilege to perform this operation"

  • Remove account from Administrators group
  • Configure the create symbolic links (SeCreateSymbolicLinkPrivilege)
  • Check symlink behavior
fsutil behavior query SymlinkEvaluation

Symlink behavior should be set to at least "Local to local symbolic links are enabled" (L2L enabled)

Controlling whether content files should be copied to the project

The content option controls the installation of any content files:

// Do not install jQuery content files.
content: none

source https://nuget.org/api/v2

nuget jQuery >= 0

The global option may be overridden per package.

Controlling whether content files should be copied to the output directory during build

It's possible to influence the CopyToOutputDirectory property for content references via the copy_content_to_output_dir option:

copy_content_to_output_dir: always

source https://nuget.org/api/v2

nuget jQuery
nuget Fody
nuget ServiceStack.Swagger

The global option may be overridden per package.

Controlling whether assemblies should be copied to the output directory during build

It's possible to influence the Private property for references via the copy_local option:

copy_local: false

source https://nuget.org/api/v2

nuget Newtonsoft.Json

The global option may be overridden per package.

Importing *.targets and *.props files

If you don't want to import *.targets and *.props files from packages, you can disable it via the import_targets option:

// Do not import *.targets and *.props.
import_targets: false

source https://nuget.org/api/v2

nuget Microsoft.Bcl.Build
nuget UnionArgParser ~> 0.7

The global option may be overridden per package.

License download

If you want paket to download licenses automatically you can use the license_download modifier. It is disabled by default.

source https://nuget.org/api/v2
license_download: true

nuget suave

The global option may be overridden per package.

Controlling assembly binding redirects

This option tells Paket to create Assembly Binding Redirects for all referenced libraries. This option only instructs Paket to create and manage binding redirects in existing App.config files, it will not create new App.config files for you.

However you can create App.config files as necessary by running paket install --create-new-binding-files.

redirects: on

source https://nuget.org/api/v2

nuget UnionArgParser ~> 0.7

The global option may be overridden per package.

If you're using multiple groups, you must set redirects: off for each one.

redirects: off

source https://nuget.org/api/v2

nuget UnionArgParser ~> 0.7 redirects: on
nuget FSharp.Core redirects: force

group Build
  redirects: off

  source https://nuget.org/api/v2

  nuget FAKE redirects: on

If you want Paket to always create redirects for all packages then you can use the following:

redirects: force
source https://nuget.org/api/v2

nuget FSharp.Core
nuget Newtonsoft.JSON

Resolver strategy for transitive dependencies

The strategy option tells Paket what resolver strategy it should use for transitive dependencies. The strategy can be either min or max with max being the default.

NuGet's dependency syntax led to a lot of incompatible packages on nuget.org. To make your transition to Paket easier and to allow package authors to correct their version constraints you can have Paket behave like NuGet when resolving transitive dependencies (i.e. defaulting to lowest matching versions).

strategy: min

source https://nuget.org/api/v2

nuget UnionArgParser ~> 0.7

The min strategy means you get the lowest matching version of your transitive dependencies (i.e. NuGet-style). In contrast, a max strategy will get you the highest matching version.

Note, however, that all direct dependencies will still get their latest matching versions, no matter the value of the strategy option. If you want to influence the resolution of direct dependencies then read about the lowest_matching option.

The only exception is when you are updating a single package and one of your direct dependencies is a transitive dependency for that specific package. In this case, only the updating package will get its latest matching version and the dependency is treated as transitive.

The global option may be overridden per package.

Resolver strategy for direct dependencies

The lowest_matching option tells Paket what resolver strategy it should use for direct dependencies. It can be either true or false with false being the default.

lowest_matching: true
source https://nuget.org/api/v2

nuget UnionArgParser ~> 0.7

lowest_matching: true means you get the lowest matching version of your direct dependencies. In contrast, a lowest_matching: false will get you the highest matching version.

Note, however, that all transitive dependencies will still get their latest matching versions, no matter the value of the lowest_matching option. If you want to influence the resolution of transitive dependencies then read about the strategy option.

The global option may be overridden per package.

Load script generation

This option tells Paket to generate load scripts for interactive environments like F# Interactive or ScriptCS. These scripts reference installed packages.

The generate_load_scripts option can be either true or false with false being the default.

generate_load_scripts: true

source https://nuget.org/api/v2

nuget Suave

Generated load scripts can be loaded like this:

#load @".paket/load/net45/suave.fsx"

Simplify prevention

This option gives paket a hint around your itention for the paket simplify. The paket simplify is a heuristic simplification & can sometimes think a dependency is not required in your dependencies file. By adding this option, you can prevent the simplify command from removing the dependency.

The simplify option can be either never or false. If it's not present, no simplify preference has been set

source https://nuget.org/api/v2

nuget Suave simplify: never

Comments

All lines starting with with // or # are considered comments.