Logo Paket

RestoreProcess Module

Contains methods for the restore process.

Types

Type Description

RestoreProjectOptions

Functions and values

Function or value Description

CopyToCaches force caches fileName

Full Usage: CopyToCaches force caches fileName

Parameters:
    force : bool
    caches : Cache seq
    fileName : string

force : bool
caches : Cache seq
fileName : string

CreateInstallModel (alternativeProjectRoot, root, groupName, sources, caches, force, package)

Full Usage: CreateInstallModel (alternativeProjectRoot, root, groupName, sources, caches, force, package)

Parameters:
Returns: Async<(GroupName * PackageName) * (PackageInfo * InstallModel)>
alternativeProjectRoot : string option
root : string
groupName : GroupName
sources : PackageSource list
caches : Cache list
force : bool
package : PackageInfo
Returns: Async<(GroupName * PackageName) * (PackageInfo * InstallModel)>

CreateScriptsForGroups lockFile groups

Full Usage: CreateScriptsForGroups lockFile groups

Parameters:
lockFile : LockFile
groups : Map<GroupName, LockFileGroup>

ExtractPackage (alternativeProjectRoot, root, groupName, sources, caches, force, package, localOverride)

Full Usage: ExtractPackage (alternativeProjectRoot, root, groupName, sources, caches, force, package, localOverride)

Parameters:
Returns: Async<PackageInfo * Lazy<NuGetPackageContent>>

Downloads and extracts a package. returns - package, libs files, props files, targets files, analyzers files

alternativeProjectRoot : string option
root : string
groupName : GroupName
sources : PackageSource list
caches : Cache list
force : bool
package : PackageInfo
localOverride : bool
Returns: Async<PackageInfo * Lazy<NuGetPackageContent>>

FSharpCore

Full Usage: FSharpCore

Returns: PackageName
Returns: PackageName

FindOrCreateReferencesFile projectFile

Full Usage: FindOrCreateReferencesFile projectFile

Parameters:
Returns: ReferencesFile
projectFile : ProjectFile
Returns: ReferencesFile

FindPackagesNotExtractedYet dependenciesFileName

Full Usage: FindPackagesNotExtractedYet dependenciesFileName

Parameters:
    dependenciesFileName : string

Returns: (GroupName * PackageName) list

Finds packages which would be affected by a restore, i.e. not extracted yet or with the wrong version

dependenciesFileName : string
Returns: (GroupName * PackageName) list

ImplicitPackages

Full Usage: ImplicitPackages

Returns: Set<PackageName>
Returns: Set<PackageName>

Restore (dependenciesFileName, projectFile, force, group, ignoreChecks, failOnChecks, targetFrameworks, outputPath, skipRestoreTargetsExtraction)

Full Usage: Restore (dependenciesFileName, projectFile, force, group, ignoreChecks, failOnChecks, targetFrameworks, outputPath, skipRestoreTargetsExtraction)

Parameters:
    dependenciesFileName : string
    projectFile : RestoreProjectOptions
    force : bool
    group : GroupName option
    ignoreChecks : bool
    failOnChecks : bool
    targetFrameworks : string option
    outputPath : string option
    skipRestoreTargetsExtraction : bool

dependenciesFileName : string
projectFile : RestoreProjectOptions
force : bool
group : GroupName option
ignoreChecks : bool
failOnChecks : bool
targetFrameworks : string option
outputPath : string option
skipRestoreTargetsExtraction : bool

RestoreNewSdkProject lockFile resolved groups projectFile targetFrameworks outputPath

Full Usage: RestoreNewSdkProject lockFile resolved groups projectFile targetFrameworks outputPath

Parameters:
Returns: ReferencesFile
lockFile : LockFile
resolved : Lazy<Map<(GroupName * PackageName), PackageInfo>>
groups : Map<GroupName, LockFileGroup>
projectFile : ProjectFile
targetFrameworks : string option
outputPath : DirectoryInfo option
Returns: ReferencesFile

copiedElements

Full Usage: copiedElements

Returns: bool ref
Returns: bool ref

createAlternativeNuGetConfig (projectFile, objDirectory)

Full Usage: createAlternativeNuGetConfig (projectFile, objDirectory)

Parameters:
projectFile : FileInfo
objDirectory : DirectoryInfo

createPaketCLIToolsFile cliTools fileInfo

Full Usage: createPaketCLIToolsFile cliTools fileInfo

Parameters:
cliTools : ResolvedPackage seq
fileInfo : FileInfo

createPaketPropsFile lockFile cliTools referencesFile packages fileInfo

Full Usage: createPaketPropsFile lockFile cliTools referencesFile packages fileInfo

Parameters:
Returns: bool * string
Type parameters: 'a
lockFile : LockFile
cliTools : ResolvedPackage seq
referencesFile : ReferencesFile
packages : ((GroupName * PackageName) * PackageInstallSettings * 'a) seq
fileInfo : FileInfo
Returns: bool * string

createProjectReferencesFiles lockFile projectFile referencesFile resolved groups targetFrameworks objDir

Full Usage: createProjectReferencesFiles lockFile projectFile referencesFile resolved groups targetFrameworks objDir

Parameters:
lockFile : LockFile
projectFile : ProjectFile
referencesFile : ReferencesFile
resolved : Lazy<Map<(GroupName * PackageName), PackageInfo>>
groups : Map<GroupName, LockFileGroup>
targetFrameworks : string option
objDir : DirectoryInfo

extractElement root name

Full Usage: extractElement root name

Parameters:
    root : string
    name : string

Returns: bool * string
root : string
name : string
Returns: bool * string

extractPaketTargets root

Full Usage: extractPaketTargets root

Parameters:
    root : string

Returns: string

Extracts the paket.targets that `paket auto-restore on` imports into the projects without the SDK

root : string
Returns: string

extractRestoreTargets root

Full Usage: extractRestoreTargets root

Parameters:
    root : string

Returns: string
root : string
Returns: string

findAllReferencesFiles root

Full Usage: findAllReferencesFiles root

Parameters:
    root : string

Returns: Result<(ProjectFile * ReferencesFile) list, DomainMessage>
root : string
Returns: Result<(ProjectFile * ReferencesFile) list, DomainMessage>

objDirectory (projectFileInfo, outputPath)

Full Usage: objDirectory (projectFileInfo, outputPath)

Parameters:
Returns: DirectoryInfo
projectFileInfo : FileInfo
outputPath : DirectoryInfo option
Returns: DirectoryInfo

Type something to start searching.