☰

package.json - Node.js

package.json - файл конфігурації проекту в Node.js у форматі JSON.

Створення файлу package.json

Створити файл package.json можна самостійно або за допомогою NPM.

Створення файлу вручну

Створюємо каталог проекту для Node.js.

Створюємо новий файл з назвою "package.json" у каталозі проекту і у текстовому редакторі прописуємо параметри згідно структури файли (структура файлу описана нижче).

Створення файлу за допомогою NPM

У файловому менеджері відкриваємо термінал у каталозі проекту або у терміналі за допомогою команди cd переходимо в каталог проекту.

У терміналі вводимо команду:

npm init

та вказуємо ряд параметрів: назву проекту, опис, версію, назву автора, ліцензію, репозиторій і т.п.

Структура файлу package.json

Файл package.json представляє собою звичайний файл формату JSON з параметрами проекту Node.js. Приклад вмісту файлу:

{ "name": "test", "version": "1.0.0", "description": "Тест Node.js", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [ "test" ], "author": "яваскрипт.укр", "license": "ISC" }
    Параметри проекту:
  • name - рядок який містить назва проекту (програми) "name": "test"
  • version - версія проекту "version": "1.0.0"
  • description - опис проекту "description": "Тест project Node.js"
  • keywords - ключові слова проекту "keywords": [ "test", "node.js", "npm", "javascript" ]
  • author - автор проекту "author": "Ivan <email@ukr.net> (http://яваскрипт.укр)" "author": { "name": "Ivan", "email": "email@ukr.net", "url": "http://яваскрипт.укр" }
  • contributors - список людей які беруть участь у проекті "contributors": [ "Ivan <email@ukr.net> (http://яваскрипт.укр)", "User <email2@ukr.net> (http://яваскрипт.укр)" ] "contributors": [ { "name": "Ivan", "email": "email@ukr.net.com", "url": "http://яваскрипт.укр" }, { "name": "User", "email": "email2@ukr.net.com", "url": "http://яваскрипт.укр" } ]
  • main - головний файл проекту з якого починається виконання "main": "index.js"
  • private - логічне значення true або false. Чи є проект приватний.
  • scripts - об'єкт в якому вказана Node.js скрипти які можна виконувати.
  • dependencies - npm пакети від яких залежить проект.
  • devDependencies - npm пакети які використовуються при розробці проект але не використовуються при реальній роботі проекту.
  • engines - вказує версії Node.js i NPM при яких проект може працювати. "engines": { "node": ">= 6.0.0", "npm": ">= 3.0.0" },
  • homepage - URL адреса проекту "homepage": "http://яваскрипт.укр"
  • license - за якою ліцензією розповсюджується проект "license": "MIT"
  • repository - вказує де знаходиться репозиторій проекту "repository": "github:ivan-JS-UK/ImageToHTML" "repository": { "type": "git", "url": "https://github.com/ivan-JS-UK/ImageToHTML.git" }