NPM — JS: Настройка окружения

Установка Node.js добавляет в систему не только интерпретатор, но и несколько важных утилит для работы с JavaScript-проектами. Среди них утилита npm (node package manager, пакетный менеджер). Она позволяет работать с любым Javascript-проектом как с npm-пакетом.

# Так можно проверить ее наличие
npm --version

6.14.5

npm выполняет множество важных задач, с которыми мы будем знакомиться в течение курса. Сейчас нас интересует ее базовое использование – создание (инициализация) нового npm-пакета. Под проектом понимается код какого-то приложения, например, конкретного сайта.

Для создания нового npm-пакета нужно выполнить две вещи:

1. Создать директорию проекта – место, внутри которого будут располагаться все файлы с кодом. Эта директория называется корнем проекта.
2. Запустить команду инициализации npm init в корне проекта.

# Создание директории
mkdir hexlet-hello-world
# Переход внутрь директории
cd hexlet-hello-world

# Инициализация npm-пакета
# init – означает initialization
npm init

This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

Press ^C at any time to quit.
package name: (hexlet-hello-world)

В процессе инициализации, npm задаст несколько вопросов на тему того, как должен называться npm-пакет, какая у него должна быть версия, описание и тому подобное. Все эти вопросы можно смело пропускать, у вас всегда будет возможность поменять ответы.

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

{
  "name": "tmp",
  "version": "1.0.0",
  "type": "module",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

package.json — это текстовый файл, внутри которого данные хранятся в JSON формате. Этот формат позволяет описывать данные как пары "ключ-значение", где значением может быть сам JSON. В примере выше — это значение ключа scripts.

Обратите внимание на ключ "type" в JSON выше. Эту часть нужно добавить самостоятельно, исправив файл. Она нужна для работы системы импортов.

После завершения процесса инициализации можно приступать к самому главному — написанию кода. По умолчанию код создается внутри файла index.js, лежащего в корне npm-пакета (там, где создан файл package.json). Это не значит, что весь проект состоит из одного файла. Файлов с кодом можно создавать сколько угодно, главное, при этом, что основная работа происходит внутри index.js, куда импортируется код из остальных файлов.

Самостоятельная работа

1. Выполните инициализацию в корне проекта hexlet-js. Не забудьте добавить ключ type, как в теории
2. Заполните пустые поля файла package.json. Подробное описание каждого поля можно посмотреть в документации npm
3. Запустите код в index.js из предыдущего урока, убедитесь что все работает
4. Добавьте все изменения на Github

Дополнительные материалы

1. NPM
2. Эталонный репозиторий Node.js