如何创建一个npm包


概念

npmjs 上可供下载的项目,即是一个npm包。
一个npm包必须包含一个package.json文件。


一、作用

一个 npm 包可供不同的项目使用。遇到多个项目需要使用同一个功能(或同一个组件)的时候,无需复制粘贴,直接发布一个 npm 包,然后再添加该包到项目依赖中即可使用,大大的提高了代码质量与开发效率。

二、组成

npm 包可以是一个 node 工具,可以是一个 VueCli 插件,也可以是一个封装的组件。

三、如何发布一个npm包

  1. 注册npm账号
  2. 如果需要将包发布到私有仓库,请先使用nrm将源地址切换到私有仓库地址
  3. 终端中执行 npm login,按要求输入 Username、Password 以及 Email,登录 npm;
  4. 终端中进入要发布的包的根目录(package.json 所在目录),执行 npm publish,将包推送至远程 npm;
  5. 发布成功,该包已可供下载使用;

四、如何下载一个npm包

普通npm包

npm install '包名' [--registry '私有npm地址']
或
yarn add '包名' [--registry '私有npm地址']

VueCli插件

vue add '包名(插件名)' [--registry '私有npm地址']

总结

以上就是今天要讲的内容,本文仅简单介绍了如何从0开始创建一个npm包到npm包的下载使用

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
要将一个模块打npm 本地,可以按照以下步骤进行操作: 1. 在模块的根目录下创建一个 `package.json` 文件,其中含模块的名称、版本、描述等信息。可以使用 `npm init` 命令来自动生成这个文件,然后根据需要进行编辑。 2. 将模块的源代码和相关文件放在一个目录中,例如 `src` 目录。 3. 在模块的根目录下创建一个 `index.js` 文件,该文件是模块的入口文件,用于导出模块的功能。在这个文件中,可以使用 `module.exports` 语句来导出模块中的函数、变量等。例如: ```javascript module.exports = { greet: function(name) { console.log('Hello, ' + name + '!'); } }; ``` 4. (可选)如果模块依赖其他的模块,可以在 `package.json` 文件的 `dependencies` 字段中列出这些依赖项。例如: ```json { "name": "my-module", "version": "1.0.0", "description": "My awesome module", "dependencies": { "lodash": "^4.17.21" } } ``` 5. 在模块的根目录下执行以下命令将模块打一个本地压缩: ``` npm pack ``` 6. 执行完上述命令后,会在模块的根目录下生成一个类似于 `my-module-1.0.0.tgz` 的压缩。这个文件就是我们的 npm 本地了。 7. 要在本地项目中使用这个本地,可以使用以下命令进行安装: ``` npm install /path/to/my-module-1.0.0.tgz ``` 其中 `/path/to/my-module-1.0.0.tgz` 是本地的路径。安装完成后,就可以在项目中使用这个模块了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值