這篇文章主要為大家展示了“如何使用node開(kāi)發(fā)并發(fā)布一個(gè)cli工具”,內(nèi)容簡(jiǎn)而易懂,條理清晰,希望能夠幫助大家解決疑惑,下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“如何使用node開(kāi)發(fā)并發(fā)布一個(gè)cli工具”這篇文章吧。
蕪湖縣網(wǎng)站建設(shè)公司創(chuàng)新互聯(lián)建站,蕪湖縣網(wǎng)站設(shè)計(jì)制作,有大型網(wǎng)站制作公司豐富經(jīng)驗(yàn)。已為蕪湖縣上千多家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\外貿(mào)營(yíng)銷(xiāo)網(wǎng)站建設(shè)要多少錢(qián),請(qǐng)找那個(gè)售后服務(wù)好的蕪湖縣做網(wǎng)站的公司定做!cli本質(zhì)是一種用戶(hù)操作界面,根據(jù)一些指令和參數(shù)來(lái)與程序完成交互并得到相應(yīng)的反饋,好的cli還提供幫助信息,我們經(jīng)常使用的vue-cli就是一個(gè)很好的例子。本文將使用nodejs從頭開(kāi)發(fā)并發(fā)布一款cli工具,用來(lái)查詢(xún)天氣。
項(xiàng)目效果圖如下:
配置項(xiàng)目
初始化一個(gè)項(xiàng)目: npm init -y
編寫(xiě)入口文件index.js:
module.exports = function(){ console.log('welcome to Anderlaw weather') }
創(chuàng)建bin文件
bin目錄下創(chuàng)建index:
#!/usr/bin/env node require('../')()
package.json配置bin信息
{ "name": "weather", "version": "1.0.0", "description": "", "main": "index.js", "bin": { "weather": "bin/index" } }
然后在根目錄(package.json同級(jí))運(yùn)行 npm link
,該操作會(huì)將該項(xiàng)目的模塊信息和bin指令信息以軟鏈接的形式添加到npm全局環(huán)境中:
C:\Users\mlamp\AppData\Roaming\npm\node_modules
下多了一個(gè)模塊鏈接
C:\Users\mlamp\AppData\Roaming\npm
下多了個(gè)名為 weather
的cmd文件。
好處是可以更方便地進(jìn)行本地調(diào)試。 然后我們打開(kāi)終端輸入: weather
就會(huì)看到 welcome to Anderlaw weather
的log信息
解析命令與參數(shù)
此處我們使用 minimist
庫(kù)來(lái)解析如:npm --save ,npm install 的參數(shù)。
安裝依賴(lài)庫(kù) npm i -S minimist
使用 process.argv
獲取完整的輸入信息
使用 minimist
解析,例如:
weather today === args:{_:['today']} weather -h === args:{ h:true } weather --location 'china' === args:{location:'china'}
首先我們要實(shí)現(xiàn)查詢(xún)今天和明天的天氣,執(zhí)行 weather today[tomorrow]
const minimist = require('minimist'); module.exports = ()=>{ const args = minimist(process.argv.slice(2));//前兩個(gè)是編譯器相關(guān)路徑信息,可以忽略 let cmd = args._[0]; switch(cmd){ case 'today': console.log('今天天氣不錯(cuò)呢,暖心悅目!'); break; case 'tomorrow': console.log('明天下大雨,注意帶雨傘!'); break; } }
以上,如果我們輸入 weather
就會(huì)報(bào)錯(cuò),因?yàn)闆](méi)有取到參數(shù).而且還沒(méi)添加版本信息,因此我們還需要改善代碼
const minimist = require('minimist') const edition = require('./package.json').version module.exports = ()=>{ const args = minimist(process.argv.slice(2));//前兩個(gè)是編譯器相關(guān)路徑信息,可以忽略 let cmd = args._[0] || 'help'; if(args.v || args.version){ cmd = 'version';//查詢(xún)版本優(yōu)先! } switch(cmd){ case 'today': console.log('今天天氣不錯(cuò)呢,暖心悅目!'); break; case 'tomorrow': console.log('明天下大雨,注意帶雨傘!'); break; case 'version': console.log(edition) break; case 'help': console.log(` weather [command]today .............. show weather for today tomorrow ............show weather for tomorrow version ............ show package version help ............... show help menu for a command `) } }
接入天氣API
截止目前工作順利進(jìn)行,我們還只是手工輸入的一些mock信息,并沒(méi)有真正的實(shí)現(xiàn)天氣的查詢(xún)。 要想實(shí)現(xiàn)天氣查詢(xún),必須借助第三方的API工具,我們使用心知天氣提供的免費(fèi)數(shù)據(jù)服務(wù)接口。
需要先行注冊(cè),獲取API key和id 發(fā)送請(qǐng)求我們使用axios庫(kù)(http客戶(hù)請(qǐng)求庫(kù))
安裝依賴(lài): npm i -S axios
封裝http模塊
///ajax.js const axios = require('axios') module.exports = async (location) => { const results = await axios({ method: 'get', url: 'https://api.seniverse.com/v3/weather/daily.json', params:{ key:'wq4aze9osbaiuneq', language:'zh-Hans', unit:'c', location } }) return results.data }
該模塊接收一個(gè) 地理位置 信息返回今天、明天、后臺(tái)的天氣信息。
例如查詢(xún)上海今天的天氣: weather today --location shanghai
修改入口文件,添加 async標(biāo)志
const minimist = require('minimist') const ajax = require('./ajax.js') const edition = require('./package.json').version module.exports = async ()=>{ const args = minimist(process.argv.slice(2));//前兩個(gè)是編譯器相關(guān)路徑信息,可以忽略 let cmd = args._[0] || 'help'; if(args.v || args.version){ cmd = 'version';//查詢(xún)版本優(yōu)先! } let location = args.location || '北京'; let data = await ajax(location); data = data.results[0]; let posotion= data.location; let daily = data.daily; switch(cmd){ case 'today': //console.log('今天天氣不錯(cuò)呢,暖心悅目!'); console.log(`${posotion.timezone_offset}時(shí)區(qū),${posotion.name}天氣,${posotion.country}`) console.log(`今天${daily[0].date}:白天${daily[0].text_day}夜晚${daily[0].text_night}`) break; case 'tomorrow': //console.log('明天下大雨,注意帶雨傘!'); console.log(`${posotion.timezone_offset}時(shí)區(qū),${posotion.name}天氣,${posotion.country}`) console.log(`今天${daily[1].date}:白天${daily[1].text_day}夜晚${daily[1].text_night}`) break; case 'version': console.log(edition) break; case 'help': console.log(` weather [command]today .............. show weather for today tomorrow ............show weather for tomorrow version ............ show package version help ............... show help menu for a command `) } }
我們輸入 weather today --location shanghai
,發(fā)現(xiàn)有結(jié)果了:
修修補(bǔ)補(bǔ),添加loading提示和默認(rèn)指令
截止當(dāng)前,基本完成了功能開(kāi)發(fā),后續(xù)有一些小問(wèn)題需要彌補(bǔ)一下,首先是一個(gè)進(jìn)度提示,使用起來(lái)就更加可感知,我們使用 ora
庫(kù).
其次我們需要當(dāng)用戶(hù)輸入無(wú)匹配指令時(shí)給予一個(gè)引導(dǎo),提供一個(gè)默認(rèn)的log提示。
安裝依賴(lài) npm i -S ora
編寫(xiě)loading模塊:
const ora = require('ora') module.exports = ora() // method start and stop will be use
修改入口文件
const minimist = require('minimist') const ajax = require('./ajax.js') const loading = require('./loading') const edition = require('./package.json').version module.exports = async ()=>{ const args = minimist(process.argv.slice(2));//前兩個(gè)是編譯器相關(guān)路徑信息,可以忽略 let cmd = args._[0] || 'help'; if(args.v || args.version){ cmd = 'version';//查詢(xún)版本優(yōu)先! } let location = args.location || '北京'; loading.start(); let data = await ajax(location); data = data.results[0]; let posotion= data.location; let daily = data.daily; switch(cmd){ case 'today': //console.log('今天天氣不錯(cuò)呢,暖心悅目!'); console.log(`${posotion.timezone_offset}時(shí)區(qū),${posotion.name}天氣,${posotion.country}`) console.log(`今天${daily[0].date}:白天${daily[0].text_day}夜晚${daily[0].text_night}`) loading.stop(); break; case 'tomorrow': //console.log('明天下大雨,注意帶雨傘!'); console.log(`${posotion.timezone_offset}時(shí)區(qū),${posotion.name}天氣,${posotion.country}`) console.log(`今天${daily[1].date}:白天${daily[1].text_day}夜晚${daily[1].text_night}`) loading.stop(); break; case 'version': console.log(edition) loading.stop(); break; case 'help': console.log(` weather [command]today .............. show weather for today tomorrow ............show weather for tomorrow version ............ show package version help ............... show help menu for a command `) loading.stop(); default: console.log(`你輸入的命令無(wú)效:${cmd}`) loading.stop(); } }
以上是“如何使用node開(kāi)發(fā)并發(fā)布一個(gè)cli工具”這篇文章的所有內(nèi)容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內(nèi)容對(duì)大家有所幫助,如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)成都網(wǎng)站設(shè)計(jì)公司行業(yè)資訊頻道!
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無(wú)理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性?xún)r(jià)比高”等特點(diǎn)與優(yōu)勢(shì),專(zhuān)為企業(yè)上云打造定制,能夠滿(mǎn)足用戶(hù)豐富、多元化的應(yīng)用場(chǎng)景需求。