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许可证的条款，该宝石可作为开源。