如何在几分钟内发布你的第一个npm包！

如何发布 NPM 包：本地发布和使用 GitHub Actions 自动化

什么是 NPM？

NPM（Node.js 包管理器）是一个软件包管理器，用于在 Node.js 项目中安装、管理和共享代码。如果你想发布自己的代码供他人使用，那么创建 NPM 包至关重要。

本地发布 NPM 包

步骤 1：初始化 NPM 项目

使用命令 npm init -y 初始化 NPM 项目并创建一个 package.json 文件。

步骤 2：创建 package.json 文件

这是一个 JSON 文件，包含有关包的信息，例如名称、版本和依赖项。以下是一个示例：

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "description": "这是一个令人惊叹的 NPM 包",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["npm", "package", "javascript"],
  "author": "你的名字",
  "license": "ISC"
}

步骤 3：创建 index.js 文件

这是包的主要文件，包含要发布的代码。以下是一个示例函数：

function myFunction() {
  console.log("Hello, world!");
}

module.exports = myFunction;

步骤 4：安装依赖项

使用命令 npm install 安装所需的依赖项。

步骤 5：发布包

使用命令 npm publish 发布包到 NPM 注册表。

使用 GitHub Actions 自动化 NPM 包发布

步骤 1：创建 GitHub Action

创建一个 GitHub Action 工作流，用于在代码推送到主分支时自动发布包。以下是一个示例工作流：

name: Publish npm package

on:
  push:
    branches:
      - master

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '16'
      - run: npm ci
      - run: npm publish

步骤 2：启用 GitHub Action

将工作流添加到项目存储库中，然后推送更改。这将启用 GitHub Action，并在每次推送代码到主分支时自动发布包。

总结

本文介绍了如何本地发布 NPM 包以及如何使用 GitHub Actions 自动化该过程。通过这些步骤，你可以轻松地将你的代码分享给世界，并简化你的发布工作流程。

常见问题解答

1. 如何确保我的包名称可用？
   在发布包之前，使用命令 npm search package-name 检查包名称是否可用。

2. 发布包需要付费吗？
   不，发布 NPM 包是免费的。

3. 如何更新已发布的包？
   对 package.json 文件进行更改，然后使用相同的 npm publish 命令更新包。

4. 如何在本地测试包？
   使用命令 npm link 将包链接到本地项目，然后就可以在项目中使用它了。

5. 有哪些最佳实践可以遵循以编写高质量的 NPM 包？

   • 保持包简洁、模块化和可重用。
   • 使用有意义的名称和。
   • 提供明确的文档和示例。
   • 定期更新包并解决错误。