Npm install флаг —save, как работает?
Чем установка c флагом —save отличает от установки без этого флага?
Ведь все равно все прописывается в package.json?
- Вопрос задан более трёх лет назад
- 5554 просмотра
Комментировать
Решения вопроса 2
Представьте торт, для его приготовления шефу нужны продукты, именно они войдут в состав торта. Но для приготовления понадобятся и инструменты вроде мисок, ложек, лопаток и т. п. А еще на кухне есть столы и печи, холодильники и т. д., то что используется для приготовления любого блюда, общие инструменты которые есть на кухне.
То же самое и с зависимостями проекта — некоторые будут использованы в результирующем продукте, другие необходимы только на стадии разработки, а есть такие что необходимо использовать вне зависимости от проекта.
—save — указывает что добавляется зависимость которая войдет в финальный продукт. Пакет будет установлен локально, в папку node_modules, и будет добавлена запись в поле dependencies в package.json.
—save-dev — указывает что добавляется зависимость разработки. Пакет будет установлен локально, в папку node_modules, и будет добавлена запись в поле devDependencies в package.json.
Написано 40 минут назад
Ответ написан более трёх лет назад
Нравится 3 1 комментарий
Я бы чутка добавил вашу аналогию в вашем выводе:
—save-dev — указывает, что ложки и тарелки нужны только для приготовления и их не нужно подавать на стол
—save — указывает, что конкретная ложка и вилка нужна для подачи на стол
ну а без флага, видимо, означает, что у нас в принципе будет где-то в шкафу валяться чашка и при необходимости мы можем ее использовать в дальнейшем.
Поправьте плиз, если я неправильно понял
Без этого флага просто установится пакет, в package.json ничего не добавится.
Ответ написан более трёх лет назад
Нравится 2 3 комментария
sinevik @sinevik Автор вопроса
Добавляется, вот только что без save прописал все равно добавилось
Действительно, в npm5 пакет добавляется в зависимости по умолчанию. Таким образом этот флаг устарел.
флаг не устарел, он устанавливается по умолчанию!! если ничего не указано))
Ответы на вопрос 0
Ваш ответ на вопрос
Войдите, чтобы написать ответ
- Node.js
- +4 ещё
Как сконфигурировать бэк и фронт через api?
- 2 подписчика
- 2 часа назад
- 80 просмотров
Что такое npm и зачем он нужен
Node.js — платформа, с помощью которой создают серверные приложения на JavaScript. В ее основе — модульная система, которая позволяет подтягивать отдельные пакеты в приложение.
Для управления зависимостями в Node.js используют Node Package Manager (npm). Он загружает и устанавливает необходимые для проекта модули из сторонних источников.
Рассказываем, как работать с npm.
Инициализация и установка пакетов
Разработка ведется на разных устройствах, а команда может установить необходимые модули в терминале. Пакеты в таком случае подтягиваются из открытых или частных репозиториев. Найти и прочитать информацию о пакете (описание, версионность, частота внесения изменений) можно в реестре npm.
Частота скачиваний за неделю (Weekly Downloads) и количество зависимостей (Dependents) свидетельствуют о надежности пакета — чем их больше, тем чаще его используют разработчики.
Также информацию о пакете можно посмотреть с помощью команды в терминале:
Для инициализации проекта введите npm init
Эта команда запрашивает у разработчика основную информацию о проекте и генерирует package.json на основе ответов. В этом файле хранится информация о проекте и его зависимостях.
курс по теме: Алгоритмы и структуры данных
Артем Верещака Tech Lead в Bolt
Этап с вопросами можно пропустить с помощью npm init -y. Пакеты загружаются командой npm install или, сокращенно, npm i. Если в вашем проекте уже есть package.json, подтянутся модули, которые в нем указаны. Если пакет не был прописан в package.json, нужно написать его название после команды:
Пакеты можно подтягивать не только по имени, но и по ссылке:
В конце команд можно добавлять флаги, которые модифицируют их выполнение. Например, добавить зависимость в package.json:
По умолчанию пакеты устанавливаются в директорию node_modules в папке проекта. Также доступна установка в глобальное хранилище на ПК. Например, на Windows — в папку AppData на диске с операционной системой. Для этого нужно добавить флаг:
Пакеты можно обновить до последней версии с помощью команды npm update
статьи по теме:
Рассказывает FullStack Developer (React/Node.js) в SoftServe.
Что нужно, чтобы стать фулстеком.
Версионность npm
Иногда новый пакет некорректно работает с другими зависимостями или может содержать ошибки. Чтобы это исправить, можно установить более раннюю версию. Выделяют три группы версий:
- MAJOR — пакет, в котором код и логика существенно отличается от предыдущих, например, был заменен ключевой класс. Версия 3.0.0 будет существенно отличаться от 2.0.0.
- MINOR — пакет, в который просто был добавлен новый функционал, например, 3.1.0 расширяет 3.0.0.
- PATCH — тут только вносились патчи и фиксы. Если нам нужно будет внести фикс в 3.1.0, то мы назовем версию 3.1.1.
Чтобы посмотреть все версии пакета, нужно ввести команду:
Для установки конкретной версии используется команда с указанием версии после @:
Добавление флага —save-exact установит и добавит последнюю версию в package.json. Таким же способом можно откатиться до необходимой.
Скрипты и тесты
package.json содержит не только общую информацию о проекте и зависимостях, но и скрипты, которые разработчики используют для сборки приложений, запуска линтеров, тестов. Польза скриптов в том, что они позволяют не запоминать длинные последовательности команд. Скрипты находятся в разделе scripts и содержат название и сами команды:
"scripts": < "build": "npm run build:node && npm run build:browser", "build:browser": "rollup -c config/rollup.browser-config.js", "build:node": "rollup -c config/rollup.node-config.js", "clean": "git clean -fdxe node_modules", "lint": "eslint src/", "start": "node -i -e 'YAML=require(\"./dist/index.js\")'", >Например, скрипт lint запускает линтер для директории src. Для запуска скриптов используется команда:
Если ваш проект содержит тесты, их можно запустить с помощью:
Если вы забыли нужную команду или доступные для нее флаги, вы можете ввести:
Также доступна документация с описанием всех команд и флагов для различных версий npm.
В чём отличие npm install —save-dev от —save
В версии npm 6.5 можно не писать -save или -s , npm сам добавит установленный пакет вам в «dependencies»: < >.
-P , —save-prod : опять же сохранит в «dependencies»: < >. Это ваш код для продакшена, он будет включен в ваш конечный продукт. Добавляйте сюда только те библиотеки, которые будут использованы при работе вашего конечного продукта (вэб страницы например).
-D , —save-dev : сохранит пакет в «devDependencies»: < >. Это пакеты, которые вы используете в процессе девелопмента, препроцессоры LESS, SASS, валидаторы кода, JShint Slint, препроцессоры JS: Babel. Эти пакеты не будут включены в конечный продукт.
-O , —save-optional : пакет будет добавлен в «optionalDependencies»: < >. эти пакеты могут быть использованы в работе, но если они будут недоступны или произойдет ошибка при их установке, то npm просто пропустит их и продолжит работу.
—no-save : Запрещает сохранять пакет в package.json.
-E , —save-exact : сохранит версию пакета точно, как указано.
-B , —save-bundle : сохранит пакет в «bundleDependencies»: < >.
Что такое npm? Руководство по Node Package Manager для начинающих
Эта статья послужит хорошим руководством по вашему любимому верному спутнику Node.js – npm .
Node.js штурмует мир с 2009 года. Сотни тысяч систем были построены с помощью Node.js, что побудило сообщество разработчиков заявить, что «JavaScript поглощает программное обеспечение».
Одним из составляющий успеха Node стал npm – его популярный диспетчер пакетов, который позволяет разработчикам JavaScript быстро и легко обмениваться полезными пакетами, такими как lodash и moment .
На момент написания этой статьи npm поспособствовал публикации более 1,3 миллионов пакетов с еженедельной загрузкой более 16 миллиардов! Эти цифры являются фантастическими для любого программного инструмента. Итак, а теперь давайте поговорим о том, что же такое npm .
Что такое NPM?
NPM, или Node Package Manager, — это диспетчер пакетов для среды выполнения JavaScript Node.js.
Он также известен как “Ninja Pumpkin Mutants», «Nonprofit Pizza Makers», а также множество других случайных имен, с которыми вы можете поэкспериментировать и, возможно, внести свой вклад в расширения npm.
NPM состоит из двух основных частей:
- инструмент CLI (command-line interface – интерфейс командной строки) для публикации и загрузки пакетов
- онлайн-репозиторий, в котором размещаются пакеты JavaScript.
Для более наглядного представления можно представить, что репозиторий npmjs.com – это распределительный центр, который получает пакеты товаров от продавцов (авторов пакетов npm ) и распространяет их среди покупателей (пользователей пакетов npm ).
Для того, чтобы облегчить данный процесс, в распределительном центре npmjs.com работает армия трудолюбивых вомбатов (CLI), которые назначаются в качестве личных помощников для каждого отдельного клиента npmjs.com. таким образом, пакеты доставляются разработчикам JavaScript следующим образом:
А процесс публикации пакеты для ваших коллег по JavaScript выглядит примерно так:
Ну и да, вомбаты не настоящие, если что, а для наглядности 🙂
Давайте посмотрим, как же эта армия вомбатов помогает разработчикам, которые хотят использовать пакеты JavaScript в своих проектах. Мы также будем наблюдать то, как они помогают мастерам по открытом исходному коду выпускать свои потрясающие библиотеки в свет.
package.json
Каждый проект в JavaScript – будь то Node.js или приложение браузера – может рассматриваться как пакет npm с собственной информацией о пакете и функциями package.json для описания проекта.
Можно представить, что package.json – это этикетки на коробках с npm , которые доставляет ваша армия вомбатов.
package.json создается при запуске npm init для инициализации проекта JavaScript/Node.js со следующими основными метаданными, предоставленными разработчиками:
- name : имя вашей библиотеки/проекта JavaScript.
- version : версия вашего проекта. Часто при разработке приложений этим полем пренебрегают, так как нет очевидной необходимости в управлении версиями библиотек с открытым исходным кодом. Но тем не менее, эта информация может пригодиться в качестве источника версии развертывания.
- description : описание проекта.
- license : лицензия на проект.
npm-скрипты
package.json также поддерживает scripts (скрипты), которые можно определить для запуска инструментов командной строки, установленных в локальном контексте проекта. Например, скрипты проекта npm могут выглядеть примерно так:
При этом eslint , prettier , ncc , jest не обязательно должны быть установлены как глобальные исполняемые файлы, а скорее даже как локальные для вашего проекта внутри node_modules/.bin/ .
Недавнее введение npx позволяет запускать эти команды в области видимости проекта node_modules точно так же, как глобально установленную программу, просто добавив префикс npx . (то есть npx prettier —write **/*.ts ).
dependencies VS devDependencies
Эти двое представляют собой объекты типа «ключ-значение», где ключ – это имена библиотек npm , а значение – это их версии в семантическом формате. Ниже представлен пример шаблона действия TypeScript на GitHub:
< "dependencies": < "@actions/core": "^1.2.3", "@actions/github": "^2.1.1" >, "devDependencies": < "@types/jest": "^25.1.4", "@types/node": "^13.9.0", "@typescript-eslint/parser": "^2.22.0", "@zeit/ncc": "^0.21.1", "eslint": "^6.8.0", "eslint-plugin-github": "^3.4.1", "eslint-plugin-jest": "^23.8.2", "jest": "^25.1.0", "jest-circus": "^25.1.0", "js-yaml": "^3.13.1", "prettier": "^1.19.1", "ts-jest": "^25.2.1", "typescript": "^3.8.3" >>
Эти пакеты, от которых зависит приложение, (dependencies) устанавливаются с помощью команды npm install с флагами —save и —save-dev . Они предназначены для использования в эксплуатационной среде и среде разработки/тестирования соответственно. В следующем разделе мы рассмотрим подробнее, как установить эти пакеты.
Между тем, важно понимать, что означают знаки, которые могут стоять перед семантической версией (при условии, что вы ознакомились с моделью semver major.minor.patch ):
- ^ : последний второстепенный выпуск. Например, спецификация ^1.0.4 может установить версию 1.3.0 , если это последняя дополнительная версия основной серии 1 .
- ~ : последний выпуск исправления. Аналогично ^ для второстепенных выпусков – спецификация ~1.0.4 может установить версию 1.0.7 , если это последняя второстепенная версия во второстепенной серии 1.0 .
Все точные версии пакетов будут задокументированы в созданном файле package-lock.json .
package-lock.json
Этот файл описывает точные версии пакетов, используемых в проекте JavaScript npm. Если package.json — это общая описательная этикетка, то package-lock.json — это список ингредиентов.
И точно так же, как мы обычно не читаем список ингредиентов продукта (если только вам совсем нечем себя занять или вам действительно нужно знать состав), так и package-lock.json не предназначен для того, чтобы разработчики читали его построчно (если только вы отчаянно не пытаетесь решить проблемы из области «как это работает»).
package-lock.json обычно создается с помощью команды npm install , а также считывается нашим инструментом NPM CLI, чтобы обеспечить воспроизведение сред сборки для проекта в помощью npm ci .
Как эффективно управлять NPM в качестве «покупателя»
Учитывая тот факт, что было опубликовано 1,3 миллиона пакетов, а загрузок было 16 миллиардов, можно сделать вывод, что большинство пользователей npm используют его именно для загрузки пакетов. Поэтому стоит знать, как пользоваться этим мощным инструментом.
npm install
Это наиболее часто используемая команда при разработке приложений JavaScript/Node.js.
По умолчанию команда npm install устанавливает последнюю версию пакета со знаком версии ^ . Команда npm install в контексте проекта npm загружает пакеты в папку node_modules проекта в соответствии со спецификациями package.json , обновляя версию пакета (и, в свою очередь, повторно создавая package-lock.json ) везде, где это возможно, основываясь на соответствиях версии ^ и ~ .
Вы можете указать глобальный флаг -g , если хотите установить пакет в глобальном контексте – вы сможете использовать его в любом месте на вашем компьютере (это обычно используется для пакетов инструментов командной строки, таких как like-server).
npm делает установку пакетов JavaScript настолько простой, что эту команду часто используют неправильно. Это приводит к тому, что npm становится предметом огромного количества шуток со стороны программистов, таких как эти:
Здесь на помощь приходит флаг —production ! В предыдущем разделе мы обсудили dependencies и devDependencies, предназначенные для использования в эксплуатационной среде и среде разработки/тестирования соответственно. Этот флаг определяет то, как создаются отличительные признаки в node_modules .
Добавив этот флаг к команде npm install , мы сможем устанавливать пакеты только из dependencies, тем самым резко уменьшая размер наших модулей node_modules до необходимого для запуска и работы наших приложений.
npm ci
Итак, если команда npm install —production оптимальна для эксплуатационной среды, то существует ли команда, которая будет оптимальная для моей локальной разработки и настройки тестирования?
Точно так же, как если package-lock.json еще не существует в проекте, то он генерируется всякий раз при вызове команды npm install , npm ci использует этот файл для загрузки точной версии каждого отдельного пакета, от которого зависит проект.
Именно так мы можем убедиться в том, что контекст нашего проекта остается одинаковым на любом оборудовании, будь то наши ноутбуки, которые мы используем для разработки, или среды сборки CI (Continuous Integration – непрерывная интеграция), такие как Github Actions.
npm audit
Из-за огромного количества пакетов, которые были опубликованы и могут быть легко установлены, пакеты npm уязвимы из-за недобросовестных авторов с недобрыми намерениями.
Понимая, что в экосистеме возникла проблема, организация npm.js предложила ввести команду npm audit . Она поддерживает список брешей в системе безопасности, с помощью которых разработчики могут проверять свои пакеты с помощью этой команды.
npm audit предоставляет разработчикам информацию об уязвимостях и о том, существуют ли версии с исправлениями для обновления. Например:
Если исправления доступны в следующих некритических обновлениях версии, то команду npm audit fix можно использовать для автоматического обновления версий затронутых пакетов.
Как эффективно управлять NPM в качестве «продавца»
Мы рассмотрели, как использовать инструмент NPM CLI в качестве потребителя, но что насчет его эффективного использования в качестве автора (и, возможно, становления мастером JavaScript по открытому исходному коду?)?
npm publish
Отправить пакет в распределительный центр npmjs.com очень просто – достаточно просто запустить команду npm publish . Сложность заключается в определении версии пакета, но она не относится к авторам пакетов npm .
Практическое правило согласно semver.org:
- ОСНОВНАЯ (MAJOR) версия при внесении несовместимых изменений API;
- ВТОРОСТЕПЕННАЯ (MINOR) версия при добавлении функциональности и сохранении совместимости;
- Версия ИСПРАВЛЕНИЯ (PATCH) при исправлении ошибок и сохранении совместимости с предыдущими версиями.
Это очень важно – следовать приведенному выше правилу при публикации ваших пакетов, чтобы не нарушать чей-либо программный код, так как соответствие версий по умолчанию в npm – ^ (она же следующая второстепенная версия).