Зачем нужен package.json?
Для публичных пакетов или проектов с несколькими участниками необходим файл package.json в корне проекта. В локальных проектах, не предназначенных для распространения, он необязателен.
Пример файла package.json:
{
"name": "my-project",
"version": "1.0.0"
}Формат файла — JSON (JavaScript Object Notation), стандарт обмена данными. JSON-объект содержит пары «ключ-значение», где ключ заключён в кавычки. JSON легко преобразуется в JavaScript-объект и обратно.
Создание файла package.json
Файл package.json создаётся вручную или с помощью npm или yarn. Команда npm init (или yarn init) предлагает интерактивно задать параметры проекта: название, версию, описание и т.д.
Практическое применение npm init
Пример создания файла package.json с помощью npm init в терминале:
npm initКоманда запросит параметры (пример):
- package name: babel-intro
- version: 1.0.0
- description: (опущено)
- entry point: (по умолчанию: index.js)
- test command: (опущено)
- git repository: (не указан)
- keywords: (опущено)
- author: (опущено)
- license: ISC (бесплатная лицензия)
После выполнения команды файл package.json будет создан в корне проекта. Проверить это можно командой ls. Файл содержит заданные параметры: название и версию проекта.
Пример файла package.json публичного пакета
Пример файла package.json для публичного пакета babel-cli: содержит название проекта, версию, описание, домашнюю страницу, лицензию (бесплатную), репозиторий Git, ключевые слова и список зависимостей. Каждая зависимость имеет свою версию. Подробности о версионировании будут описаны позже.
npm init и package.json важны для управления проектами Node.js, особенно публичными или командными. Правильное использование упрощает разработку и совместную работу.