Usually when we use the npm init command to create an npm program, a package.jsonfile is automatically generated. package.jsonThe file will describe all relevant information of the NPM package, including author, introduction, package dependencies, build and other information, in strict JSON format.
package.json file configuration instructions official website
- name: required, the name, the length must be less than or equal to 214 characters, cannot start with "." (dot) or "_" (underscore), and cannot contain uppercase letters.
- version: required, version. XYZ → [major, minor, patch] → [main version, minor version, patch version]
。such as: 1.2.3 - description: Item description, which is a string. Helps people find this package when using npm search.
- keywords: project keywords, which is an array of strings. Helps people find this package when using npm search.
- homepage: The url of the project home page .
- bugs: Bug submission address.
- license: A software license that lets users know their usage rights and restrictions.
- author: The project developer.
- contributors: project contributors.
- files: An array of filenames contained by the project.
- main: The default execution file of the project, such as require('webpack'); the webpack.js file in the lib directory will be loaded by default, if not set, the index.js file in the project and directory will be loaded by default.
- bin: The path of the executable file corresponding to the internal command.
- man: Provide help documentation for the system's man command. The filename of the help file must end with a number, or .gz if it is compressed.
- directories: The directory structure information required by the CommonJS package, showing the directory structure information of the project. Fields can be: lib, bin, man, doc, example. The values are all strings.
- repository: project warehouse address.
- scripts: By setting this, NPM can call some command scripts and encapsulate some functions.
- config: Add some settings, which can be read by scripts, and the values here will also be added to the environment variables of the system.
- dependencies: In the production environment, the packages that the project depends on to run. Use the following command to install: npm install --save packageName.
- devDependencies: Dependency packages that are only required in the development environment. Use the following command to install: npm install --save-dev packageName.
- peerDependencies: related dependencies, if your package is a plug-in, and users usually need these dependencies (plug-ins) when using your package, you can list the dependencies here.
- bundledDependencies : Bundled dependency packages, these bundled packages will also be released together when released.
- optionalDependencies: Even if these dependencies are not available, they can be installed and used normally.
- engines: Specifies the environment in which the package runs.
- os: Specifies which system platforms your package can run on.
- cpu: You can specify the cpu architecture on which the package runs.
- private: If
truethis package is set, it will not be published to the NPM platform. - publishConfig: This field is used to set some settings when publishing. This is especially handy if you wish to set specific
tagorregistry.
as follows:
{
"name": "usercenter",
"version": "1.0.0",
"description": "manage usercenter",
"keywords": ["angular","es6"],
"homepage": "https://github.com/***",
"bugs": {
"url": "https://github.com/***",
"email": "[email protected]"
},
"license": "ISC",
"author": "xjx",
"main": "src/index.html",
"repository": {
"type": "git",
"url": "git clone [email protected]:usercenter.git ~/git/usercenter"
},
"scripts": {
"init": "npm install",
"install": "bower install",
"start": "node src/server/app.js",
"build": "gulp build"
},
"dependencies": {
"body-parser": "^1.19.0",
"express": "^4.17.1",
"morgan": "^1.10.0",
"serve-favicon": "^2.5.0"
},
"devDependencies": {
"babel-core": "^6.26.3",
"babel-preset-env": "^1.7.0",
"chalk": "^4.1.2",
"gulp": "^4.0.2",
}
}