Freigeben über

Pakete in Visual Studio-Vorlagen

Visual Studio-Projekt- und Elementvorlagen müssen häufig sicherstellen, dass bestimmte Pakete beim Erstellen eines Projekts oder Elements installiert werden. Beispielsweise installiert die ASP.NET MVC 3-Vorlage jQuery, Modernizr und andere Pakete.

Um dies zu unterstützen, können Vorlagenautoren NuGet anweisen, die erforderlichen Pakete anstelle einzelner Bibliotheken zu installieren. Entwickler können diese Pakete dann jederzeit problemlos aktualisieren.

Weitere Informationen zum Erstellen von Vorlagen selbst finden Sie unter How to: Create Project Templates or Creating Custom Project and Item Templates.

Im restlichen Teil dieses Abschnitts werden die spezifischen Schritte beschrieben, die beim Erstellen einer Vorlage ausgeführt werden müssen, um NuGet-Pakete ordnungsgemäß einzuschließen.

Beispiele

Das Beispiel "Vorinstallierte Pakete" ist im NuGet/Samples-Repository auf GitHub verfügbar.

Hinzufügen von Paketen zu einer Vorlage

Wenn eine Vorlage instanziiert wird, wird ein Vorlagen-Assistent aufgerufen, um die Liste der Zu installierenden Pakete zusammen mit Informationen darüber zu laden, wo diese Pakete gefunden werden sollen. Pakete können in den VSIX eingebettet, in die Vorlage eingebettet oder auf der lokalen Festplatte gespeichert werden. In diesem Fall verwenden Sie einen Registrierungsschlüssel, um auf den Dateipfad zu verweisen. Details zu diesen Standorten werden weiter unten in diesem Abschnitt angegeben.

Vorinstallierte Pakete funktionieren mithilfe von Vorlagen-Assistenten. Ein spezieller Assistent wird aufgerufen, wenn die Vorlage instanziiert wird. Der Assistent lädt die Liste der Pakete, die installiert werden müssen, und übergibt diese Informationen an die entsprechenden NuGet-APIs.

Schritte zum Einschließen von Paketen in eine Vorlage:

  1. Fügen Sie in Ihrer vstemplate Datei einen Verweis auf den NuGet-Vorlagen-Assistenten hinzu, indem Sie ein WizardExtension Element hinzufügen:

    <WizardExtension>
    <Assembly>NuGet.VisualStudio.Interop, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</Assembly>
    <FullClassName>NuGet.VisualStudio.TemplateWizard</FullClassName>
</WizardExtension>

    NuGet.VisualStudio.Interop.dll ist eine Assembly, die nur die TemplateWizard-Klasse enthält, die ein einfacher Wrapper ist, der die eigentliche Implementierung in NuGet.VisualStudio.dll aufruft. Die Assemblyversion ändert sich nie, sodass Projekt-/Elementvorlagen weiterhin mit neuen Versionen von NuGet funktionieren.

  2. Fügen Sie die Liste der Pakete hinzu, die im Projekt installiert werden sollen:

    <WizardData>
    <packages>
        <package id="jQuery" version="1.6.2" />
    </packages>
</WizardData>

    Der Assistent unterstützt mehrere <package> Elemente, um mehrere Paketquellen zu unterstützen. Die id- und version-Attribute sind erforderlich, was bedeutet, dass eine bestimmte Version eines Pakets installiert wird, auch wenn eine neuere Version verfügbar ist. Dadurch wird verhindert, dass Paketupdates die Vorlage beschädigen, und die Entscheidung, das Paket zu aktualisieren, wird dem Entwickler überlassen, der die Vorlage verwendet.

  3. Geben Sie das Repository an, in dem NuGet die Pakete finden kann, wie in den folgenden Abschnitten beschrieben.

VSIX-Paket-Repository

Der empfohlene Bereitstellungsansatz für Visual Studio-Projekt-/Elementvorlagen ist eine VSIX-Erweiterung , da sie es Ihnen ermöglicht, mehrere Projekt-/Elementvorlagen zusammenzupacken und Entwicklern das einfache Auffinden Ihrer Vorlagen mithilfe des VS Extension Managers oder des Visual Studio Gallery zu ermöglichen. Updates für die Erweiterung sind auch einfach bereitzustellen, indem sie den automatischen Updatemechanismus von Visual Studio Extension Manager verwenden.

Der VSIX selbst kann als Quelle für Pakete dienen, die von der Vorlage benötigt werden:

  1. Ändern Sie das <packages> Element in der .vstemplate Datei wie folgt:

    <packages repository="extension" repositoryId="MyTemplateContainerExtensionId">
    <!-- ... -->
</packages>

    Das repository-Attribut gibt den Typ des Repositorys an, während extensionrepositoryId der eindeutige Bezeichner des VSIX selbst ist (Dies ist der Wert des ID-Attributs in der vsixmanifest-Datei der Erweiterung, siehe VSIX Extension Schema 2.0 Reference).

  2. Platzieren Sie Ihre nupkg Dateien in einem Ordner mit dem Namen Packages innerhalb der VSIX.

  3. Fügen Sie die erforderlichen Paketdateien wie <Asset> in Ihrer vsixmanifest Datei hinzu (siehe VSIX Extension Schema 2.0 Reference):

    <Asset Type="Moq.4.0.10827.nupkg" d:Source="File" Path="Packages\Moq.4.0.10827.nupkg" d:VsixSubPath="Packages" />

  4. Beachten Sie, dass Sie Pakete in demselben VSIX wie Ihre Projektvorlagen bereitstellen können, oder Sie können sie in einem separaten VSIX platzieren, wenn dies für Ihr Szenario sinnvoller ist. Verweisen Sie jedoch nicht auf VSIX, über die Sie keine Kontrolle haben, da Änderungen an dieser Erweiterung Ihre Vorlage unterbrechen können.

Vorlagenpaket-Repository

Wenn Sie nur eine einzelne Projekt-/Elementvorlage verteilen und nicht mehrere Vorlagen zusammen packen müssen, können Sie einen einfacheren, aber eingeschränkteren Ansatz verwenden, der Pakete direkt in der ZIP-Datei der Projekt-/Elementvorlage enthält:

  1. Ändern Sie das <packages> Element in der .vstemplate Datei wie folgt:

    <packages repository="template">
    <!-- ... -->
</packages>

    Das repository Attribut weist den Wert template auf, und das repositoryId Attribut ist nicht erforderlich.

  2. Platzieren Sie Pakete im Stammordner der ZIP-Datei der Projekt-/Elementvorlage.

Beachten Sie, dass die Verwendung dieses Ansatzes in einem VSIX, das mehrere Vorlagen enthält, zu unnötigem Ballast führt, wenn ein oder mehrere Pakete den Vorlagen gemeinsam sind. Verwenden Sie in solchen Fällen das VSIX als Repository , wie im vorherigen Abschnitt beschrieben.

Registrierungsspezifischer Ordnerpfad

SDKs, die mit einer MSI installiert sind, können NuGet-Pakete direkt auf dem Computer des Entwicklers installieren. Dies macht sie sofort verfügbar, wenn eine Projekt- oder Elementvorlage verwendet wird, anstatt sie während dieser Zeit extrahieren zu müssen. ASP.NET Vorlagen verwenden diesen Ansatz.

  1. Lassen Sie die MSI-Installationspakete auf dem Computer installieren. Sie können nur die .nupkg Dateien installieren, oder Sie können diese zusammen mit den erweiterten Inhalten installieren, wodurch ein zusätzlicher Schritt gespeichert wird, wenn die Vorlage verwendet wird. Folgen Sie in diesem Fall der Standardordnerstruktur von NuGet, wobei sich die .nupkg Dateien im Stammordner befinden, und jedes Paket verfügt dann über einen Unterordner mit dem ID/Version-Paar als Unterordnernamen.

  2. Schreiben Sie einen Registrierungsschlüssel, um den Paketspeicherort zu identifizieren:

    • Schlüsselspeicherort: Entweder computerweit HKEY_LOCAL_MACHINE\SOFTWARE[\Wow6432Node]\NuGet\Repository oder wenn es sich um installierte Vorlagen und Pakete pro Benutzer handelt, alternativ verwenden Sie HKEY_CURRENT_USER\SOFTWARE\NuGet\Repository
    • Schlüsselname: Verwenden Sie einen Namen, der einzigartig für Sie ist. Beispielsweise verwenden AspNetMvc4VS11die ASP.NET MVC 4-Vorlagen für VS 2012.
    • Werte: der vollständige Pfad zum Ordner "Pakete".

  3. Fügen Sie im <packages> Element in der .vstemplate Datei das Attribut repository="registry" hinzu, und geben Sie den Namen des Registrierungsschlüssels keyName im Attribut an.

    • Wenn Sie Ihre Pakete vorab entzippt haben, verwenden Sie das isPreunzipped="true" Attribut.

    • (NuGet 3.2+) Wenn Sie einen Design-Time-Build am Ende der Paketinstallation erzwingen möchten, fügen Sie das forceDesignTimeBuild="true" Attribut hinzu.

    • Fügen Sie als Optimierung hinzu skipAssemblyReferences="true" , da die Vorlage selbst bereits die erforderlichen Verweise enthält.

      <packages repository="registry" keyName="AspNetMvc4VS11" isPreunzipped="true">
    <package id="EntityFramework" version="5.0.0" skipAssemblyReferences="true" />
    <-- ... -->
</packages>

Bewährte Methoden

  1. Deklarieren Sie eine Abhängigkeit von NuGet VSIX, indem Sie einen Verweis darauf in Ihrem VSIX-Manifest hinzufügen:

    <Reference Id="NuPackToolsVsix.Microsoft.67e54e40-0ae3-42c5-a949-fddf5739e7a5" MinVersion="1.7.30402.9028">
    <Name>NuGet Package Manager</Name>
    <MoreInfoUrl>http://v4.hkg1.meaqua.org/nuget/</MoreInfoUrl>
</Reference>
<!-- ... -->

  2. Erfordert, dass Projekt-/Elementvorlagen beim Erstellen gespeichert werden, indem sie in die <PromptForSaveOnCreation>true</PromptForSaveOnCreation> Datei eingeschlossen .vstemplate werden.

  3. Vorlagen enthalten keine packages.config Datei und keine Verweise oder Inhalte, die beim Installieren von NuGet-Paketen hinzugefügt werden.

  • Last updated on