Paket


Converting from NuGet

Automatic NuGet conversion

Paket comes with a command that helps to convert existing solution from NuGet's packages.config format to Paket's format.

  1. Please start by making a backup of your repository
  2. Download Paket and it's bootstrapper as described in the "Getting started" tutorial
  3. Run the convert-from-nuget command:
1: 
$ .paket/paket.exe convert-from-nuget

Read more about the details and parameters for convert-from-nuget.

Preparation

Choose a directory to run the conversion from that is parent to all the projects to be converted.

When NuGet package restore is enabled, the packages directory is located next to the solution. It is also possible that the parent directory of packages is not also parent to all the projects in the solution.

A solution is effectively acting as a symlink, but this indirection via the solution is not possible with Paket because Paket manages projects and not solutions. In the example below, it would not be possible to run the paket convert-from-nuget command from the Build directory but it would be from the root directory.

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
.
├── Build
│   ├── Numbers.sln
│   ├── .nuget
│   │   ├── NuGet.Config
│   │   ├── NuGet.exe
│   │   └── NuGet.targets
│   └── packages
└── Encoding
    ├── Encoding.fsproj
    └── packages.config

After running the conversion from the root directory:

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
.
├── .paket
│   ├── paket.bootstrapper.exe
│   ├── paket.exe
│   └── paket.targets
├── packages
├── Build
│   └── Numbers.sln
└── Encoding
    ├── Encoding.fsproj
    └── paket.references

Command steps

The paket convert-from-nuget command:

  1. Finds all packages.config files, generates a paket.dependencies file in the solution root and replaces each packages.config with an equivalent paket.references file.

  2. If there is a solution-level packages.config, then it will be removed and its dependencies will be included in the paket.dependencies file.

  3. If you use NuGet Package Restore (MSBuild-Integrated or Automatic Visual Studio Package Restore), then the paket auto-restore on command will be invoked.

  4. Unless --no-install is specified, the paket install process will be executed. This will

    • analyze the dependencies,
    • generate a paket.lock file,

    • remove all the old package references from your project files and install new references in Paket's syntax.

  5. If you specify --force, the conversion will attempt to infer additional dependencies from newly added or previously unprocessed packages.config files and

Migrating NuGet source credentials

If you are using authorized NuGet feeds, convert-from-nuget will automatically migrate the credentials for you. Following are valid modes for the --migrate-credentials option:

  • encrypt: Encrypt credentials and save them in the Paket configuration file.
  • plaintext: Include credentials in plaintext in the paket.dependencies file. See example.
  • selective: Use this option if have more than one authorized NuGet feed and you want to apply different modes for each of them.

Simplify to direct dependencies

After converting your solution from NuGet, you may end up with many transitive dependencies in your Paket files. Consider using paket simplify to remove unnecessary transitive dependencies from your paket.dependencies and paket.references files.

Partial NuGet conversion

convert-from-nuget will not work if it discovers that the codebase already utilizes Paket (i.e. paket.dependencies file is found). However, if for some reason you happen to have a mixture of projects already migrated to Paket and projects still using NuGet, you can pass the --force flag to convert-from-nuget for the remaining projects.

Fork me on GitHub