Files

53 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2018-10-25 20:29:56 +02:00
---
id: 587d7fb3367417b2b2512bfc
title: Add a Description to Your package.json
challengeType: 2
forumTopicId: 301522
dashedName: add-a-description-to-your-package-json
2018-10-25 20:29:56 +02:00
---
# --description--
The next part of a good package.json file is the `description` field; where a short, but informative description about your project belongs.
2019-03-03 12:30:44 -06:00
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, thats not the only use case for the description, its a great way to summarize what a project does. Its just as important in any Node.js project to help other developers, future maintainers or even your future self understand the project quickly.
2019-03-03 12:30:44 -06:00
Regardless of what you plan for your project, a description is definitely recommended. Here's an example:
```json
"description": "A project that does something awesome",
```
# --instructions--
2018-10-25 20:29:56 +02:00
Add a `description` to the package.json file of your project.
2018-10-25 20:29:56 +02:00
**Note:** Remember to use double-quotes for field-names (") and commas (,) to separate fields.
2018-10-25 20:29:56 +02:00
# --hints--
2018-10-25 20:29:56 +02:00
package.json should have a valid "description" key
2018-10-25 20:29:56 +02:00
```js
(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);
}
);
```
2018-10-25 20:29:56 +02:00
# --solutions--
2018-10-25 20:29:56 +02:00
```js
/**
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.
*/
2018-10-25 20:29:56 +02:00
```