如何把 JavaScript 方法打包成 NPM 包供其他项目使用

255 阅读1分钟

一、创建项目文件夹并初始化

  • 创建一个新文件夹,比如 my-npm-package 。

  • 进入该文件夹,在终端或命令提示符中输入:npm init

  • 按照提示输入项目的名称(比如:my-utils)、版本(比如:1.0.0)、描述等信息。

二、编写代码

在该文件夹中创建 index.js 文件,代码如下:

function sum(a, b) {
  return a + b;
}

module.exports = {
  sum
};

三、配置 package.json

打开生成的 package.json 文件,添加以下配置:

{
  "name": "my-utils",
  "version": "1.0.0",
  "description": "A simple utility package",
  "main": "index.js",
  "keywords": [
    "javascript",
    "utils",
    "sum"
  ],
  "license": "MIT"
}

四、登录 NPM 账号并发布

  1. 如果还没有 NPM 账号,先去注册

  2. 在终端中执行以下命令登录:npm login

  3. 输入用户名、密码和邮箱进行登录。登录成功后,执行以下命令发布包:npm publish

五、在其他项目中使用

  1. 在其他项目中,先创建一个新的项目文件夹,进入该文件夹后在终端中执行: npm install my-utils

  2. 然后在项目代码中:

    const myUtils = require('my-utils');
    
    console.log(myUtils.sum(2, 3));