yarn init

De forma interactiva crea o actualiza un archivo package.json.

yarn init

Este comando le guía a través de una sesión interactiva para crear un archivo package.json. Algunos valores predeterminados como la licencia y la versión inicial se encuentran en los ajustes de configuración init-* de Yarn.

Aquí está un ejemplo de ejecutar el comando dentro de un directorio llamado 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.

Esto se traduce en el siguiente 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"
}

Por defecto, si una respuesta data a una question privatees definida como vacía, la llave private será agregada a package.json

Si ya tiene un archivo package.json, entonces será utilizado para las entradas del archivo como valores por defecto.

Con el siguiente 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"
}

Esto resulta en los siguientes valores predeterminados durante la sesión interactiva:

$ 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.
Valores predeterminados de configuración de yarn init

Las siguientes valores de configuración se pueden utilizar para personalizar los valores predeterminados de yarn init:

  • init-author-name
  • init-author-email
  • init-author-url
  • init-version
  • init-license
yarn init --yes/-y

Este comando omite la sesión interactiva antes mencionada y genera un package.json basado en sus valores predeterminados. Algunos valores predeterminados pueden modificarse cambiando los valores de configuración init-* como se menciona arriba. Por ejemplo, dada una instalación nueva de Yarn y dentro de un directorio 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.

Esto produce el siguiente package.json:

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

automaticamente agrega private: true al package.json

$ yarn init --private

If the private flag is set, the private key will be automatically set to true and you still complete the rest of the init process.

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
}

Puede usar tanto los marcadores yes como private al mismo tiempo

Como esto:

$ 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.

Esto produce el siguiente package.json:

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