npm自定义包的规范及package.json字段解析

最新推荐文章于 2024-06-11 16:51:55 发布
最新推荐文章于 2024-06-11 16:51:55 发布
阅读量1.7k 收藏
点赞数 2
分类专栏： Node.js 文章标签： node.js 自定义包 package.json npm
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43234831/article/details/91054103
版权

自定义包

包的规范

  • package.json 必须在包的顶层目录下
  • 二进制文件应该在 bin 目录下
  • JavaScript 代码应该在lib目录下
  • 文档应该在 doc 目录下
  • 单元测试应该在 test 目录下

package.json 字段分析

  • name：包的名称，必须是唯一的，由小写英文字母、数字和下划线组成，不能包含空格
  • description：包的简要说明
  • version：符合语义化版本识别规范的版本字符串
  • keywords：关键字数组，通常用于搜索
  • maintainers：维护者数组，每个元素要包含 name、email（可选）、web（可选）字段
  • contributors：贡献者数组，格式与 maintainers 相同。包的作者应该是贡献者数组的第一个元素
  • bugs：提交 bug 的地址，可以是网站或者电子邮件地址
  • licenses：许可证数组，每个元素要包含 type（许可证名称）和 url（链接到许可证文本的地址）字段
  • repositories：仓库托管地址数组，每个元素要包含 type（仓库类型，如git）、url（仓库的地址）和 path（相对于仓库的路径，可选）字段
  • dependencies：生产环境包的依赖，一个关联数组，由包的名称和版本号组成
  • devDependencies：开发环境包的依赖，一个关联数组，由包的名称和版本号组成
长岛冰茶。
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Node.js-npm-name-检查一个包名在npm中是否可用
08-10
npm-name - 检查一个包名在npm中是否可用
Package.json 属性说明
weixin_30783913的博客
08-29 87
name- 包名。 version- 包的版本号。 description- 包的描述。 homepage- 包的官网 url 。 author- 包的作者姓名。 contributors- 包的其他贡献者姓名。 dependencies- 依赖包列表。如果依赖包没有安装，npm 会自动将依赖包安装在 node_mo...
发布自定义 npm 组件包
最新发布
weixin_46306370的博客
06-11 1671
注意这里 name 要唯一，不能和已发布的包重名，你可以到官网（https://www.npmjs.com/）搜索是否已经有同名的包存在。把组件提到src平级的文件夹中packages中，并且创建一个index.ts文件（通过index.ts 统一管理发布的组件）在dist目录下初始化创建 package.json 包的配置信息。main：包的入口文件，默认根目录的 index.js。version：版本号，以后更新也要用到。description：包的描述性文字。还有其它配置信息就不一一介绍了。
【源码阅读 | 02】validate-npm-package-name 校验包名是否规范
weixin_42678675的博客
12-08 909
1. 场景   在使用如脚手架 创建项目 的时候，为了 规范包名，会对包名进行校验，此时就用到了题目中的 validate-npm-package-name 包。 2. 使用 打开 cmd，创建 vue 项目试一下（以 @vue/cli 4.5.9 为例） 1）使用 保留字 作为项目名 2）使用 _ 下划线作为开头 3）使用 大写字母 作为项目名 细心的人可能会发现，报错信息中，有的是 Error，有的是 Warning，区别在于： Warning ：用于表示过去 package name 允许，
对于自定以封装npm的package的文件下的详细讲解
小菜鸟的博客
04-12 309
对于自定以封装npm的package的文件下的详细讲解 脚本"scripts"的具体讲解查看脚本执行 读取package的自定义属性 node后面接的是我的脚本运行路径 通过process.env实现继承 加上npm_package_前缀读取下面的属性，这是固定写法 process.env.npm_package_config_a 结果： 下载git上面的包 npm i git+ssh://+ssh链接就可以直接拉取 或者npm i+https中的链接 下面说一个重点(cross-en
package.json 字段配置
weixin_43294560的博客
02-28 739
当 main 和 module 都不存在时 ，会去查找项目的index.js入口文件。通过webpack自定义查找规则。配合webpack使用。约定包中导出的路径，
nodejs中用npm初始化来创建package.json的实例讲解
10-17
此外，`package.json`文件中的`scripts`字段允许你定义自定义的npm命令，例如： ```json "scripts": { "start": "node index.js", "build": "webpack --config webpack.config.js" } ``` 这样，你可以通过`npm ...
clean-publish：在发布到npm之前删除package.json中的配置文件和字段
02-03
Clean Publish是一个工具，用于在发布到npm之前从package.json删除要开发的配置文件，字段和脚本。 目录 这个怎么运作 clean-publish命令将项目文件（不包括配置文件）复制到一个临时文件夹，从package.json删除...
package.json：文件package.json的说明文档
02-03
- **npm**: 作为Node.js的标准包管理器，负责安装、卸载、更新项目依赖，并管理`package.json`文件。通过`npm install`命令，可以根据`dependencies`和`devDependencies`安装对应的模块。 - **yarn**: 是Facebook...
nodejs npm package.json中文文档
10-25
npm（Node Package Manager）是 Node.js 的包管理器，它允许开发者轻松地安装、共享和管理代码库。npm 提供了一个命令行工具，用于安装、卸载、更新和发布软件包。每个软件包通常由一个 `package.json` 文件定义，这...
package.json中homepage属性的作用详解
11-20
Package.json 属性说明 name – 包名。 version – 包的版本号。 description – 包的描述。 homepage – 包的官网 url 。 author – 包的作者姓名。 contributors – 包的其他贡献者姓名。 dependencies – ...
package.json详解
hourong88的专栏
09-25 215
引言 前端需要学习的东西真的挺多的，之前主要从事的是MVC框架，操作DOM，使用JQUERY比较多，不知到什么时候，发现现在前端MVVM是主流，不得不把之前的大部分东西丢掉，作为前端婴儿不断前行。 所以以后的文章，可能开始都比较基础，希望大拿不要见笑，若有不对的地方，希望指正，我也会不断修正迭代。 在学习MVVM（react和vue）的时候，开始就是会找iview，element，ant-p...
package.json字段全解
居无常
12-09 533
http://blog.csdn.net/woxueliuyun/article/details/39294375
关于package.json文件的属性（前端的笔记一）
Jsaaon的博客
08-31 225
关于package.json文件里的属性，用一张图标为例子 name项目名称 version项目的版本号 description项目描述，可以用作npm官网搜索 keywords项目关键字，可以用作npm官网搜索 homepage项目官网地址 bugs提交项目bug的方式 license项目license类型 author项目作者 contributors贡献者 可以有多个 maintainers维护者 files当别人安装你的包时候，所需要安装的其他文件 main入口文件 browser和main相同，但
创建发布npm包
汉堡请不要欺负面条
09-26 282
什么是npm? npm网站地址 npm是javascript的包管理工具，是前端模块化下的一个标志性产物 简单地地说，就是通过npm下载模块，复用已有的代码，提高工作效率 1.从社区的角度：把针对某一特定问题的模块发布到npm的服务器上，供社区里的其他人下载和使用，同时自己也可以在社区里寻找特定的模块的资源，解决问题 2.从团队的角度：有了npm这个包管理工具，复用团队既有的代码也变的更加地方便 创建npm库 在npmjs上注册一个自己的账号。 在本地创建项目 在执行npm init之前，有两点需要我们注
package.json文件添加自定义命令和参数
摸鱼小队
07-08 4370
1、安装 cross-env 目的：为了能正常配置自定义参数。 例如 ：test1=xixixi ，前面要加上 cross-env。 2、安装 nodemon 目的：自动完成node服务器和数据库服务器的重启，比如mock数据请求package.json 文件 test.js 二、解析： 1、执行自定义命令 test1 ，既 ，相当于执行了 test.js 这个文件，并进行参数的打印。 （1）test1 自定义命令定义了两个参数和；且命令指向了 test.js 文件。（2）自定义的参数可以再任何一个vu
【前端知识】npm包的版本规范
Outman's blog
01-17 781
【前端知识】npm包的版本规范
VScode 插件中 package.json 文件字段详解
guoqkmiss的博客
07-02 1819
一、package.json文件内容 { // 插件的名字，应全部小写，不能有空格； string "name": "my-vscode-plugin", // 版本号； string "version": "1.0.0", // 发布插件的人的名字 string "publisher": "Bob", // 插件支持的最低 VScode版本，不能是 *； Object "engines": { "vscode": "^1.0.0" }, // 许可证，和 npm licens
一个npm包里的package.json具备的必要字段都有哪些
03-28
1. name： 包名 2. version： 版本号 3. description： 包的描述 4. main： 包的主入口文件 5. keywords： 关键词，用于搜索 6. author： 作者信息 7. license： 许可证信息 8. dependencies： 依赖项，包所依赖的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值