Что такое пакеты nuget

Общее представление о NuGet

| Вторник, 12 февраля, 2013

Во время установки пакета, NuGet копирует файлы в проект и автоматически делает необходимые изменения, такие как добавление ссылок и изменение файлов конфигурации app.config или web.config. Если вы решили удалить библиотеку, NuGet удаляет установленные файлы, а также отменяет изменения сделанные при установке, таким образом не остается никакого мусора и беспорядка.

Пакеты NuGet

Использование NuGet в Visual Studio

NuGet работает во всех версиях Visual Studio 2012, Visual Studio 2010, Visual Web Developer 2010 и Windows Phone Developer Tools 7.1. Найти, установить, удалить или обновить пакеты можно в диалоговом окне Manage Nuget Packages или через командную строку PowerShell в Package Manager Console. Все это встроено в Visual Studio и доступно через главное меню и либо через контекстное меню в Solution Explorer.

Диалог управления пакетами NuGet

На картинке показан диалог управления пакетами NuGet. Вкладка Online показывает все доступные пакеты на официальном фиде.

Командная консоль управления пакетами

Так выглядит Командная консоль управления пакетами.

Поддерживаемые операционные системы

Для PowerShell командлетов (cmdlets) требуется PowerShell 2.0. Поэтому NuGet будет работать на следующих операционных системах:

Источник

Вопросы и ответы по NuGet

Часто задаваемые вопросы, относящиеся к NuGet.org, например вопросы об учетных записях NuGet.org, см. в разделе Вопросы и ответы по NuGet.org.

Общие сведения

Что необходимо для запуска NuGet?

Все данные по пользовательскому интерфейсу и средствам командной строки доступны в руководстве по установке.

Поддерживает ли NuGet Mono?

Средство командной строки nuget.exe выполняет построение и запускается с помощью Mono 3.2 или более поздней версии и поддерживает создание пакетов в Mono.

хотя nuget.exe работает полностью на Windows, существуют известные проблемы в Linux и OS X. см. сведения о nuget.exe в GitHub.

Графический клиент доступен в виде надстройки для MonoDevelop.

Как можно определить, что содержит пакет, и является ли он стабильным и полезным для моего приложения?

Основным источником информации о пакете является его страница сведений на веб-сайте nuget.org (или в другом закрытом веб-канале). На странице каждого пакета на веб-сайте nuget.org приводится описание проекта, история его версий и статистика использования. В разделе Сведения на странице пакета также приводится ссылка на веб-сайт проекта, где обычно можно найти много примеров и других документов, с помощью которых можно оценить полезность пакета.

Дополнительные сведения см. в разделе Поиск и выбор пакетов.

NuGet в среде Visual Studio

Каким образом обеспечивается поддержка NuGet в различных продуктах Visual Studio?

Как определить точную версию устанавливаемых средств NuGet?

в Visual Studio используйте команду справка по Microsoft Visual Studio и просмотрите версию, которая отображается рядом с пунктом NuGet диспетчер пакетов.

Какие языки программирования поддерживает NuGet?

Последняя версия NuGet поддерживает C#, Visual Basic, F#, WiX и C++.

Какие шаблоны проектов поддерживает NuGet?

NuGet обеспечивает полную поддержку множества шаблонов проектов, включая Windows, Интернет, облако, SharePoint, Wix и другие.

Как обновить пакеты, которые являются частью шаблонов Visual Studio?

Перейдите на вкладку Обновления в пользовательском интерфейсе диспетчера проектов и выберите Обновить все или воспользуйтесь командой в консоли диспетчера проектов.

Чтобы обновить сам шаблон, необходимо вручную обновить репозиторий шаблонов. Дополнительные сведения по этой теме см. в блоге Ксавье Декостера (Xavier Decoster). Обратите внимание, что все это вы делаете на свой страх и риск, поскольку ручное обновление может привести к повреждению шаблона в том случае, если последние версии всех зависимостей несовместимы друг с другом.

Можно ли использовать NuGet вне среды Visual Studio?

Командная строка NuGet

Как получить последнюю версию средства командной строки NuGet?

Для чего нужна лицензия на веб-сайте nuget.exe?

Вы можете распространить nuget.exe в соответствии с условиями лицензии MIT. Вы несете ответственность за обновление и обслуживание всех распространяемых вами копий nuget.exe.

Можно ли расширить возможности средства командной строки NuGet?

Консоль диспетчера пакетов NuGet (Visual Studio для Windows)

Как получить доступ к объекту DTE в консоли диспетчера пакетов?

Это известная проблема, связанная с взаимодействием PowerShell с COM-объектом. Попробуйте выполнить следующие действия:

Get-Interface — это вспомогательная функция, добавляемая узлом PowerShell NuGet.

Создание и публикация пакетов

Как включить мой пакет в веб-канал?

Как настроить свой собственный репозиторий или веб-канал?

Как выполнить массовую загрузку пакетов в мой веб-канал NuGet?

Работа с пакетами

Можно ли устанавливать пакеты NuGet без подключения к Интернету?

Да. См. статью блога Скотта Ханселмана (Scott Hanselman), посвященную доступу к NuGet при неработающем веб-сайте nuget.org или во время полета на самолете (hanselman.com).

Можно ли устанавливать пакеты в папку, отличную от заданной по умолчанию?

Как избежать добавления папки пакетов NuGet в систему управления версиями?

Как отключить восстановление пакетов?

Почему при установке локального пакета с удаленными зависимостями возникает ошибка «Не удается разрешить зависимость»?

При установке локального пакета в проект выберите источник Все. При этом вместо использования одного веб-канала будут объединены все веб-каналы. Причиной этой ошибки обычно является то, что пользователи локального репозитория часто стремятся избежать случайной установки удаленного пакета из-за требований корпоративной политики.

У меня есть несколько проектов, расположенных в одной папке. Как использовать отдельные файлы packages.config для каждого проекта?

Это также не проблема при использовании PackageReference, поскольку каждый файл проекта содержит собственный список зависимостей.

Я не вижу nuget.org в списке репозиториев. Как вернуть его?

/.nuget/NuGet/NuGet.Config (Mac/Linux) и дождитесь, пока NuGet снова создаст его.

я перенессь на PackageReference, почему сборка завершается сбоем «этот проект ссылается на NuGet пакеты, отсутствующие на этом компьютере»?

Источник

Что такое NuGet?

Просто о NET | создано: 13.06.2011 | опубликовано: 13.06.2011 | обновлено: 21.12.2021 | просмотров: 42437 | комментариев: 2

В статье показано как установить NuGet и что это такое. Показаны примеры управления пакетами NuGet. Достаточно подробно и с картинками.

Если не установлен NuGet

Что такое NuGet не буду подробно рассказывать, разве что пару строк:

Со страниц официального сайта

“NuGet is a Visual Studio extension that makes it easy to install and update open source libraries and tools in Visual Studio.”

А теперь на русском

“Nuget – это одно из расширение Visual Studio, которое позволяет с легкостью устанавливать, обновлять и удалять библиотеки (сборки), компоненты, инструменты.”

Если у Вас не установлен это замечательное расширения для Visual Studio, давайте установим. Запускаем студию, идем в меню: Tools –> Extention Manager. Откроется окно менеджера, в этом окне в левой части выберим Online Gallery, менеджер покажет список доспуных расширений. По идеи, Вы должны сразу увидеть Nuget Package Manager. Но если Вы не увидели его, напишите в строке поиска этого менеджера слово “nuget” и тогда точно перед Вами будет менеджер.

У меня на картинке NuGet Manager отмечен зеленой галкой, которая говорит, что расширение уже установлено. Если Вы нажмете кнопку Install, у Вас появится такой же зеленый значок.

Как установить пакет (способ 1 “Визуальный”)

Я создал просто консольное приложение (просто для демонстрации). В Solution Explorer правой кнопкой мыши нажимаем на Preferences и в меню выбираем пункт Add Library Package references. Этот пункт меню должен появиться после установки менеджера пакетов NuGet.

В открывшемся окне, также как и в менеджере расширений для Visual Studio, есть список доступных галерей (слева). Хочу напомнить, что можно получать пакеты как с официального сайта (NuGet official package source), так и папки на своем компьютере, так и с NuGet-сервера локальной сети.

Я в поиске написал свой ник и увидел список доступных пакетов, которые я сделал сам:

Допустим, что я хочу в своё консольное приложение добавить несколько классов и наполнить их данными, чтобы поэкспериментировать с LINQ. Я выберу пакет SampleData и нажму Install. После установки пакет отметился зеленой галкой, а в списке сборок проекта появилась сборка SampleData, которая содержит классы и данные для них:

Если запустить приложение, то я увижу

Как установить NuGet-пакет (способ 2 “Для продвинутых”)

Давайте теперь создадим другое приложение, пусть оно тоже будет консольное. Теперь будем устанавливать Implementation a simple IoC, этот пакет я сделал тоже сам и для себя (но можете тоже пользовать на здоровье). После установки Nuget Package Manager в меню Visual Studio появились новые пункты, например, Tools –> Library Package Manager –> Package Manager Console.

Открыв консоль можно писать команды для менеджера:

Обратите внимание, что выпадающее окно Package source позволяет выбрать конкретный источник пакетов или использовать все доступные.

Напишу-ка я команду для установки моего пакета с IoC:

Команда NuGetInstall-Package SimpleIoC

Пакет установлен. У меня в приложении появился файл SimpleIoC.cs, который является реализацией паттерна IoC (Инверсия в управлении). Кстати, в приложении появился еще одни новый файл packages.config, который, как раз, и содержит информацию об установленных пакетах. У меня в приложении он имеет теперь вид:

Ясно всё и понятно, что отображает этот файл.

Использование пакетов

Хочу отметить некоторую специфику в работе с пакетами. Дело в том, что пакеты это нечто иное, как просто файлы подгруженные к Вашему проекту с учетом некоторых параметров. Например, мой файл SimpleIoC.cs появляется в проекте с учетов namespace. Процесс подмены шаблона используется тот же, что использует Visual Studio, при создании нового проекта из шаблона (или файла из шаблона). Про свойства в таких шаблонах можно почитать хранилище знаний.

NuGet “умеет” добавлять и удалять сборки, файлы, папки, но при одном условии. Если папка, файл или сборка не поменяла название (содержание). Раз уж я установил пакет, то я могу его и удалить:

Источник

Visual Studio. Знакомство с NuGet Manager

В этом видеоуроке мы поговорим о таком полезном инструменте, как NuGet Manager, что это такое и для чего он нужен.

Под управлением подразумевается поиск, скачивание, установка, настройка, обновление и удаление файлов сторонних разработчиков у себя в приложении.

Технически NuGet Manager представляет собой расширение для Visual Studio, доступное программисту в процессе работы над своим проектом. Если вы используете «студию» версии 2012 и выше, то NuGet уже заранее предустановлен и готов к работе. В случае версии 2010 его нужно установить вручную. Его можно скачать либо с официального сайта, либо установить напрямую из Visual Studio через менеджер дополнений.

Давайте откроем менеджер. Для этого в Solution Explorer щелкаем правой кнопкой мыши по рабочему проекту и в контекстном меню выбираем пункт «Manage NuGet Packages…»:

NuGet Manager открывается в новой вкладке в текстовом редакторе. Интерфейс у него довольно простой.

Три главные вкладки:

Также в интерфейсе менеджера представлены:

Попробуем установить какую-нибудь библиотеку к нам в проект, например, Entity Framework. Для этого переходим во вкладку Browse и в строке поиска начинаем вводить название нужного пакета. Далее выбираем его из списка и нажимаем кнопку Install. При необходимости можно выбрать определенную версию, отличную от стабильной последней, а также ознакомиться с информацией о данном пакете (авторы, лицензия и т.д.).

В зависимости от устанавливаемого пакета NuGet Manager также определит все его зависимости, или, другими словами, все дополнительные библиотеки, которые требуются устанавливаемому пакету для полноценной работы. В случае с Entity Framework таких зависимостей нет.

Теперь давайте более детально посмотрим, что конкретно сделал менеджер при установке этого компонента в наш проект:
1. Он определил, что для данного пакета нет никаких сторонних зависимостей. Если бы они были, то менеджер автоматически их определил и подтянул.
2. NuGet Manager добавил ссылку на установленный компонент в наш проект (References):

3. NuGet разместил скачанные файлы в специальной папке Packages, которая находится в корневой папке нашего приложения. Это очень удобно, ссылки в проекте теперь идут на эту папку:

4. В конфигурационный файл packages.config была добавлена запись о новом пакете:

5. В конфигурационный файл приложения web.config также были внесены необходимые изменения, чтобы подготовить компонент Entity Framework к работе:

Вот такие операции происходят, когда NuGet Manager добавляет новую библиотеку к нам в проект.

Подобным образом происходит и обновление, и удаление компонентов из нашего проекта. В случае удаления менеджер также автоматически вносит изменения в файлы нашего проекта – убирает записи из файла packages.config, удаляет соответствующие файлы в папке packages, убирает ссылки на эти библиотеки.

Давайте рассмотрим еще несколько моментов.

Работа в консоли ничем не отличается от работы в графическом интерфейсе, это дело вкуса.

Управление осуществляется посредством специальных команд. Чтобы вывести в консоль список всех доступных команд нужно написать инструкцию:

Команд достаточно много, и описание каждой можно найти в официальной документации на сайте. Вот пример использования наиболее популярных команд.

Добавляем пакет Entity Framework в текущий проект:

Обновляем ранее установленный пакет:

Переустанавливаем ВСЕ пакеты во всех проектах в данном решении:

Вы также можете создать и опубликовать свой собственный пакет в репозиторий nuget.org, тем самым сделав его публичным и доступным через NuGet Manager. Для этого нужно соблюсти ряд правил и условий, а также правильно подготовить свой проект к публикации. Опять же всю информацию об этом можно найти в официальной документации.

Подведем краткий итог. NuGet – это просто незаменимый инструмент для разработчика на сегодняшний день. Он автоматизирует весь процесс работы с пакетами в проекте, а именно поиск, скачивание, установка, настройка, обновление и удаление файлов.

В видео версии этого урока более подробно и наглядно показана работа с этим инструментом.

Источник

Рекомендации по созданию пакетов

Типы рекомендаций

В каждой статье приводится список рекомендаций таких типов: Do, Consider, Avoid и Do not. Тип рекомендации указывает на то, насколько строго следует ее придерживаться.

Рекомендациям Do нужно следовать практически всегда. Пример:

✔️ СЛЕДУЕТ включить краткое описание пакета, которое описывает его содержимое.

Рекомендациям типа РЕКОМЕНДУЕТСЯ обычно также нужно следовать, но могут быть и исключения:

✔ РЕКОМЕНДУЕТСЯ выбрать имя пакета NuGet с префиксом, который соответствует критериям для резервирования префикса NuGet.

Рекомендации Avoid обычно относятся к нежелательным действиям, но иногда их можно нарушать.

❌ AVOID Ссылки на пакеты NuGet, требующие указания точной версии.

Рекомендации Do not указывают на то, чего практически никогда не следует делать.

Создание пакета NuGet

Последний рекомендуемый способ создания пакета NuGet — на основе проекта в стиле пакета SDK. Свойства проекта в стиле пакета SDK, включая целевую платформу и метаданные пакета определяются в файле проекта.

Создайте пакет из проекта в стиле пакета SDK, определив необходимые свойства и упаковку в Visual Studio или dotnet CLI.

✔️ СЛЕДУЕТ создать проект в стиле пакета SDK и создать (упаковать) пакет с помощью Visual Studio или dotnet CLI.

Более подробные инструкции по созданию пакетов, включая необходимые клиентские средства, примеры файлов проекта и команды, см. в статье Создание пакета NuGet с помощью dotnet CLI.

Метаданные пакета

Метаданные — это базовый компонент любого пакета NuGet. Качество ваших метаданных может значительно повлиять на возможность обнаружения, удобство использования и надежность пакета.

В Visual Studio для указания метаданных пакета выберите «Проект > Свойства [имя проекта] > Пакет».

Элементы метаданных пакета также могут быть указаны непосредственно в файле проекта.

Ниже приведено сопоставление таблиц и описание доступных элементов метаданных пакета.

Идентификатор пакета

При публикации совершенно нового пакета:

✔️ СЛЕДУЕТ выбрать уникальный идентификатор пакета, который отличается от идентификаторов существующих пакетов на сайте NuGet.org.

✔ РЕКОМЕНДУЕТСЯ выбрать имя пакета NuGet с префиксом, который соответствует критериям резервирования префикса NuGet.

Когда вы зарезервируете идентификатор префикса для пакета, отобразится галочка, указывающая на успешную проверку: .

Версия пакета

✔ СЛЕДУЕТ использовать SemVer для управления версиями пакета NuGet.

По сути это означает, что используется следующий формат: основная_версия.дополнительная_версия.исправление[-предварительный_выпуск].

✔️ СЛЕДУЕТ опубликовать пакет в виде пакета предварительного выпуска, если он не является стабильным или является предварительной версией.

Авторы

✔️ СЛЕДУЕТ использовать поле Author (Автор) для указания своего имени или названия организации.

Например, если имя пользователя NuGet.org — m.ivanova и вы используете «Marina Ivanova» в этом поле, пользователям будет легче распознать автора. Если имя пользователя NuGet.org для организации — ContosoToolkit, название «Contoso Corporation» так же будет более узнаваемым и внушающим доверие.

Описание

✔️ СЛЕДУЕТ включить краткое описание пакета (до 4000 символов).

Описание пакета — это один из наиболее значимых блоков информации при поиске NuGet. Обычно это первое, на что обращают внимание пользователи при определении того, подходит ли им такой пакет.

Copyright

✔️ РЕКОМЕНДУЕТСЯ защитить авторское право, указав «Copyright (c) «.

Уведомление об авторских правах означает, что вашу работу нельзя копировать без разрешения. Включение уведомления об авторских правах в пакет — это простая операция, которая не влечет никаких последствий.

Пример. Copyright (c) Contoso 2020

Лицензирование

Проект без лицензии по умолчанию предусматривает монопольное авторское право. Это означает, что вы не предоставили кому-либо разрешения на использование вашего проекта.

Так вы создадите юридически неоднозначную ситуацию, ведь изменения лицензии в URL-адресе приведут к изменению отображаемой лицензии для предыдущих версий пакета.

Если пакет имеет открытый код

✔️ СЛЕДУЕТ выбрать лицензию с открытым кодом, чтобы сделать пакет открытым.

«Лицензии на ПО с открытым кодом — это лицензии, которые соответствуют определению открытого кода. По сути, они позволяют свободно использовать, изменять и распространять программное обеспечение». — Open Source Initiative. Дополнительные сведения о программном обеспечении с открытым кодом и Open Source Initiative см. здесь: https://opensource.org/.

Выражения лицензий являются наиболее понятными. Они информируют пользователей о том, могут ли они использовать ваш пакет или изменилась ли лицензия.

NuGet.org принимает только лицензионные выражения для лицензий, утвержденных Open Source Initiative или Free Software Foundation.

Если пакет не включает открытый код

В пакет можно включить любой файл лицензии (в формате TXT или MD), в том числе нестандартные лицензии.

URL проекта

✔️ РЕКОМЕНДУЕТСЯ включить ссылку на связанный проект, репозиторий или веб-сайт компании.

Сайт проекта должен предоставлять всю информацию о пакете. Обычно именно там пользователи будут искать документацию.

Значок

✔️ РЕКОМЕНДУЕТСЯ использовать значок для пакета, чтобы его можно было визуально отличить. Даже такое относительно небольшое улучшение положительно влияет на оценку пакета.

Значки могут быть разными для отдельных пакетов, а также использовать фирменную символику.

✔️ СЛЕДУЕТ использовать изображение размером 128×128 пикселей с прозрачным фоном (в формате PNG), чтобы обеспечить оптимальное отображение.

NuGet автоматически масштабирует изображение для клиента, в котором он отображается.

Тип репозитория и URL-адрес

✔ РЕКОМЕНДУЕТСЯ настроить Source Link, чтобы автоматически добавить метаданные системы управления версиями в пакет NuGet и упростить отладку библиотеки.

Source Link автоматически добавляет Repository URL и Repository Type в метаданные пакета. При этом также добавляется конкретная фиксация, связанная с версией пакета.

✔️ СЛЕДУЕТ включить несколько тегов с ключевыми терминами, описывающими ваш пакет, чтобы улучшить обнаружение.

Теги обрабатываются алгоритмом поиска NuGet.org и особенно полезны при наличии терминов, которые не включены в идентификатор пакета, но являются релевантными.

Например, при публикации пакета для записи строк в консоль можно включить следующее: «ведение журнала, журнал, консоль, строка, выходные данные».

Заметки о выпуске

✔️ РЕКОМЕНДУЕТСЯ включать заметки о выпуске в каждое обновление с описанием внесенных изменений.

Хотя для заметок о выпуске не требуется специальный формат, рекомендуется включить сведения о следующем:

Если вы уже отслеживаете заметки о выпуске или журнал изменений в репозитории, можно также включить ссылку на соответствующий файл.

Источник