twly

Twlly?

Twlly (prononcé "Towel-E") est un outil d'analyse statique qui peut vous aider à garder votre code à sec (ne vous répétez pas) en vous faisant savoir où vous avez copier et collé entiers de fichiers ou de parties d'entre eux. Exécutez Twlly sur un répertoire, et Twlly générera comme par magie un rapport pour vous indiquer ce qui a été répété et dans quels fichiers. Twlly est un langage agnostique et peut être utilisé sur n'importe quel document texte.

Installation

npm install -g twly ou pour inclure dans un projet npm install twly --save-dev

Configuration

TWLY a une configuration par défaut, ce qui se traduit par l'objet JSON de configuration suivante

  {
    "threshold": 95,
    "ignore": ["node_modules/**/*.*", "bower_components/**/*.*", ".git/**/*.*"],
    "minLines": 4,
    "minChars": 100
  }

Twly lit le fichier de configuration .trc . Ce fichier doit contenir un objet JSON. Par exemple, ci-dessous est un exemple de fichier .trc Si vous vouliez faire ce qui suit:

• Ignorez les fichiers spécifiques foo.txt et bar.txt ainsi que tous les contenus de votre répertoire Node_Modules
• Sortez avec un code d'état de 1 (défaillance) si moins de 89,5% des fichiers sont uniques
• Seulement des blocs de code qui ont au moins 7 lignes grandes avec un minimum de 200 caractères

  {
    "threshold": 89.5,
    "ignore": ["foo.txt", "bar.txt", "node_modules/**"],
    "minLines": 7,
    "minChars": 200
  }

Usage

Vous pouvez utiliser Twlly en exécutant simplement la commande twly . Cela analysera tous les fichiers et se reproduira en sous-répertoires dans votre répertoire de travail actuel par défaut. Vous pouvez également passer à Twlly un modèle glob ... si par exemple vous vouliez tous les fichiers JavaScript dans votre répertoire actuel et toutes les sous-répertoires: twly '**/*.js' . Cela analysera tous les fichiers CSS dans votre répertoire de travail actuel twly '*.css' .

Pour une liste des arguments CLI disponibles, exécutez la commande twly --help .

Voir le projet Node-GloB pour les options sur la façon de spécifier des fichiers.

Image docker

Un dockerfile est fourni. Il peut être utilisé comme tel:

 twly> docker build -t twly .
app> docker run --rm -t -v "$(pwd):/code" -w /code twly