Памятка по Package.json

Если вы пробовали себя в веб-разработке и сталкивались с Node / NPM, возможно, вы также встречали package.json. Будучи студентом, изучающим веб-разработку, я подумал, что поделюсь своими знаниями с помощью серии шпаргалок, начиная с package.json.

Что такое package.json?

В среде разработки Node есть замечательный удобный менеджер пакетов под названием Node Package Manager, также известный как npm. С помощью этого диспетчера пакетов вы можете быстро установить пакеты для проекта. Файл package.json содержит все зависимости вашего проекта. Считайте файл package.json индексом всех установленных пакетов и метаданных, таких как название проекта, лицензии, имя автора и т. Д.

Как начать работу с package.json?

Шаг 1: npm init

Первое, что вам нужно сделать, это создать файл package.json. К счастью, поскольку npm устанавливается вместе с Node, все, что вам нужно сделать, это запустить npm init из командной строки. Запуск npm init вызовет ряд вопросов, на которые нужно ответить.

Совет. Если вы хотите пропустить вопросы, запустите npm init -y, чтобы автоматически отвечать на все вопросы положительно и быстро создать package.json.

Шаг 2: npm install <insert_name_of_package_here> --save

Теперь, когда у вас есть файл package.json, вы можете начать добавлять пакеты, выполнив команду npm install, за которой следует имя пакета. Если вы не используете --save,, пакет не будет автоматически сохранен в package.json. В противном случае вам придется вручную ввести его в файл package.json.

Совет. Ярлык для написания команды - npm i -S <insert_name_of_package_here>.

Что внутри файла package.json?

name: Имя папки проекта.

version: Версия проекта. По умолчанию будет 1.0.0.

description: Описание проекта. Если оставить пустым, описание может брать информацию из файла readme, если он включен.

author: Автор проекта.

contributors: Участники проекта.

scripts: Здесь вы можете добавлять скрипты.

main: входной файл проекта.

repository: Здесь вы можете добавить тип репозитория и URL-адрес репо.

bugs: здесь вы можете добавить URL-адрес для сообщения об ошибках / проблемах.

keywords: может включать любые теги, относящиеся к проекту.

dependencies: Все сохраненные вами пакеты будут перечислены здесь следующим образом: 'jquery':'^3.2.1' Эти пакеты будут автоматически установлены, когда кто-либо попытается установить ваши пакеты.

devDependencies: Эти пакеты предназначены для разработки и тестирования.

license: Лицензия на проект.

Какой карат в моих зависимостях?

Когда пакет установлен, вы увидите значок каракули рядом с версией пакета, например 'jquery':'^3.2.1'. Но вы также можете установить нужную вам версию пакета, вручную добавив ее в файл package.json и запустив justnpm i.

Советы по версии пакета

~version Приблизительно соответствует указанной версии.

^version Должен быть совместим с указанной версией.

version Должна быть указана точная версия.

Что такое скрипты? Как я могу использовать их в package.json?

Язык сценария или язык сценариев - это компьютерный язык с рядом команд в файле, который может выполняться без компиляции.

Скрипт NPM - действительно мощный инструмент, который вы можете использовать, чтобы помочь вам эффективно создать проект.

Это все ключевые слова скрипта npm.

"scripts": {
    "start": "node server.js",
    "custom-script": "custom command written here"
}

Если вы используете одно из ключевых слов сценария npm, вы можете запустить их, набрав npm <script_keyword> в командной строке.
Если вы заинтересованы в создании собственных сценариев, вы можете ввести желаемое имя в поле "custom-script", а сценарий - в разделе "custom command written here". Затем вы можете запустить настраиваемый сценарий, набрав npm run custom-script в командной строке.
Как вариант, вы можете очень легко написать собственные сценарии bash и запускать их через npm.