project-checks

// Как использовать

const compareBin = '/usr/bin/compare'; // Путь к cli-утилите compare

// Передаём путь к compare
const projectChecks = require('@htmlacademy/project-checks')(compareBin);

// Сравниваем проект и эталон:

projectChecks(
  'file:///tmp/project/origin/index.html', // Эталонный документ
  'file:///tmp/project/234511/index.html', // Документ студента
  '/tmp/project/234511/result',            // Куда сохранять промежуточные результаты
  {
    blocks: [
      {number: 2}, {number: 3}, {number: 4}
    ],
    full: false,                           // true, если нужно отрисовать весь документ
    checks: ['markup', 'layout']           // Массив строк, типов отрисовки. Допустимые значения: 'markup', 'layout', 'style'
  }
).then((result) => {
  // Обрабатываем полученные результаты
  // Это должен быть массив, каждая строка которого имеет поля:
  //   block - номер блока
  //   check - тип отрисовки
  //   file - имя файла в каталоге compare
  //   result - оценка в процентах
  //   width - ширина картинки
  //   height - высота картинки
});