twly

Twly?

Twly (произносится «полотенце-e»)-это статический инструмент анализа, который может помочь вам сохранить ваш код сухим (не повторяйте себя), сообщив вам, где у вас есть копирование и вставьте целые файлы или их части. Запустите Twly по каталогу, и Twly волшебным образом генерирует отчет для вас, указывающий, что было повторено и в каких файлах. Twly является языковым агностиком и может использоваться в любом текстовом документе.

Установка

npm install -g twly или для включения в какой -то проект npm install twly --save-dev

Конфигурация

Twly имеет некоторую конфигурацию по умолчанию, которая переводится в следующую объект конфигурации JSON

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

Twly читает файл config .trc . Этот файл должен содержать объект JSON. Например, ниже приведен пример файла .trc , если вы хотите сделать следующее:

• Игнорируйте конкретные файлы foo.txt и bar.txt, а также все содержимое в вашем каталоге Node_Modules
• Выход с кодом состояния 1 (сбой), если менее 89,5 процента файлов уникальны
• Только совместные блоки кода, которые имеют не менее 7 строк, большие с минимум 200 символов.

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

Использование

Вы можете использовать Twly, просто запустив команду twly . Это будет анализировать все файлы и повторно вступит в подкаталог в вашем текущем рабочем каталоге по умолчанию. Вы также можете передать Twly шаблон глобуса ... если, например, вы хотели все файлы JavaScript в вашем текущем каталоге и во всех подкаталогах: twly '**/*.js' . Это будет анализировать все файлы CSS в вашем текущем рабочем каталоге twly '*.css' .

Для списка доступных аргументов CLI запустите команду twly --help .

См. Проект Node-Glob для параметров, как указать файлы.

Docker Image

Dockerfile предоставлен. Это можно использовать так:

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