96 lines
1.6 KiB
Markdown
96 lines
1.6 KiB
Markdown
---
|
|
title: package.json
|
|
category: Node.js
|
|
prism_languages: [json]
|
|
updated: 2020-06-23
|
|
weight: -3
|
|
---
|
|
|
|
### Basic
|
|
|
|
```json
|
|
{
|
|
"name": "expo",
|
|
"description": "My package",
|
|
"version": "0.1.0",
|
|
"license": "MIT",
|
|
"keywords": ["http", "server"],
|
|
"author": "Rico Sta. Cruz <rstacruz@users.noreply.github.com>",
|
|
"engines": {
|
|
"node": ">=0.8.0"
|
|
},
|
|
"main": "index",
|
|
"bin": {
|
|
"command": "./bin/command"
|
|
},
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/rstacruz/___.git"
|
|
},
|
|
}
|
|
```
|
|
{: data-line="2,3,4,5"}
|
|
|
|
Highlighted lines are required.
|
|
|
|
### Dependencies
|
|
|
|
```json
|
|
"dependencies": {
|
|
"colors": "*",
|
|
"flatiron": "0.1.x",
|
|
"flatiron": "~0.1.0",
|
|
"plates": "https://github.com/user/project/tarball/branch",
|
|
"stuff": "git://github.com/user/project.git#commit-ish"
|
|
},
|
|
```
|
|
|
|
```json
|
|
"devDependencies": { ··· },
|
|
"peerDependencies": { ··· },
|
|
"optionalDependencies": { ··· },
|
|
```
|
|
|
|
See [Semver cheatsheet](./semver) for explanation of version ranges.
|
|
|
|
### Scripts
|
|
|
|
```json
|
|
"scripts": {
|
|
"start": "node ./bin/xxx", /* npm start */
|
|
"test": "vows --spec --isolate", /* npm test */
|
|
"postinstall": "...",
|
|
"prepublish": "grunt build", /* after 'npm install' and before 'npm
|
|
publish' */
|
|
}
|
|
```
|
|
|
|
### Misc
|
|
|
|
```json
|
|
"private": true,
|
|
"preferGlobal": true
|
|
```
|
|
|
|
### Config
|
|
|
|
```json
|
|
{
|
|
"config": {
|
|
"foobar": "hello"
|
|
},
|
|
"scripts": {
|
|
"run": "echo $npm_package_config_foobar"
|
|
}
|
|
}
|
|
```
|
|
|
|
Keys in `config` are exposed as env vars to scripts.
|
|
|
|
## References
|
|
{: .-one-column}
|
|
|
|
* <http://package.json.nodejitsu.com/>
|
|
* `npm help package.json`
|
|
{: .-also-see}
|