如何安装 Node.js 和 npm？

在 JavaScript 生态中，npm（Node Package Manager）是共享代码的核心工具，通过创建自定义 npm 包命令，开发者能封装复杂操作，提升团队效率，本文将详细讲解从开发到发布 npm 包命令的全流程,涵盖最佳实践和关键注意事项。

• 访问 Node.js 官网 下载 LTS 版本（含 npm）。
• 验证安装：

  node -v  # 检查 Node.js 版本
  npm -v   # 检查 npm 版本

2. 注册 npm 账户
   • 在 npm 官网 注册账户。
   • 终端登录：

     npm login  # 输入用户名、密码及邮箱

创建 npm 包

步骤 1：初始化项目

mkdir my-cli-tool && cd my-cli-tool  # 创建项目目录
npm init -y  # 生成 package.json

步骤 2：编写核心代码

1. 创建入口文件：

   mkdir src && touch src/index.js

2. 在 index.js 中实现命令逻辑：

   #!/usr/bin/env node
   console.log("Hello from my CLI!"); // 示例命令

步骤 3：配置命令入口

在 package.json 中添加 bin 字段：

{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "bin": {
    "my-command": "./src/index.js"  // 用户将通过 `my-command` 执行
  }
}

本地测试命令

1. 模拟全局安装
   在项目根目录运行：

   npm link  # 创建全局软链接

2. 测试命令

   my-command  # 输出 "Hello from my CLI!"

发布到 npm 仓库

1. 更新版本号（遵循语义化版本）

   npm version patch  # 自动升级版本号（1.0.0 → 1.0.1）

2. 发布

   npm publish --access public  # 公开包

   首次发布需验证邮箱（npm 会发送确认邮件）。

用户安装与使用

1. 全局安装（推荐）

   npm install -g my-cli-tool

2. 运行命令

   my-command  # 输出预设内容

高级实践

处理命令行参数

使用 commander 库增强功能：

npm install commander

示例代码：

const { program } = require('commander');
program
  .version('1.0.0')
  .option('-n, --name <string>', '输入用户名')
  .parse(process.argv);
console.log(`Hello, ${program.opts().name || 'World'}!`);

添加单元测试

使用 jest 或 mocha：

npm install --save-dev jest

创建测试文件 src/index.test.js：

test('输出欢迎信息', () => {
  expect(require('./index')()).toContain('Hello');
});

持续集成（CI）

配置 GitHub Actions（.github/workflows/publish.yml）：

name: Publish
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test  # 运行测试
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}  # npm 令牌需存于仓库 Secrets

维护与更新

1. 版本管理
   • npm version patch|minor|major 升级版本。
2. 撤销发布（24小时内有效）

   npm unpublish my-cli-tool@1.0.1  # 删除指定版本

3. 文档与支持
   • 在 README.md 中提供使用示例和 API 文档。
   • 通过 GitHub Issues 处理用户反馈。

安全与优化

1. 忽略敏感文件
   创建 .npmignore 文件（类似 .gitignore）：

   .DS_Store
   node_modules/
   test/
   .env

2. 依赖审计

   npm audit  # 检查漏洞
   npm audit fix  # 自动修复

制作 npm 包命令是提升开发效率的关键技能，遵循语义化版本、完善测试和文档，能增强包的可靠性和专业性，立即实践这些步骤,为社区贡献高质量工具！

引用说明

• Node.js 官方文档：https://nodejs.org/docs/latest/api/
• npm 发布指南：https://docs.npmjs.com/packages-and-modules
• Commander.js 库：https://www.npmjs.com/package/commander
• 语义化版本规范：https://semver.org/

版权声明基于公开技术文档编写，代码示例采用 MIT 许可证，实践时请遵守 npm 服务条款。