Команды NPM - Node Package Manager

Node package manager

Показать документацию по Node package manager

npm help

Показать справку по конкретной команде Node package manager

npm help <command>

Показать документацию по структуре файла package.json

npm help json

Простейшая структура файла package.json

{
    name: 'packageName',
    version: '1.0',
    main: 'myModuleName', // Внимание! Значение main подставляется в URL-адреса и названия команд!
    modules: {
        'mod1': 'lib/mod1',
        'mod2': 'lib/mod2'
    }
}

Модуль можно загрузать в коде череза require('myModuleName')

Проверка наличия модуля в репозитории по адресу http://search.npmjs.org

npm search myModuleName

Указание зависимостей модуля от других модулей

dependecies: {
    foo: '1.0.0 - 2.9999.9999',
    bar: '>= 1.0.2 < 2.1.2'
}

Сведения об авторе модуля

description: 'My first super module.',
homepage: 'http://www.mysite.com',
author: 'Dmitry'

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

bin: {
    'nodeload.js': './nodeload.js',
    'nl.js': './nl.js'
}

Получить подсказку по скриптовым командам модуля

npm help scripts

Структура папок внутри модуля

direcotories: {
    lib: './lib',
    bin: './bin'
}

Показать список установленных модулей

npm list

Показать список установленных модулей в более удобном виде в виде адресов к папкам

npm set parseable=true
npm list

Установка модуля

npm install moduleName

Модуль устанавливается в локальную папку node_modules

Для установки модуля в глобальную папку node_modules Node.js необходимо использовать флаг -g

npm install -g moduleName

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

npm install moduelName@2.3.1

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

npm install moduleName@stable

Определить куда был установлен Node.js

which node

Установка правила устававливать все модули глобально

npm set global=true

Показать занчение параметра global

npm get global

Поиск модулей производится на сайте http://npmjs.org или http://search.npmjs.org
или командой

npm search moduleName

Вывод содержимого файла package.json любого (даже не скаченного) модуля в командную строку

npm view moduleName

Вывод любого значения из файла package.json модуля

npm view moduleName homepage

Вывод версии модуля

npm view moduleName version

Вывод зависимостей модуля

npm view moduleName dependecies

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

npm test moduleName

Если отредактировать содержимое модуля, то после этого необходимо его перестроить, набрав команду

npm rebuild moduleName

Проверка даты обновления модуля в репозитории

npm outdated

Обновление устаревших модулей

npm update moduleName

Удалени установленного модуля

npm uninstall moduleName

Создание модуля

0) Создание и переход в папку будущего модуля

mkdir myModule
cd myModule

1) Создание файла package.json

npm  init

2) Создание кода модуля

3) Заведение аккаунта в публияном репозитории

npm adduser

4) Публикация модуля в публичном репозитории

npm publish

5) Поиск своего модуля на сайте http://search.npmjs.org

6) Удаление своего модуля из публичного репозитория при необходимости

npm unpublish

Команды конфигурации Node package manager

npm config set color true --global
npm config get color
npm config delete color

npm config list
npm config edit

npm get color
npm set color true --global

Конфигурационные параметры можно помещать в следующие файлы
$HOME/.npmrc
Инсталляционный каталог Node/etc/npmrc

Конфигурационный файл Node package manager содержит пары name=value и обновляется командой

npm config set

Номера версия модуля

version: 'X.Y.Z', где
X - основной номер (0 - совершеннно нестабилен, 1 и далее - внесены несовместимые изменения)
Y - дополнительный номер (тут добален новый функционал)
Z - номер исправления (тут исправлены только ошибки)