[[330754]]

在設(shè)置新的存儲庫時，為不同類型的代碼選擇合適的對應(yīng) linter 可能是既費(fèi)時又乏味的工作。可供選擇的工具和配置如此之多，我們通常需要不止一個 linter 才能涵蓋所有用到的語言。

GitHub Super Linter 是由 GitHub Services DevOps 工程團(tuán)隊根據(jù)需要構(gòu)建的，目的是保持我們文檔和代碼的一致性，同時提升整個公司之間的交流和協(xié)作的效率。現(xiàn)在我們正式將其開源，這樣所有人都可以使用和改進(jìn)它了！

https://github.com/github/super-linter

Super Linter 通過自動化解決了許多需求。其特性包括：

• 防止將損壞的代碼上傳到主分支；
• 幫助建立多種語言的編碼最佳實踐；
• 制訂代碼布局和格式的指南；
• 自動化流程以幫助簡化代碼審查；

有了這些基礎(chǔ)標(biāo)準(zhǔn)后，我們就能在內(nèi)部 / 向客戶和合作伙伴交付更好、更整潔、更穩(wěn)定的代碼。

1. 它是什么？

Super Linter 是一個源代碼存儲庫，它打包到一個 Docker 容器中，并由 GitHub Actions 調(diào)用。這樣 GitHub.com 上的任何存儲庫都可以調(diào)用 Super Linter 并從中獲益。

目前 Super Linter 支持多種語言，將來還會提供更多語言支持。有關(guān)支持語言的詳細(xì)信息，請查看 README.md。

https://github.com/github/super-linter/blob/master/README.md

2. 工作機(jī)制

將存儲庫設(shè)置為開始運(yùn)行這個動作（Action）后，只要你打開一個拉取請求，存儲庫就會開始 linting 代碼并通過 Status API 返回。它會通知你所有代碼更改是否成功通過，或者是否檢測到任何錯誤，錯誤在哪里以及它們的具體信息。然后，開發(fā)人員可以返回其分支，解決所有問題，并為這個開放的 PR 創(chuàng)建一個新的 push。屆時，Super Linter 將再次運(yùn)行和驗證更新代碼，并重復(fù)該過程。你可以配置分支保護(hù)規(guī)則，加入"所有代碼在合并前必須通過"的額外規(guī)定。

Super Linter 擁有大量帶有標(biāo)志和模板的自定義選項，你可以針對自己的存儲庫調(diào)整它們。只需按照 Super Linter 存儲庫和 Super Linter Wiki 上的詳細(xì)說明操作即可。

https://github.com/github/super-linter/wiki

這款工具對于將多種類型的代碼和 / 或文檔放在一起的存儲庫（單體存儲庫）來說也很有用。

3. 默認(rèn)規(guī)則

在 Super Linter 中標(biāo)準(zhǔn)化一個規(guī)則集是一項有趣的挑戰(zhàn)，因為每位開發(fā)人員的編碼方式都是獨(dú)一無二的。所以我們允許用戶根據(jù)他們自己的存儲庫情況對 Linter 使用任何規(guī)則。但如果用戶未定義規(guī)則集，則我們必須有一個默認(rèn)標(biāo)準(zhǔn)。

Ruby 和 Rails 的規(guī)則集來自 Ruby gem：rubocop-github，并遵循我們在 GitHub.com 上使用的同一套規(guī)則和版本控制策略。

https://github.com/github/rubocop-github

對于其他語言，我們指定了安裝 linter 時的默認(rèn)項，例如：coffeelint 或 yamllint。至于剩下的那些，我們嘗試找到一個合適的平衡點——基礎(chǔ)簡單且能幫助建立一些最佳實踐，例如：Markdownlint 或 pylint。

https://github.com/clutchski/coffeelint

https://github.com/adrienverge/yamllint

這樣做的好處是，你可以直接開始建立框架，并且當(dāng)需要新的自定義選項時你的團(tuán)隊可以隨時做出相應(yīng)的決策與改動。

只需轉(zhuǎn)到 Super Linter，然后將模板從 TEMPLATES 文件夾復(fù)制到本地存儲庫即可。