freeCodeCamp

1.6 KiB

Raw Blame History

id	title	challengeType	forumTopicId
587d7fb3367417b2b2512bfc	Add a Description to Your package.json	2	301522

Description

The next part of a good package.json file is the description field; where a short, but informative description about your project belongs. If you some day plan to publish a package to npm, this is the string that should sell your idea to the user when they decide whether to install your package or not. However, that’s not the only use case for the description, it’s a great way to summarize what a project does. It’s just as important in any Node.js project to help other developers, future maintainers or even your future self understand the project quickly. Regardless of what you plan for your project, a description is definitely recommended. Here's an example:

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

Instructions

Add a description to the package.json file of your project. Note: Remember to use double-quotes for field-names (") and commas (,) to separate fields.

Tests

tests:
  - text: package.json should have a valid "description" key
    testString: '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); })'

Challenge Seed

Solution

// solution required

1.6 KiB Raw Blame History Unescape Escape