Téléchargement codeclimate haml lint - Téléchargement du code source codeclimate haml lint

codeclimate haml lint

Autres catégories

1.0.0

Télécharger

Code Climate Haml-lint Engine

Avez-vous déjà voulu savoir exactement à quel point vous êtes bon à écrire Haml cohérent? Ne regarde plus! En utilisant ce moteur climatique de code, vous pouvez exploiter la puissance de Haml-lint pour marquer votre code.

Vous voulez aider?

Génial! Nous nous efforçons d'accueillir tout le monde. Consultez le guide contributeur et assurez-vous de lire notre code de conduite.

Besoin d'aide?

Pour obtenir de l'aide avec HAML-lint, consultez leur documentation.

Si vous rencontrez un problème climatique de code, consultez d'abord notre [documentation du moteur] [# usage] et examinez les problèmes existants, car votre question peut déjà avoir été couverte. Sinon, veuillez ouvrir un problème et nous verrons ce que nous pouvons faire pour aider.

Installation

Comme ce n'est pas encore un moteur publique, vous devrez construire le moteur à partir de ce référentiel. Vous aurez besoin du Code Climate CLI installé, ainsi que des commandes git et make .

Si vous ne l'avez pas déjà fait, installez le Code Climate CLI.
Si vous n'avez pas de GIT, installez-le.
Si vous n'avez pas make , installez-le. Sur un Mac, vous pouvez l'obtenir avec Xcode. Sur Linux, vous pouvez l'obtenir dans votre gestionnaire de packages (le package build-essential dans Ubuntu ou le package base-devel sur Arch Linux). Sur Windows, vous avez probablement besoin de cygwin ou du sous-système Linux pour Windows.
Faites le conteneur Docker du moteur avec make .

Si le conteneur ne parvient pas à créer un problème.

Vous devriez maintenant pouvoir utiliser le moteur via le Code Climate CLI en tant que moteur au niveau du développement. Pour l'utiliser sur votre projet, accédez d'abord au répertoire de votre projet. Utilisez ensuite la commande suivante:

 $ codeclimate analyze -e haml-lint --dev

Usage

Comme d'autres moteurs climatiques de code, vous configurez celui-ci grâce à l'utilisation d'un fichier .codeclimate.yml dans le répertoire racine de votre projet. Si vous n'en avez pas déjà, vous pouvez utiliser les codeclimate engines:enable haml_lint pour générer un fichier .codeclimate.yml de base avec le moteur activé.

Si vous ne vous souciez pas de modifier votre configuration, vous devriez maintenant pouvoir exécuter le moteur avec la commande Analyze:

 $ codeclimate analyze

Pour modifier les liners que Haml-lint s'exécutera, suivez ce modèle dans le fichier de configuration:

 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/

La majeure partie de la configuration vit sous la clé de engines.haml-lint . Les options sont les suivantes:

config.file - le fichier de configuration haml-lint que vous souhaitez utiliser comme base.
checks.<LINTER_NAME> - Configuration pour le linter donné par <LINTER_NAME> . Vous pouvez transmettre l'une des options de configuration pour le Linter dans le format Haml-lint de base. Voir la documentation HAML-lint pour plus d'informations.
La configuration globale comme exclude_paths est également incluse dans la configuration du moteur. Voir la documentation du climat du code pour plus d'informations.

Versioning

Ce moteur est versé en fonction du schéma de versioning de HAML-lint. Il utilise la version du joyau haml-lint qui est installée comme version de base, puis ajoute un numéro de construction. Par exemple, la première fois que le moteur est construit et libéré pour la version 0.23.1 de Hamllint, la version du moteur est 0.23.1-1 . S'il y a des bogues fixés dans le moteur sans mettre à jour la version haml-lint, le numéro de construction sera incrémenté (par exemple à 0.23.1-2 ).