淘寶開(kāi)源代碼質(zhì)量檢測(cè)工具！

代碼質(zhì)量評(píng)價(jià)標(biāo)準(zhǔn)

有編碼經(jīng)驗(yàn)的人對(duì)代碼都有一定的“鑒賞力”，能夠憑感覺(jué)給出代碼好壞的主觀評(píng)價(jià)。但是這種憑感覺(jué)的方式太過(guò)個(gè)性隨意，所謂仁者見(jiàn)仁智者見(jiàn)智，很難達(dá)成共識(shí)，那有沒(méi)有一種公認(rèn)的標(biāo)準(zhǔn)來(lái)鑒定代碼質(zhì)量呢？

答案是有的。這里簡(jiǎn)單分享當(dāng)下較常用的評(píng)價(jià)標(biāo)準(zhǔn)，其中包括：編碼規(guī)范、可讀性、可維護(hù)性、重復(fù)度及可測(cè)試性。

編碼規(guī)范
主要包含是否遵守了最佳實(shí)踐和團(tuán)隊(duì)編碼規(guī)范，是否包含可能出問(wèn)題的代碼，以及可能存在安全的漏洞。編碼規(guī)范有助于提高團(tuán)隊(duì)內(nèi)協(xié)助的效率以及代碼的可維護(hù)性。

可讀性
Code Review 是一個(gè)很好的測(cè)驗(yàn)代碼可讀性的手段。如果你的同事可以輕松地讀懂你寫(xiě)的代碼，那說(shuō)明你的代碼可讀性很好；反之則說(shuō)明你的代碼可讀性有待提高了。遵守編碼規(guī)范也能讓我們寫(xiě)出可讀性更好的代碼。

可維護(hù)性
代碼的可維護(hù)性是由很多因素協(xié)同作用的結(jié)果。代碼的可讀性好、簡(jiǎn)潔、可擴(kuò)展性好，就會(huì)使得代碼易維護(hù)；更細(xì)化地講，如果代碼分層清晰、模塊化好、高內(nèi)聚低耦合、遵從基于接口而非實(shí)現(xiàn)編程的設(shè)計(jì)原則等等，那就可能意味著代碼易維護(hù)。除此之外，代碼的易維護(hù)性還跟項(xiàng)目代碼量的多少、業(yè)務(wù)的復(fù)雜程度、利用到的技術(shù)的復(fù)雜程度、文檔是否全面等諸多因素有關(guān)。

重復(fù)度
遵守 Don’t Repeat Yourself 原則，盡量減少重復(fù)代碼的編寫(xiě)，復(fù)用已有的代碼。對(duì)項(xiàng)目定期進(jìn)行代碼重復(fù)度檢測(cè)是一個(gè)很有意義的事，可以幫助開(kāi)發(fā)人員發(fā)現(xiàn)冗余代碼，進(jìn)行代碼抽象和重構(gòu)。重復(fù)的代碼一旦出錯(cuò)，意味著加倍的工作量和持續(xù)的不可控。如果代碼中有大量的重復(fù)代碼，就要考慮將重復(fù)的代碼提取出來(lái)，封裝成公共的方法或者組件。

可測(cè)試性
代碼可測(cè)試性的好壞，同樣可以反應(yīng)代碼質(zhì)量的好壞。代碼的可測(cè)試性差，比較難寫(xiě)單元測(cè)試，那基本上就能說(shuō)明代碼設(shè)計(jì)得有問(wèn)題。

除此之外還有很多代碼質(zhì)量評(píng)價(jià)標(biāo)準(zhǔn)。我們需要一些取舍，選取部分大家有共識(shí)的規(guī)則定義團(tuán)隊(duì)好的代碼標(biāo)準(zhǔn)。

代碼質(zhì)量維度

當(dāng)前版本通過(guò) @iceworks/doctor 從 5 個(gè)維度對(duì)代碼進(jìn)行評(píng)分：

1. 最佳實(shí)踐： 通過(guò) @iceworks/eslint-plugin-best-practices 分析項(xiàng)目，提出符合當(dāng)前工程特征（對(duì) ice 和 Rax項(xiàng)目友好）的最佳實(shí)踐及阻塞問(wèn)題發(fā)布卡口，幫助開(kāi)發(fā)者優(yōu)化項(xiàng)目性能，避免潛在 bug 。

2. 安全實(shí)踐： 通過(guò) @iceworks/eslint-plugin-security-practices 掃碼代碼檢測(cè)工程中可能存在的安全風(fēng)險(xiǎn)，包含 url 、敏感成詞、明文賬密信息及 npm 包證書(shū)檢測(cè)，降低項(xiàng)目安全風(fēng)險(xiǎn)，守衛(wèi)項(xiàng)目安全。

3. 阿里代碼規(guī)范： 這一維度主要反饋開(kāi)發(fā)人員對(duì)于 eslint-config-ali 阿里開(kāi)發(fā)規(guī)約的遵守程度。

4. 可維護(hù)度： 通過(guò) typhonjs-escomplex 對(duì)文件進(jìn)行掃碼，得出每個(gè)文件的可維護(hù)度，可讀性及復(fù)雜度評(píng)分。針對(duì)得分較差的文件可以進(jìn)行深度分析幫助開(kāi)發(fā)者更好的重構(gòu)復(fù)雜代碼。

5. 重復(fù)度： 通過(guò) jscpd 計(jì)算重復(fù)出現(xiàn)的代碼區(qū)塊占比，計(jì)算出 clone 分?jǐn)?shù)。并逐一列舉重復(fù)的代碼，方便開(kāi)發(fā)者快速定位重復(fù)代碼，將其封裝成公共的方法或者組件。

根據(jù)上述 5 個(gè)維度通過(guò)加權(quán)平均的方式計(jì)算項(xiàng)目質(zhì)量分，并根據(jù)木桶效應(yīng)，在計(jì)算得分的過(guò)程中加大了最低分的權(quán)重，得出最終項(xiàng)目質(zhì)量評(píng)分。

項(xiàng)目地址

github地址：https://github.com/ice-lab/iceworks/tree/master/