Compartir a través de

Paquetes en plantillas de Visual Studio

  • Artículo

Las plantillas de proyecto y elemento de Visual Studio suelen necesitar asegurarse de que se instalan determinados paquetes cuando se crea el proyecto o elemento. Por ejemplo, la plantilla ASP.NET MVC 3 instala jQuery, Modernizr y otros paquetes.

Para admitir esto, los autores de plantillas pueden indicar a NuGet que instale los paquetes necesarios, en lugar de bibliotecas individuales. Después, los desarrolladores pueden actualizar con facilidad esos paquetes en cualquier momento.

Para obtener más información sobre la creación de las plantillas propiamente dichas, vea Cómo: Crear plantillas de proyectos o Creating Custom Project and Item Templates (Creación de plantillas de proyecto y elemento personalizadas).

En el resto de esta sección se describen los pasos específicos para seguir al crear una plantilla a fin de incluir correctamente paquetes NuGet.

Ejemplos

El ejemplo Preinstalled-Packages está disponible en el repositorio NuGet/Samples en GitHub.

Agregar paquetes a una plantilla

Cuando se crea una instancia de una plantilla, se invoca un Asistente para plantillas para cargar la lista de paquetes que se van a instalar junto con información sobre dónde encontrarlos. Los paquetes pueden estar insertados en el VSIX, en la plantilla o ubicados en la unidad de disco duro local en cuyo caso se usa una clave del Registro para hacer referencia a la ruta de acceso del archivo. Más adelante en esta sección se proporcionan detalles sobre estas ubicaciones.

Los paquetes preinstalados funcionan con asistentes para plantilla. Un asistente especial se invoca cuando se crea una instancia de la plantilla. El asistente carga la lista de paquetes que se deben instalar y pasa esa información a las API de NuGet adecuadas.

Pasos para incluir paquetes en una plantilla:

  1. En el archivo vstemplate, agregue una referencia al Asistente para plantillas de NuGet agregando un elemento WizardExtension:

    <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 es un ensamblado que solo contiene la clase TemplateWizard, que es un contenedor sencillo que llama a la implementación real en NuGet.VisualStudio.dll. La versión del ensamblado no cambia nunca, por lo que las plantillas de proyecto y elemento siguen funcionando con las nuevas versiones de NuGet.

  2. Agregue la lista de paquetes para instalar en el proyecto:

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

    El asistente admite varios elementos <package> para admitir varios orígenes de paquetes. Los atributos id y version son obligatorios, lo que significa que esa versión específica del paquete se instalará incluso si hay disponible una versión más reciente. Esto evita que las actualizaciones del paquete afecten a la plantilla, dejando la opción de actualizar el paquete al desarrollador que usa la plantilla.

  3. Especifique el repositorio donde NuGet puede encontrar los paquetes tal como se describe en las secciones siguientes.

Repositorio de paquetes de VSIX

El enfoque de implementación recomendado para las plantillas de proyecto y elemento de Visual Studio es una extensión VSIX porque permite empaquetar varias plantillas de proyecto o elemento, y que los desarrolladores detecten las plantillas con facilidad mediante el Administrador de extensiones de VS o la Galería de Visual Studio. Las actualizaciones de la extensión también son fáciles de implementar con el mecanismo de actualización automática del Administrador de extensiones de Visual Studio.

La propia extensión VSIX puede actuar como el origen de los paquetes necesarios para la plantilla:

  1. Modifique el elemento <packages> del archivo .vstemplate como sigue:

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

    El atributo repository especifica el tipo de repositorio como extension, mientras que repositoryId es el identificador único de la propia extensión VSIX (es el valor del atributo ID del archivo vsixmanifest de la extensión; consulte VSIX Extension Schema 2.0 Reference [Referencia de esquema 2.0 de extensión VISX]).

  2. Coloque los archivos nupkg en una carpeta denominada Packages dentro de VSIX.

  3. Agregue los archivos de paquete necesarios como <Asset> en su archivo vsixmanifest (consulte VSIX Extension Schema 2.0 Reference [Referencia de esquema 2.0 de extensión VISX]):

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

  4. Tenga en cuenta que puede entregar los paquetes en la misma VSIX que las plantillas de proyecto o colocarlos en una VSIX independiente si resulta más apropiado para su escenario. Pero no haga referencia a ninguna VSIX sobre la que no tenga control, porque los cambios de esa extensión pueden afectar a la plantilla.

Repositorio de paquetes de plantilla

Si solo va a distribuir una plantilla de proyecto o elemento, y no es necesario empaquetar varias plantillas, puede usar un enfoque más sencillo pero más limitado que incluya los paquetes directamente en el archivo ZIP de la plantilla de proyecto o elemento:

  1. Modifique el elemento <packages> del archivo .vstemplate como sigue:

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

    El atributo repository tiene el valor template y el atributo repositoryId no es necesario.

  2. Coloque los paquetes en la carpeta raíz del archivo ZIP de la plantilla de proyecto o elemento.

Tenga en cuenta que el uso de este enfoque en una extensión VSIX que contiene varias plantillas provoca un sobredimensionamiento innecesario cuando uno o más paquetes son comunes para las plantillas. En estos casos, use la VSIX como repositorio, como se describe en la sección anterior.

Ruta de acceso de la carpeta especificada por el Registro

Los SDK que se instalaron mediante MSI pueden instalar paquetes NuGet directamente en el equipo del desarrollador. Esto hace que estén inmediatamente disponibles cuando se usa una plantilla de proyecto o elemento, en lugar de tener que extraerlos durante ese tiempo. En las plantillas de ASP.NET se usa este enfoque.

  1. Instale los paquetes en el equipo mediante el MSI. Solamente puede instalar los archivos .nupkg, o bien puede instalarlos junto con el contenido expandido, lo que ahorra un paso adicional cuando se usa la plantilla. En este caso, siga la estructura de carpetas estándar de NuGet en la que los archivos .nupkg están en la carpeta raíz y, después, cada paquete tiene una subcarpeta con el par de identificador y versión como nombre de la subcarpeta.

  2. Escriba una clave del Registro para identificar la ubicación del paquete:

    • Ubicación de la clave: ya sea el HKEY_LOCAL_MACHINE\SOFTWARE[\Wow6432Node]\NuGet\Repository de todo el equipo o si se trata de plantillas y paquetes instalados por usuario, use HKEY_CURRENT_USER\SOFTWARE\NuGet\Repository como alternativa.
    • Nombre de la clave: use un nombre que sea único para usted. Por ejemplo, en las plantillas de ASP.NET MVC 4 para VS 2012 se usa AspNetMvc4VS11.
    • Valores: la ruta de acceso completa a la carpeta de paquetes.

  3. En el elemento <packages> del archivo .vstemplate, agregue el atributo repository="registry" y especifique el nombre de la clave del Registro en el atributo keyName.

    • Si previamente ha descomprimido los paquetes, use el atributo isPreunzipped="true".

    • (NuGet 3.2 y versiones posteriores) Si quiere forzar una compilación de tiempo de diseño al final de la instalación del paquete, agregue el atributo forceDesignTimeBuild="true".

    • Como optimización, agregue skipAssemblyReferences="true" porque la propia plantilla ya incluye las referencias necesarias.

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

Procedimientos recomendados

  1. Declare una dependencia en la VSIX de NuGet agregando una referencia a ella en el manifiesto de VSIX:

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

  2. Requiera que las plantillas de proyecto y elemento se guarden al crearse incluyendo <PromptForSaveOnCreation>true</PromptForSaveOnCreation> en el archivo .vstemplate.

  3. Las plantillas no incluyen un archivo packages.config ni referencias o contenido que se pudieran agregar al instalar los paquetes NuGet.