冷冷的火花

外观

如何发布一个 NPM 包 ​

这是一个关于如何发布一个 NPM 包的笔记。以下是详细的步骤：

1. 设置 NPM 账户 ​

首先，需要在 npmjs.com 创建一个账户。如果已经有账户，则可以跳过这个步骤。

2. 创建包 ​

在本地环境中创建一个新的文件夹来存放包文件。例如，创建一个名为 my-npm-package 的文件夹。

bash
mkdir my-npm-package
cd my-npm-package
mkdir my-npm-package
cd my-npm-package

然后，运行 npm init 来初始化包。这会创建一个 package.json 文件，其中包含包的所有信息。

bash
npm init
npm init

按照提示填写相关信息，或者直接使用 npm init -y 来使用默认设置。

3. 编写代码 ​

在包文件夹中创建一个新的文件，例如 index.js，并在其中编写代码。

4. 指定入口点 ​

在 package.json 文件中的 main 字段指向入口文件（通常是 index.js）。

json
{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}
{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

5. 发布包 ​

在终端中，确保已经在包文件夹中，然后运行以下命令来发布包：

bash
npm login
npm publish
npm login
npm publish

首先，需要使用 npm login 命令来登录 NPM 账户。然后，可以使用 npm publish 命令来发布包。

6. 在 GitHub 上链接包 ​

在 package.json 文件中，可以添加一个 repository 字段来链接 GitHub 仓库。

json
{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/username/repository.git"
  },
  "author": "",
  "license": "ISC"
}
{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/username/repository.git"
  },
  "author": "",
  "license": "ISC"
}

以上就是发布一个 NPM 包的基本步骤。