簡評:設(shè)計良好的命令行應(yīng)用是極富生產(chǎn)力的工具副编,本文介紹了開發(fā)命令行工具的 12 個最佳實踐
CLI 是構(gòu)建產(chǎn)品的絕佳方式负甸,與 Web 應(yīng)用不同的是它需要的時間更少,并且功能更強大。使用Web呻待,你可以執(zhí)行開發(fā)人員編寫的任何操作打月,使用 CLI,你可以輕松地將多個工具混合在一起以執(zhí)行更加高級的任務(wù)蚕捉,而這需要更多的專業(yè)知識才能使用奏篙,但仍然適用于管理任務(wù)、高級用戶任務(wù)或開發(fā)人員產(chǎn)品迫淹。
在 Heroku秘通,我們提出了一種稱為 「12-factor app」 的方法,這是一套旨在制作易于維護的優(yōu)秀 Web 應(yīng)用程序的原則敛熬。我們還構(gòu)建了一個名為 oclif 的 CLI 框架肺稀,旨在遵循這些原則使用Node 構(gòu)建出色的 CLI 應(yīng)用。
本著這種精神应民,在構(gòu)建下一個 CLI 時话原,請記住以下 12 個因素:
- 良好的幫助命令是必不可少的(Great help is essential)
- 傾向于使用選系代替參數(shù) (Prefer flags to args)
- 明確當(dāng)前的版本(一般是 --version/-V)(What version am I on?)
- 關(guān)注流處理(輸入輸出流和重定向)(Mind the streams)
- 處理錯誤(Handle things going wrong)
- 顏控(Be fancy!)
- 盡量提示(Prompt if you can)
- 使用表格(Use tables)
- 唯快不破(Be speedy)
- 鼓勵開源貢獻代碼(Encourage contributions)
- 清晰的子命令(Be clear about subcommands)
- 遵循 XDG 規(guī)范(Follow XDG-spec)
原文鏈接:12 Factor CLI Apps
推薦閱讀:Level UP! 提升你的編程技能