Skip to content

lurongze/cli-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

开发cli工具流程

初始化项目

新建开发目录,进入目录后使用npm初始化项目,填写项目基本信息。

mkdir my-cli
cd my-cli
npm init

打开package.json文件,加入bin参数

{
  "name": "my-cli", // 项目名称
  "version": "1.0.0",
  "description": "my-cli",
  "type":"module",  // 为了支持node里使用import
  "main": "index.js",
  "bin": { // 最重要字段,有这个,终端才可以执行我们的命令
    "my-cli": "./bin/index.js" // my-cli表示我们的cli程序名称,路径是我们的执行代码文件
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

新建代码文件

一般我们新建一个bin目录,里面index.js是我们的执行代码文件。(可以随便建,和package.json里bin定义的一样即可)

// ./bin/index.js
#!/usr/bin/env node
console.log("cli-demo");

注意,第一行代码#!/usr/bin/env node非常重要,定义了代码执行程序为node,不然可能会以文本形式打开文件。

本地安装

在项目跟目录,执行npm install -g,即可把本地开发的cli项目全局安装到本地,方便测试。

开发cli常用辅助包

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published