Files

1.7 KiB

id, title, challengeType, forumTopicId, dashedName
id title challengeType forumTopicId dashedName
587d7fb3367417b2b2512bfc Agrega una descripción a tu package.json 2 301522 add-a-description-to-your-package-json

--description--

La siguiente parte de un buen archivo package.json es el campo description; donde pertenece una descripción corta, pero informativa de tu proyecto.

Si algún día planeas publicar un paquete a npm, esta es la cadena que debería vender su idea al usuario cuando decida si instalar o no el paquete. Sin embargo, ese no es el único caso de uso para la descripción, es una buena manera de resumir lo que hace un proyecto. Es igual de importante en cualquier proyecto Node.js para ayudar a otros desarrolladores, futuros mantenedores o incluso a tu yo del futuro a entender el proyecto rápidamente.

Independientemente de lo que planees para tu proyecto, definitivamente se recomienda una descripción. He aquí un ejemplo:

"description": "A project that does something awesome",

--instructions--

Añade una description al archivo package.json de tu proyecto.

Nota: Recuerda usar comillas dobles para nombres de campos (") y comas (,) para separar campos.

--hints--

el archivo package.json debe tener una clave de "description" válida

(getUserInput) =>
  $.get(getUserInput('url') + '/_api/package.json').then(
    (data) => {
      var packJson = JSON.parse(data);
      assert(packJson.description, '"description" is missing');
    },
    (xhr) => {
      throw new Error(xhr.responseText);
    }
  );

--solutions--

/**
  Backend challenges don't need solutions, 
  because they would need to be tested against a full working project. 
  Please check our contributing guidelines to learn more.
*/