Logo Paket

InstallProcess Module

Contains methods for the install process.

Functions and values

Function or value Description

CreateModel (alternativeProjectRoot, root, force, dependenciesFile, lockFile, packages, updatedGroups)

Full Usage: CreateModel (alternativeProjectRoot, root, force, dependenciesFile, lockFile, packages, updatedGroups)

Parameters:
Returns: ((GroupName * PackageName) * (PackageInfo * InstallModel)) array
Type parameters: 'a

Restores the given packages from the lock file.

alternativeProjectRoot : string option
root : string
force : bool
dependenciesFile : DependenciesFile
lockFile : LockFile
packages : Set<GroupName * PackageName>
updatedGroups : Map<GroupName, 'a>
Returns: ((GroupName * PackageName) * (PackageInfo * InstallModel)) array

Install (options, forceTouch, dependenciesFile, lockFile, updatedGroups, touchedPackages)

Full Usage: Install (options, forceTouch, dependenciesFile, lockFile, updatedGroups, touchedPackages)

Parameters:
Type parameters: 'a

Installs all packages from the lock file.

options : InstallerOptions
forceTouch : bool
dependenciesFile : DependenciesFile
lockFile : LockFile
updatedGroups : Map<GroupName, 'a>
touchedPackages : (GroupName * PackageName * SemVerInfo option * SemVerInfo option) list option

InstallIntoProjects (options, forceTouch, dependenciesFile, lockFile, projectsAndReferences, updatedGroups, touchedPackages)

Full Usage: InstallIntoProjects (options, forceTouch, dependenciesFile, lockFile, projectsAndReferences, updatedGroups, touchedPackages)

Parameters:
Type parameters: 'a

Installs all packages from the lock file.

options : InstallerOptions
forceTouch : bool
dependenciesFile : DependenciesFile
lockFile : LockFile
projectsAndReferences : (ProjectFile * ReferencesFile) list
updatedGroups : Map<GroupName, 'a>
touchedPackages : (GroupName * PackageName * SemVerInfo option * SemVerInfo option) list option

brokenDeps

Full Usage: brokenDeps

Returns: HashSet<string * string>
Returns: HashSet<string * string>

contentFileIgnoreList

Full Usage: contentFileIgnoreList

Returns: (FileInfo -> bool) list
Returns: (FileInfo -> bool) list

findPackageFolder root (groupName, packageName) (version, settings)

Full Usage: findPackageFolder root (groupName, packageName) (version, settings)

Parameters:
Returns: DirectoryInfo
root : string
groupName : GroupName
packageName : PackageName
version : SemVerInfo
settings : InstallSettings
Returns: DirectoryInfo

installForDotnetSDK root project

Full Usage: installForDotnetSDK root project

Parameters:
root : string
project : ProjectFile

processContentFiles root project usedPackages gitRemoteItems options

Full Usage: processContentFiles root project usedPackages gitRemoteItems options

Parameters:
Type parameters: 'a
root : string
project : ProjectFile
usedPackages : Map<(GroupName * PackageName), (SemVerInfo * InstallSettings)>
gitRemoteItems : FileItem list
options : 'a

shouldWarnAboutFSharpCoreRedirects targetProfiles createBindingRedirects

Full Usage: shouldWarnAboutFSharpCoreRedirects targetProfiles createBindingRedirects

Parameters:
Returns: bool

Determines whether the "FSharp.Core references without redirects: force" warning should be emitted for a project that targets the given profiles and has the given resolved binding-redirect settings for its FSharp.Core reference. Binding redirects (and the App.config files they live in) are only relevant for projects that target the classic .NET Framework (net5.0 and later is modelled as DotNetFramework V5+ but is not .NET Framework) - .NET Core/.NET 5+ and netstandard-only projects use assembly unification via deps.json instead, so the warning would be noise there.

targetProfiles : TargetProfile list
createBindingRedirects : BindingRedirectsSettings option
Returns: bool

updatePackagesConfigFile model packagesConfigFileName

Full Usage: updatePackagesConfigFile model packagesConfigFileName

Parameters:
model : Map<(GroupName * PackageName), (SemVerInfo * InstallSettings)>
packagesConfigFileName : string

Type something to start searching.