16. yarn init

Интерактивно создаёт или обновляет файл package.json.

yarn init

Эта команда проведет вас через интерактивный процесс создания файла package.json. Некоторые значения по умолчанию, такие как лицензия и начальная версия, берутся из настроек конфигурации yarn init-*.

Вот пример выполнения команды внутри каталога testdir.

$ yarn init

question name (testdir): my-awesome-package
question version (1.0.0):
question description: The best package you will ever find.
question entry point (index.js):
question git repository: https://github.com/yarnpkg/example-yarn-package
question author: Yarn Contributor
question license (MIT):
question private:
success Saved package.json
✨  Done in 87.70s.

Это приводит к следующему package.json:

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "description": "The best package you will ever find.",
  "main": "index.js",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "author": "Yarn Contributor",
  "license": "MIT"
}

По умолчанию, если ответ на question private пустой, ключ private не будет добавлен в package.json

Если у вас уже есть существующий файл package.json, то он будет использовать значения из файла в качестве значений по умолчанию.

Следующий существующий package.json:

{
  "name": "my-existing-package",
  "version": "0.1",
  "description": "I exist therefore I am.",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "license": "BSD-2-Clause"
}

Приводит к следующим значениям по умолчанию во время интерактивного процесса:

$ yarn init

question name (my-existing-package):
question version (0.1):
question description (I exist therefore I am.):
question entry point (index.js):
question git repository (https://github.com/yarnpkg/example-yarn-package):
question author: Yarn Contributor
question license (BSD-2-Clause):
question private:
success Saved package.json
✨  Done in 121.53s.

Установка значений по умолчанию для yarn init

Следующие переменные конфигурации config могут быть использованы для настройки значений по умолчанию для yarn init:

• init-author-name
• init-author-email
• init-author-url
• init-version
• init-license

yarn init --yes/-y

Эта команда пропускает интерактивный процесс, упомянутый выше, и генерирует файл package.json на основе ваших значений по умолчанию. Некоторые значения по умолчанию могут быть изменены, изменяя настройки конфигурации init-*, как описано выше. Например, при свежем установлении Yarn и внутри каталога yarn-example:

$ yarn init --yes

warning The yes flag has been set. This will automatically answer yes to all questions which may have security implications.
success Saved package.json
✨  Done in 0.09s.

Что приводит к следующему package.json:

{
  "name": "yarn-example",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT"
}

yarn init --private/-p

автоматически добавит private: true в package.json

$ yarn init --private

Если установлен флаг private, то ключ private автоматически будет установлен в true, и вы всё равно продолжите остальную часть процесса инициализации.

question name (testdir): my-awesome-package
question version (1.0.0):
question description: The best package you will ever find.
question entry point (index.js):
question git repository: https://github.com/yarnpkg/example-yarn-package
question author: Yarn Contributor
question license (MIT):
success Saved package.json
✨  Done in 87.70s.

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "description": "The best package you will ever find.",
  "main": "index.js",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "author": "Yarn Contributor",
  "license": "MIT",
  "private": true
}

Вы можете использовать флаги yes и private одновременно

Например так:

$ yarn init -yp

warning The yes flag has been set. This will automatically answer yes to all questions which may have security implications.
success Saved package.json
✨  Done in 0.05s.

Что приводит к следующему package.json:

{
  "name": "yarn-example",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "private": true
}