《Puppet實戰手冊》——2.3 使用puppet-lint檢查配置清單

本節書摘來自異步社群《puppet實戰手冊》一書中的第2章，第2.3節，作者：【英】john arundel著，更多章節内容可以通路雲栖社群“異步社群”公衆号檢視

puppet實驗室的官方風格指南列出了一些針對puppet代碼風格的約定，其中一些内容讀者已經在上一節接觸過。例如，根據風格指南，配置清單：

必須使用兩個空格形式的軟跳格（tab）；

不得使用文字制表符；

不得包含尾随空格；

每行最好不要超過80個字元；

代碼塊中的參數箭頭（=>）需要對齊。

遵循風格指南可以使puppet代碼容易閱讀和維護，并且，如果使用者計劃公開釋出代碼，與社群風格進行相容是非常必要的。puppet-lint這個工具可以自動根據風格指南對代碼進行檢查。下面就來看看如何使用它。

準備工作

下面是安裝puppet-lint需要執行的操作。

運作下面的指令（将以gem方式安裝puppet-lint，因為gem中的版本比ubuntu precise倉庫中的版本要新得多）。

操作步驟

按照下面的步驟使用puppet-lint。

1． 選擇希望使用puppet-lint指令檢查的puppet配置清單檔案，然後執行下面的指令：

2． 可以看到，puppet-lint發現了配置清單中的一些問題。修正這些問題，儲存檔案，重新使用puppet-lint來檢查是否還有問題。所有問題都被解決後，這條指令不再有輸出。

更多參考

讀者可以在<code>http://puppet-lint.com/</code>擷取關于puppet-lint更多的内容。這個網站詳細地列出了每一種風格檢查，并且解釋了每一種錯誤資訊的含義，以及解決它們的方法。

是否必須遵循puppet的風格指南？或者，進一步講，保證代碼是被lint工具檢查過的？這完全取決于使用者自己。不過，仍然有一些事情需要考慮。

使用一些風格約定是很有必要的，特别是代碼編寫工作存在協同的情況下。除非彼此能夠在空格、跳格（tab）、引用、對齊等方面達成一緻的标準，否則，代碼将會被認為非常醜陋并且難以閱讀和維護。

如果正在選擇一組風格約定來遵循，選擇由puppet labs釋出并被社群使用在開放子產品中的風格約定，這是個合理的選擇。

話雖如此，如果希望在使用puppet-lint時針對代碼忽略一些項目的檢查，也是可以的。例如，如果希望puppet-lint在一行代碼超過80個字元時不發出警告，可以在運作puppet-lint時使用如下參數：

<code>puppet-lint --no-80chars-check</code>

運作puppet-lint --help，可以看到檢查配置的完整指令清單。

延伸閱讀

參見1.10節。

參見8.9節。