关于 node.js package.json的使用说明

先说结论

• package.json 主要存储项目所依赖包的信息。
• 代码托管，不需要上传 node_modules 文件夹，上传 package.json 即可
• 拉取代码后，在项目目录下执行 npm install 即可完成 node_modules 的安装

 

生成方法

打开命令窗口，进入到项目所在目录，使用初始化命令:

npm init

执行命令会，会提示，输入yes即可。

 

完整过程如下

D:\myCode\node.js> npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible def

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
npm ERR! code EINVALIDTAGNAME
npm ERR! Invalid tag name "配牌分析": Tags may not have any character
About to write to D:\myCode\node.js\单款功能\配牌分析\package.json:

{
  "name": "",
  "version": ""
}


Is this ok? (yes) yes
npm ERR! Callback called more than once.

npm ERR! A complete log of this run can be found in:
npm ERR!     D:\Program\_logs\2020-12-15T06_39_22_917Z-debug.log

命令执行完成后，目录下会创建出package.json文件。

内容如下：

{
  "name": "",
  "version": ""
}

 

安装依赖包

npm install readline

安装完成后，package.json内容发生了变化：

{
  "name": "",
  "version": "",
  "dependencies": {
    "readline": "^1.3.0"
  }
}

目录结构

node_modules目录下存放的是依赖包的文件。

 

重新安装node_modules依赖包

将node_modules文件夹删除，在项目目录下执行安装命令

npm install

命令执行完成后，目录下重新创建了 node_modules 文件夹，并且安装了 readline 依赖包。

 

结论

我们的node项目代码上传到代码托管服务时，不需要上传 node_modules 文件夹，只需要上传package.json即可（这也是github默认不上传node_modules文件夹的原因）。拉取代码后，只需要在项目目录下执行 npm install 命令即可。