twly

Twly?

Twly (ausgesprochen "Handtuch-e") ist ein statisches Analyse-Tool, mit dem Sie Ihren Code trocken halten können (wiederholen Sie sich nicht), indem Sie wissen, wo Sie Kopien und Einfügen von ganzen Dateien oder Teilen davon haben. Führen Sie Twly in einem Verzeichnis aus, und Twly generiert auf magische Weise einen Bericht für Sie, in dem Sie angeben, was wiederholt wurde und in welchen Dateien. Twly ist agnostisch Sprache und kann in jedem Textdokument verwendet werden.

Installation

npm install -g twly oder in ein Projekt einbeziehen npm install twly --save-dev

Konfiguration

Twly hat eine Standardkonfiguration, die sich in das folgende Konfigurations -JSON -Objekt übersetzt

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

Twly liest die Konfigurationsdatei .trc . Diese Datei sollte ein JSON -Objekt enthalten. Im Folgenden finden Sie beispielsweise eine Beispiel .trc -Datei, wenn Sie Folgendes ausführen möchten:

• Ignorieren Sie die spezifischen Dateien foo.txt und bar.txt sowie den gesamten Inhalt in Ihrem Verzeichnis node_modules
• Beenden Sie mit einem Statuscode von 1 (Fehler), wenn unter 89,5 Prozent der Dateien eindeutig sind
• Die Codeblöcke, die mit mindestens 7 Zeilen mit mindestens 200 Zeichen stehen, sind nur übereinstimmend

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

Verwendung

Sie können Twly verwenden, indem Sie einfach den Befehl twly ausführen. Dadurch werden alle Dateien analysiert und standardmäßig in Subdirektorien in Ihrem aktuellen Arbeitsverzeichnis aufgenommen. Sie können Twly auch ein Glob -Muster übergeben ... wenn Sie beispielsweise alle JavaScript -Dateien in Ihrem aktuellen Verzeichnis und alle Unterverzeichnisse wünschen: twly '**/*.js' . Dadurch wird alle CSS -Dateien in Ihrem aktuellen Arbeitsverzeichnis twly '*.css' analysiert.

Für eine Liste der verfügbaren CLI -Argumente führen Sie twly --help aus.

In dem Node-Glob-Projekt finden Sie Optionen zum Angeben von Dateien.

Docker -Bild

Eine Dockerfile wird bereitgestellt. Es kann so verwendet werden:

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