[心得] 我如何在 GitHub 上拿到四千顆星

[eliang ()]

兩個月前我在 GitHub 發表了一個開源專案，發表後一夕爆紅，在一開始的 24 小時內就
得到 1200+ 顆星，目前已累積 4000+ 顆星。這個專案名叫 HTTP Prompt，網址是：

https://github.com/eliangcs/http-prompt

我想在這裡分享一下它的開發故事。

這一切要先從 Vertica 講起。沒多久前我的工作幾乎每天都會使用 Vertica，Vertica
是一個強大的資料庫，但它官方的客戶端程式（vsql）一點都不強大。另一個 GUI 的選擇
DbVisualizer 也是難用到爆。

我就想起 PostgreSQL 那邊有一個叫 pgcli 的好物，我想如果 fork 它，應該不需要太大
功夫就能把它改成 Vertica 版本。最後也如我所想，沒花幾天就寫出了 vcli：

https://github.com/dbcli/vcli

我還聯絡了 pgcli 的原作者，告訴他「我用你的東西寫了另一個專案」，他很高興的幫我
在他網站上宣傳。但 Vertica 實在是小眾，所以 vcli 並沒有得到很多注意。但至少有了
 vcli，我終於能每天快快樂樂的使用 Vertica 了。

vcli、pgcli、mycli（for MySQL）其實都是建於一個叫 prompt-toolkit 的 Python 套件
之上。有了 prompt-toolkit 的加持，任何命令列程式因為有了自動完成和語法高亮，都
會變得超酷炫，去它的首頁看看有多少專案使用它就知道了：

https://github.com/jonathanslenders/python-prompt-toolkit

當時有一陣子工作常會需要連接 HTTP/REST API，這應該也是很多人工作的一部分，我相
信大部分人應該都是用 Postman 這類 GUI 工具，但身為一個什麼都要盡量用命令列介面
的 hacker，用 GUI 實在有點 low，而且跟 terminal 切換起來也不方便。所以我就選擇
使用類似 curl 的 HTTPie。使用 HTTPie 的缺點是常需要打很多重複的字，不像 Postman
會幫你記住之前的狀態，我想如果 HTTPie 或 curl 有互動模式就好了。我調查了一下，
原來早在一年前就有人這麼想了：

https://github.com/jkbrzt/httpie/issues/343

甚至在五年前就有人寫出我心目中理想的工具了：

https://github.com/chrislongo/HttpShell

但 HTTPie 實在設計得太完美讓我不想放棄它，而且 HttpShell 似乎也沒在更新，所以我
也就不考慮使用 HttpShell。

「任何命令列程式受了 prompt-toolkit 加持，都會變得超酷炫」，那我何不站在巨人肩
膀上，結合 HTTPie 和 prompt-toolkit，寫出一個有自動完成和語法高亮的 HTTP client
，不要求使用者放棄完美的 HTTPie，肯定有賣點。

於是我開始著手開發 HTTP Prompt，我還告訴我老婆，我這寫完至少會在 GitHub 拿一千
顆星星。我當時不是隨便推算的。因為 pgcli 都有四千多顆星了，用 HTTP 的人一定多過
PostgreSQL，所以如果我執行得好，吸引一千顆星星應該不是問題。

一開始卡最久是我想找出一個完美的寫法，使得自動完成、語法高亮、指令解析三大模組
能用一個統一的 context-free grammar（CFG）解決，但 prompt-toolkit 的作者告訴我
這個想法不切實際：

https://github.com/jonathanslenders/python-prompt-toolkit/issues/276

所以最終只有指令解析是以 CFG 實做，另兩個模組則分別土法煉鋼。CFG parser 一開始
也讓我有點頭痛，幸虧有人寫了一個現成的 parser：

https://github.com/erikrose/parsimonious

讀過 parsimonious 的程式碼，我只能說這套件的作者功力深厚，沒有編譯器或正規語言
的基礎還真寫不出這樣的東西。

prompt-toolkit 已解決大部分的難題，所以除了 CFG 之外就沒什麼特別困難的地方了。
我前後大概花了三個禮拜完成基本功能，即發佈到 Reddit/programming，沒多久就登上熱
門第一名：

https://www.reddit.com/r/programming/comments/4k1l2o

Reddit 廣告效益真的很強，HTTP Prompt 初期的流量都是靠 Reddit 吸引進來的。之後星
星數愈增愈快，幾乎是每一分鐘都就多一顆星，也成功登上 GitHub Trending 第一名，老
婆還幫我拍了一張照片做紀念：

http://imgur.com/4zKkv98

Issue 和 pull request 也跟著星星一起來，其中有不少不錯的功能建議，我也陸續加入
，在後面幾個版本釋出。

開發開源專案是很好玩的，當你知道很多人正在使用你寫的軟體、給你回饋，你會覺得你
在做一件有意義的事。希望這篇文章能鼓勵更多人使用 HTTP Prompt，也能幫助到一些想
參與開源專案的人，當然最好是可以貢獻到 HTTP Prompt :P。

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 1.162.127.191
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1467888742.A.259.html
推 landlord: great!
推 Masakiad: 開源推
推 lensuper: 強者
推 chiwa: 高手!!
推 ntddt: 強者狂推 讓世界看到台灣軟實力
推 crossdunk: 4000!!!!!!!!!!!!
推 SMNOONMS: 推開源
推 SuM0m0: 讚耶 看起來很不錯
推 rodion: 感謝分享經驗談：＞
推 mmm951: 推分享
推 hSATAC: 強
推 feeling543: 推！
推 sdf611097: 推
推 max241: GOD
推 cookie1115: 強
推 aa06697: 太神啦
推 y2468101216: 推
推 minikai: 太神了！ 已跪！
推 MoriUmi: 推 有空來用用看 感覺很實用 手打指令超容易打錯的
推 dreamnook:
推 jlhc: 推一個!!!
推 fake01: 太神辣
推 Zeusken: 好強
推 sky75217: 推
推 TKSHADE: 強者~~!!
推 longlyeagle: push
推 Aaronter: 感謝支援
推 Hevak: 有在trending看到，原來是台灣人@@! cool
推 chung928: 推強者!
推 Yshuan: 朝聖!!
推 bowin: 推！Good job!! :-)
推 bab7171: 推
推 FLAMEDDD: 請問「fork它」是甚麼意思阿　謝謝
推 SmileJoS: 推推推，好強
推 wuliou: 太強辣
推 vi000246: 推
→ eliang: fork意思是拿別人的code改成另一個東西
→ eliang: 沒想到PTT廣告效益也很好，又多了好多星星，感謝鄉民支持
推 A4P8T6X9: 推
推 gozule: open source果然高手如雲
推 javy0521: 推!
推 Zarmy: 強者推!
推 nfsong: 推
推 FLAMEDDD: 感謝 eliang 解釋
推 zerofinal: 推
推 n080925: 強者請受我一拜!!
推 tongzhou: 推強者
推 tnav: cool
推 alibuda174: 推
推 bobbyho: 推 OpenSource
推 imindflow: 強
推 gerojeng: 強者
推 jily: 超屌的!!!!
推 b510336: 太神啦~
推 wowna: 推
推 x4base: 朝聖推～～
推 ThxThx: 路過推，太神了...
推 lulufufu: 神人推...
推 Ekmund: ...
推 yuanyu90221: 推
推 Expsun: 推
推 descent: 推
→ fantasystar: 這難道是傳說中的伊亮
推 abc0922001: 超強XDDD 開源推
推 abc0922001: fork就是把別人盤子的牛肉夾道自己盤子上
推 kakahikari: 猛
推 dali17dali17: 跪了
推 johnny4753: 實在太強拉 拜一下
推 srxrrr: 已跪QQ
推 Ghosso: 是傳說中的lab學長嗎！
推 PHEj: 太神了 開源推!
推 takingblue: 太強了!
推 qrtt1: 朝聖
推 markbex: 推
推 hydrogencl: github推!
推 jammy50605: 太神啦
推 Bright: 神!
推 retard: 你老婆應該也是搞軟體的~~ 好讚~~
推 Sean64: 朝聖推             <(__)>
推 timwu: 好久沒在ptt回文啦.. 已star , parsimonious 是 PEG , 不能
→ timwu: 再叫它 CFG 了, http://go.shr.lc/29DVncS , PEG很輝煌的一
→ timwu: 役就是唐鳳用parsec幹完perl6, then 真希望 prompt-toolkit
→ timwu: 可以 port 到 GO 啊
推 mirage7714: 強者推
推 janice001: 純推
推 mithuang: 還告訴老婆能拿到多少星星XDD,好熱血的感覺!!!
→ eliang: @timwu 謝謝指正，大學沒修過編譯器，只在正規語言學過CFG
推 abola921: 推
推 decheng: 推呀～！強大～
→ eva19452002: 我連原po一根腳毛都比不上
推 Argos: 推推！
推 terry01333: 推!
推 jenesis: 真的 除了專案本身的品質以外宣傳也是很重要的
推 iamshiao: 推
推 jiaming: 推
推 whitglint: 看起來不錯，一定要用用看，給推！
推 Zatarra: 推!!
推 hijkxyzuw: 原來是台灣人推！
推 smallmac: 推
推 frank11118: 強者
推 ian90911: 太神啦
推 andreli: 推!
推 tomroy: 猛
推 doranako: 推
推 TEMPEST: 真的太厲害了
推 popxpopxpop: fork推
推 wadeabc: 推
推 drinks: 厲害!
推 promiseone: 推
推 LV999: 好威
推 tenth: 推~
推 netsphere: 推，厲害
推 gechenchen92: 推真強者和分享
推 Sidney0503: 只能推了
推 kenn7: 前輩
推 kiki86151: 推
推 easybaby: 推
推 enamor753: 朝聖
推 polo8214: 感謝分享
推 heihei: 推!
推 bobju: 讚~
推 xdraculax: 推
推 lovdkkkk: (y)
推 O87: 推推
推 wadeabc: 這世界就需要你這種人，哪像老屁股領錢不做事
推 loveisth520: 已跪
推 shibin: 推分享
推 aacs0130: 強者，推推
推 BlazarArc: 推
推 lukedoomer: 這東西的用處應該就只是測試透過HTTP傳輸的API?
→ lukedoomer: 我覺得這CLI很棒，但我想知道是不是有我不知道的用處
推 akito117: 推
→ eliang: @lukedoomer 主要用途就是測試HTTP API沒錯
→ eliang: 另一用途是用curl或httpie指令為例告訴別人如何呼叫API
推 wanlinlin: 推神
推 andy5564: 推
推 secondDim: 跪著推了
推 Csy065: 有神快拜
推 supertalker: 朝聖推
推 uly: 跪了
推 et282523: 推~
推 bananayen: 推強者
推 demo1945: 來朝聖
推 tim5104: 超強的給推！感謝原po的貢獻！！
推 p90085: 高手推推
推 zxc455233: 朝聖跪
推 iamten: 推推
推 Jason81000: 推
推 vvind: 推