ee1e8abd87
* feat(tools): add seed/solution restore script * chore(curriculum): remove empty sections' markers * chore(curriculum): add seed + solution to Chinese * chore: remove old formatter * fix: update getChallenges parse translated challenges separately, without reference to the source * chore(curriculum): add dashedName to English * chore(curriculum): add dashedName to Chinese * refactor: remove unused challenge property 'name' * fix: relax dashedName requirement * fix: stray tag Remove stray `pre` tag from challenge file. Signed-off-by: nhcarrigan <nhcarrigan@gmail.com> Co-authored-by: nhcarrigan <nhcarrigan@gmail.com>
53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
---
|
||
id: 587d7fb3367417b2b2512bfc
|
||
title: Add a Description to Your package.json
|
||
challengeType: 2
|
||
forumTopicId: 301522
|
||
dashedName: add-a-description-to-your-package-json
|
||
---
|
||
|
||
# --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:
|
||
|
||
```json
|
||
"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.
|
||
|
||
# --hints--
|
||
|
||
package.json should have a valid "description" key
|
||
|
||
```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);
|
||
}
|
||
);
|
||
```
|
||
|
||
# --solutions--
|
||
|
||
```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.
|
||
*/
|
||
```
|