codeclimate haml lint

Code Klima Haml-Lint-Engine

Wollten Sie schon immer genau wissen, wie gut Sie konsequent Haml schreiben können? Suchen Sie nicht mehr! Durch die Verwendung dieser Code-Klima-Engine können Sie die Leistung von Haml-Lint nutzen, um Ihren Code zu bewerten.

Willst du helfen?

Eindrucksvoll! Wir bemühen uns, alle zu begrüßen. Schauen Sie sich den leitenden Leitfaden an und lesen Sie sicher, dass Sie unseren Verhaltenskodex lesen.

Benötigen Sie Hilfe?

Um Hilfe bei Haml-Lint zu erhalten, lesen Sie ihre Dokumentation.

Wenn Sie auf ein Code -Klimaproblem stoßen, lesen Sie zunächst unsere [Engine -Dokumentation] [#Nutzung] und prüfen Sie, wie Ihre Frage möglicherweise bereits abgedeckt wurde. Wenn nicht, öffnen Sie bitte ein Problem und wir werden sehen, was wir tun können, um zu helfen.

Installation

Da dies noch kein öffentlich veröffentlichter Motor ist, müssen Sie den Motor aus diesem Repository bauen. Sie benötigen die Code -Klima -CLI sowie die git und make Befehle.

1. Wenn Sie es noch nicht getan haben, installieren Sie die Codeklima -CLI.
2. Wenn Sie Git nicht haben, installieren Sie es.
3. Wenn Sie nicht make haben, installieren Sie es. Auf einem Mac können Sie es mit Xcode bekommen. Unter Linux können Sie es in Ihrem Paketmanager (das build-essential Paket in Ubuntu oder base-devel Paket unter Arch Linux) erhalten. Unter Windows benötigen Sie wahrscheinlich Cygwin oder das Linux -Subsystem für Windows.
4. Machen Sie den Docker -Container des Motors mit make .

Wenn der Container nicht erstellt wird, stellen Sie ein Problem ein.

Sie sollten jetzt in der Lage sein, die Engine über die Code-Klima-CLI als Engine auf Entwicklungsebene zu verwenden. Um es in Ihrem Projekt zu verwenden, navigieren Sie zunächst zum Verzeichnis Ihres Projekts. Verwenden Sie dann den folgenden Befehl:

 $ codeclimate analyze -e haml-lint --dev

Verwendung

Wie andere Code -Klima -Engines konfigurieren Sie diese durch die Verwendung einer .codeclimate.yml -Datei im Stammverzeichnis Ihres Projekts. Wenn Sie noch keinen haben, können Sie die codeclimate engines:enable haml_lint , um eine grundlegende .codeclimate.yml -Datei mit aktivierter Engine zu generieren.

Wenn Sie Ihre Konfiguration nicht optimieren möchten, sollten Sie jetzt in der Lage sein, die Engine mit dem Befehl Analyse auszuführen:

 $ codeclimate analyze

Um die Linter zu optimieren, die Haml-Lint ausgeführt wird, befolgen Sie dieses Muster in der Konfigurationsdatei:

 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/

Der größte Teil der Konfiguration lebt unter den engines.haml-lint -Schlüssel. Die Optionen sind wie folgt:

• config.file - Die Haml -Lint -Konfigurationsdatei, die Sie als Basis verwenden möchten.
• checks.<LINTER_NAME> - Konfiguration für den von <LINTER_NAME> angegebenen Verlußen. Sie können eine der Konfigurationsoptionen für den Linter im Basis-Haml-Lint-Format übergeben. Weitere Informationen finden Sie in der Haml-Lint-Dokumentation.
• Die globale Konfiguration wie exclude_paths ist auch in der Konfiguration der Engine enthalten. Weitere Informationen finden Sie in der Code Climate -Dokumentation.

Versioning

Diese Engine ist basierend auf dem Versioningschema von Haml-Lint versioniert. Es verwendet die Version des Haml-Lint-Edelsteins, das als Basisversion installiert ist, und fügt dann eine Build-Nummer hinzu. Wenn der Motor zum ersten Mal für die 0.23.1 Version von Hamllint gebaut und veröffentlicht wird, beträgt die Version des Motors 0.23.1-1 . Wenn Fehler in der Engine ohne Aktualisierung der Haml-Lint-Version behoben werden, wird die Build-Nummer erhöht (z. B. auf 0.23.1-2 ).

Lizenz

Das Edelstein ist unter den Bedingungen der MIT -Lizenz als Open Source erhältlich.