re:re:actable
Урок 042 минуты чтения

Что такое npm scripts?

На этой странице
Кратко

npm scripts - команды проекта, описанные в package.json. Они позволяют запускать приложение, тесты, сборку, линтеры, миграции и другие повторяемые действия через npm run.

Вопрос

Что такое npm scripts, как их запускать и как передавать аргументы?

Где описываются scripts?

{
  "scripts": {
    "dev": "node --watch src/index.js",
    "start": "node src/index.js",
    "test": "node --test",
    "lint": "eslint ."
  }
}

Запуск:

npm run dev
npm test
npm start

test, start, stop и некоторые другие scripts можно запускать без слова run.

Зачем scripts нужны?

  • стандартизируют команды проекта;
  • прячут длинные CLI-команды;
  • упрощают onboarding;
  • используются в CI/CD;
  • уменьшают зависимость от глобально установленных утилит.

Локальные бинарники

Если пакет установлен в devDependencies, его CLI доступен внутри npm script.

{
  "devDependencies": {
    "eslint": "^9.0.0"
  },
  "scripts": {
    "lint": "eslint ."
  }
}

Не нужно ставить eslint глобально.

Передача аргументов

npm run test -- --watch

Все после -- передается внутрь команды.

Что важно помнить

  • Скрипты запускают через npm run name; для start и test есть сокращения npm start и npm test.
  • Бинарники из node_modules/.bin доступны в скриптах без полного пути.
  • Аргументы передают после --: npm run test -- --watch.
  • Хуки pre и post (prebuild, postbuild) выполняются автоматически; npx запускает пакет без установки в проект.

Мини-шпаргалка

  • Scripts живут в package.json.
  • Запуск обычного script: npm run name.
  • npm test и npm start - короткие формы.
  • Локальные CLI из node_modules/.bin доступны в scripts.
  • В CI лучше запускать те же scripts, что и локально.

Документация

npm: scripts, npm: npm run.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам