关于项目中的package.json的介绍

简介: 关于项目中的package.json的介绍

package.json


每一个项目都要有一个package.json文件(包描述文件,就像产品的说明书一样)

这个文件可以通过npm init自动初始化出来


D:\code\node中的模块系统>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 defaults.
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.
package name: (node中的模块系统)
Sorry, name can only contain URL-friendly characters.
package name: (node中的模块系统) cls
version: (1.0.0)
description: 这是一个测试项目
entry point: (main.js)
test command:
git repository:
keywords:
author: xiaochen
license: (ISC)
About to write to D:\code\node中的模块系统\package.json:
{
  "name": "cls",
  "version": "1.0.0",
  "description": "这是一个测试项目",
  "main": "main.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "xiaochen",
  "license": "ISC"
}
Is this OK? (yes) yes


对于目前来讲,最有用的是dependencies选项,可以用来帮助我们保存第三方包的依赖信息。

如果node_modules删除了也不用担心,只需要在控制面板中npm install就会自动把package.json中的dependencies中所有的依赖项全部都下载回来。

  • 建议每个项目的根目录下都有一个package.json文件
  • 建议执行npm install 包名的时候都加上--save选项,目的是用来保存依赖信息

package.json和package-lock.json


npm 5以前是不会有package-lock.json这个文件

npm5以后才加入这个文件

当你安装包的时候,npm都会生成或者更新package-lock.json这个文件

  • npm5以后的版本安装都不要加--save参数,它会自动保存依赖信息
  • 当你安装包的时候,会自动创建或者更新package-lock.json文件
  • package-lock.json这个文件会包含node_modules中所有包的信息(版本,下载地址。。。)
  • 这样的话重新npm install的时候速度就可以提升
  • 从文件来看,有一个lock称之为锁
  • 这个lock使用来锁版本的
  • 如果项目依赖了1.1.1版本
  • 如果你重新install其实会下载最细版本,而不是1.1.1
  • package-lock.json的另外一个作用就是锁定版本号,防止自动升级

总结和思考


package.json 是一个用于描述 Node.js 模块的元数据文件,它位于模块的根目录下。它包含了模块的名称、版本、作者、依赖等信息,以及一些脚本命令。

以下是 package.json 中的常用字段:

  • name:模块的名称,必须是唯一的。
  • version:模块的版本号。
  • description:模块的描述信息。
  • main:指定模块入口文件的路径。
  • keywords:一组关键词,用于搜索和分类。
  • repository:存放代码的仓库信息。
  • author:模块作者的信息。
  • license:模块的许可证信息。
  • dependencies:指定依赖的其他模块,使用版本号进行控制。
  • devDependencies:开发依赖的其他模块,只在开发时需要使用。
  • scripts:定义一些脚本命令,例如测试、构建、运行等。

在使用 npm 或者 yarn 管理 Node.js 模块时,package.json 扮演了重要的角色。在项目根目录下执行 npm install 或者 yarn install 命令会根据 package.json 文件中的 dependenciesdevDependencies 字段安装依赖的模块。

总之,package.json 是 Node.js 模块的重要元数据文件,通过它可以方便地管理模块的依赖关系、版本信息等。开发者可以根据实际情况对其中的各个字段进行配置。

目录
相关文章
|
7月前
|
JavaScript
Vue 项目使用 json-editor (二)
Vue 项目使用 json-editor (二)
348 0
|
XML JSON JavaScript
【前端】Vue项目中 JSON 编辑器的使用
【前端】Vue项目中 JSON 编辑器的使用
2696 0
|
4月前
|
XML JSON Java
使用IDEA+Maven搭建整合一个Struts2+Spring4+Hibernate4项目,混合使用传统Xml与@注解,返回JSP视图或JSON数据,快来给你的SSH老项目翻新一下吧
本文介绍了如何使用IntelliJ IDEA和Maven搭建一个整合了Struts2、Spring4、Hibernate4的J2EE项目,并配置了项目目录结构、web.xml、welcome.jsp以及多个JSP页面,用于刷新和学习传统的SSH框架。
131 0
使用IDEA+Maven搭建整合一个Struts2+Spring4+Hibernate4项目,混合使用传统Xml与@注解,返回JSP视图或JSON数据,快来给你的SSH老项目翻新一下吧
|
4月前
|
JSON JavaScript 前端开发
Vue项目使用Cookie,以Json格式存入与读取Cookie,设置过期时间以及删除操作
这篇文章介绍了在Vue项目中如何使用JavaScript操作Cookie,包括设置、读取、设置过期时间以及删除Cookie的方法。
312 0
|
5月前
|
JavaScript
vue项目中package.json的个人见解
总的来说,package.json文件是Vue项目的心脏,它记录了项目运行所需的所有信息,是项目能够顺利运行和维护的关键。
94 0
|
7月前
|
前端开发
【专栏】在前端开发中,package.json 文件是项目的重要配置文件,其中包含了许多与项目相关的信息和设置
【4月更文挑战第29天】`package.json`的`proxy`字段用于配置开发环境中的代理服务器,解决跨域问题并模拟后端响应。它是字符串类型,值为代理服务器地址。主要应用场景包括前端跨域请求和本地调试。配置时在`package.json`顶层添加`proxy`字段,如`"proxy": "http://localhost:8080"`。该配置仅在开发环境中生效,生产环境需另寻解决方案。
108 1
|
JSON 资源调度 运维
vue vite启动项目报错ERROR: Unexpected “\x88“ in JSON 原因
vue vite启动项目报错ERROR: Unexpected “\x88“ in JSON 原因
710 0
vue vite启动项目报错ERROR: Unexpected “\x88“ in JSON 原因
|
JSON JavaScript 数据格式
vue2.0 + element-ui 实战项目-使用本地的json模拟数据(七)
vue2.0 + element-ui 实战项目-使用本地的json模拟数据(七)
215 0
|
人工智能 自然语言处理 小程序
微信小程序打开项目提示读取project.config.json文件失败
微信小程序打开项目提示读取project.config.json文件失败
141 0
|
Unix Windows
🎖️使用 `package.json` 中的脚本钩子来优化项目工作流程
这些脚本钩子可以使项目的开发、构建和部署过程更加高效和自动化。
234 1