在 NPM(节点包管理器)上发布我们自己的包是与社区共享、学习代码或促进在我们自己的项目中重用的好方法。在本指南中,我们将逐步学习如何在 NPM 中创建、配置和发布我们的第一个包。
NPM 包是一个 JavaScript 模块,您可以在 Node.js 项目中安装和使用它。它可以像可重用函数一样简单,也可以像整个库一样复杂。
开始之前,我们必须确保满足以下要求:
已安装 Node.js 和 NPM:从 Node.js 下载并安装。
NPM 帐户:在 npmjs.com 注册。
代码编辑器:像 VS Code 一样,编写和组织您的项目。
第 1 步:为您的包创建一个文件夹
打开终端并创建一个文件夹:
mkdir mi-primer-paquete cd mi-primer-paquete
我们在代码编辑器中打开文件夹:
代码.
第 2 步:初始化项目
我们运行以下命令来创建 package.json 文件:
npm 初始化
回答问题或使用 npm init -y 接受默认值。
检查生成的package.json文件。它应该看起来像这样:
{ "name": "mi-primer-paquete", "version": "1.0.0", "description": "Mi primer paquete publicado en NPM", "main": "index.js", "scripts": {}, "keywords": ["npm", "paquete", "tutorial"], "author": "Tu Nombre", "license": "MIT" }
第 3 步:创建主文件
在项目根目录中创建一个名为index.js的文件:
触摸index.js
添加一个简单的函数作为示例:
function holaMundo() { return "¡Hola, mundo!"; } module.exports = holaMundo;
第1步:登录NPM
在终端中运行以下命令并按照说明登录:
npm 登录
第 2 步:发布包
运行此命令将您的包发布到 NPM:
npm 发布
准备好!现在您的包将在 NPM 上公开可用。
为了确保您的包正常工作,请通过将其安装在另一个项目中来测试它:
为测试创建一个新文件夹:
mkdir prueba-paquete cd prueba-paquete
初始化一个项目,然后安装包:
npm init -y npm install mi-primer-paquete
在文件中使用包:
const holaMundo = require("mi-primer-paquete"); console.log(holaMundo()); // ¡Hola, mundo!
如果我们需要进行更改,只需更新代码,增加 package.json 中的版本(例如将“version”:“1.0.0”更改为“version”:“1.0.1”)并重新发布:
npm 发布
以上是如何创建您的第一个包并将其发布到 NPM 中的详细内容。更多信息请关注PHP中文网其他相关文章!