codeclimate haml lint

代碼氣候HAML-LINT引擎

您是否曾經想知道您在編寫一致的HAML方面有多出色？好吧，別再了！通過使用此代碼氣候引擎，您可以利用HAML-LINT的功能來評分您的代碼。

想幫助嗎？

驚人的！我們努力歡迎所有人。查看貢獻指南，並確保閱讀我們的行為準則。

需要一些幫助嗎？

如有幫助，請查看他們的文檔。

如果您遇到了代碼氣候問題，請首先查看我們的[引擎文檔] [＃使用]，然後查看任何現有問題，因為您的問題可能已經涵蓋。如果沒有，請打開一個問題，我們將看到我們可以做些什麼來提供幫助。

安裝

由於這還不是公開發布的引擎，因此您必須從此存儲庫中構建引擎。您將需要安裝代碼氣候CLI，以及git並make命令。

1. 如果還沒有，請安裝代碼氣候CLI。
2. 如果您沒有git，請安裝它。
3. 如果沒有make ，請安裝它。在Mac上，您可以使用Xcode獲得它。在Linux上，您可以在軟件包管理器（Ubuntu中的build-essential Package of Arch Linux上的base-devel toppain）中獲取。在Windows上，您可能需要Cygwin或Windows的Linux子系統。
4. make引擎的Docker容器。

如果容器無法構建，請提交問題。

現在，您應該能夠通過代碼氣候CLI用作開發級發動機。要在項目上使用它，請首先導航到項目目錄。然後使用以下命令：

 $ codeclimate analyze -e haml-lint --dev

用法

像其他代碼氣候引擎一樣，您可以通過在項目的根目錄中使用.codeclimate.yml文件來配置該代碼。如果您還沒有一個，則可以使用codeclimate engines:enable haml_lint命令在啟用引擎的情況下生成一個基本的.codeclimate.yml文件。

如果您不在乎調整配置，現在應該能夠使用分析命令運行引擎：

 $ codeclimate analyze

要調整HAML-LINT將運行的Linters，請在配置文件中遵循此模式：

 engines :
  haml-lint :
    enabled : true
    config :
      file : my_custom_haml_lint.yml
    checks :
      HamlLint/AltText :
        enabled : false
      HamlLint/RuboCop :
        include :
          - lib/project_name/**/*.rb
        exclude :
          - spec/**/*.rb
exclude_paths :
  - ignored_directory/

大多數配置都生活在engines.haml-lint鍵。選項如下：

• config.file您要用作基礎的HAML -LINT配置文件。
• checks.<LINTER_NAME> - <LINTER_NAME>給出的linter的配置。您可以以基本HAML-LINT格式傳遞Linter的任何配置選項。有關更多信息，請參見HAML-LINT文檔。
• 引擎配置中還包含了像exclude_paths這樣的全局配置。有關更多信息，請參見代碼氣候文檔。

版本控制

該發動機是根據HAML-LINT版本控制方案版本版本的。它使用安裝為基本版本的HAML-lint GEM的版本，然後添加一個構建號碼。例如，第一次為0.23.1版本的Hamllint構建和釋放引擎時，發動機的版本為0.23.1-1 。如果在沒有更新HAML-lint版本的情況下固定了任何錯誤，則構建號將被遞增（例如，至0.23.1-2 ）。

執照

根據MIT許可證的條款，該寶石可作為開源。