Nodejs 发布自己的npm包并制作成命令行工具的实例讲解

下面将详细讲解如何发布自己的npm包并制作成命令行工具的步骤：

准备工作

1. 安装Node.js环境
2. 注册npm账号或者使用已有的npm账号

发布npm包

1. 创建一个文件夹，命名为my-package(名字可以自己定义)。

2. 在my-package文件夹下创建一个package.json文件。

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "My first npm package",
  "main": "index.js"
}

上面是package.json文件的基本结构，其中name表示包名，version表示版本号，description表示包的描述，main表示入口文件。

1. 创建根目录下的index.js文件，这是入口文件。

module.exports = function(){
    console.log('Hello, world!')
}

上面是index.js 文件的内容。

1. 登录npm账号。

在终端中输入npm login，输入用户名、密码和邮箱即可。

1. 发布包。

在命令行中进入my-package文件夹，并输入npm publish。如果发布成功，控制台会输出+ my-package@1.0.0。

1. 更新包

如果更新包，只需要修改package.json文件中的版本号，然后重复步骤5即可。

制作命令行工具

1. 创建一个文件夹，命名为my-cli。

2. 在my-cli文件夹下创建一个package.json文件。

{
  "name": "my-cli",
  "version": "1.0.0",
  "description": "My first CLI tool",
  "bin": "./index.js"
}

上面是package.json文件的基本结构，bin表示指定命令行工具的执行文件路径，具体是执行哪个文件需要在index.js文件中指定。

1. 创建根目录下的index.js文件。

#!/usr/bin/env node

console.log('Hello, world!')

上面是index.js 文件的内容。注意，第一行#!/usr/bin/env node 必须加上，表示使用node来执行此脚本。此处的代码可以替换为需要实现的命令行工具的逻辑。

1. 在终端中进入my-cli文件夹，并输入npm link。这一步是将当前目录下的包链接到全局模块中，从而可以在系统中使用该包的命令。

2. 输入my-cli，即可看到命令行工具的输出结果Hello, world!。

3. 如果需要卸载命令行工具，可以输入npm unlink -g。

至此，Nodejs发布自己的npm包并制作成命令行工具的完整攻略就讲解完毕了。

示例一：

{
  "name": "addition",
  "version": "1.0.0",
  "description": "An addition tool",
  "main": "index.js"
}

module.exports = function(a,b){
    return a+b;
}

#!/usr/bin/env node

const addition = require('./index.js')
const a = parseInt(process.argv[2])
const b = parseInt(process.argv[3])
console.log(addition(a,b))

示例二：

{
  "name": "converter",
  "version": "1.0.0",
  "description": "A temperature converter",
  "bin": "./index.js"
}

#!/usr/bin/env node

const celsiusToFahrenheit = require('./celsiusToFahrenheit.js')
const fahrenheitToCelsius = require('./fahrenheitToCelsius.js')

const command = process.argv[2]
const value = parseFloat(process.argv[3])

if(command === 'ftoc'){
  console.log(fahrenheitToCelsius(value))
}else if(command === 'ctof'){
  console.log(celsiusToFahrenheit(value))
}

module.exports = function(celsius){
    return celsius * 9/5 + 32;
}

module.exports = function(fahrenheit){
    return (fahrenheit - 32) * 5/9;
}