Как сделать так, чтобы Стамбул генерировал покрытие для всего моего исходного кода?

Нашел ответ, думаю, мне отчасти повезло, что выбранная мной структура каталогов позволяет использовать эту опцию, но теперь моя тестовая команда:

$ istanbul --include-all-sources cover _mocha -- -R dot --recursive test/

--include-all-sources является важной частью.

Стамбул рекомендует использовать nyc для проверки охвата кода. Он предлагает такой подход:

nyc mocha

После запуска этой команды мы получим отчет о покрытии. Но есть пара подводных камней.

Во-первых, по умолчанию mocha ищет тесты в папке test. Чтобы переопределить его, мы должны установить собственный путь в файле mocha.opts следующим образом:

nyc mocha --opts ./mocha.opts

А mocha.opts содержит такой код, например:

spec/unit/back-end/**/*.spec.js

Другая проблема в том, что по умолчанию nyc проверяет покрытие только необходимых файлов, о чем ваш вопрос. Решение состоит в том, чтобы установить два параметра для nyc (я запускаю тест как скрипт npm, поэтому я устанавливаю параметры в package.json). Вот код:

"nyc": {
  "all": true,
  "include": [
    "routes/*.js",
    "routes/**/*.js",
    "models/*.js"
  ]
},
"scripts": {
  "mocha": "nyc mocha --opts ./mocha.opts",
}

Еще один способ добиться этого — установить не include, а exclude опцию, чтобы исключить из проверки покрытия неподходящие файлы. Странно, но единственный вариант all не работает, нужны include или exclude варианты. Вы можете получить больше информации о nyc опциях через nyc --help.

P.S. Я не знаю nyc и mocha глубоко и основываюсь только на собственном опыте.

Для создания покрытия для всех файлов добавьте в свой package.json следующее:

"istanbulCoverage": "nyc --reporter=lcov --reporter=text-lcov --all -x \"./node_modules/\" -x \"./coverage/\ " check-coverage --functions 90 npm run test"

Здесь флаг --all выбирает все файлы в вашем проекте. Если вы хотите исключить определенные файлы или папки, вы можете использовать опцию -x.

Кроме того, если вы хотите указать уровень покрытия для своего приложения, используйте параметр check-coverage, чтобы указать пороговое значение. В моем случае я указал функции с порогом покрытия 90%. В противном случае генерация отчета о покрытии завершится ошибкой (я запускаю тест на карму после создания отчета о покрытии).

Надеюсь, это помогло :)

В моем случае --include-all-sources у меня не сработало. Файлы, которые не были require-d, по-прежнему исключались из окончательного отчета о покрытии.

В конце концов я наткнулся на эту проблему на istanbul GitHub, где сопровождающий заявил:

Да, это ожидаемое поведение. istanbul работает путем перехвата запроса, поэтому, если файл никогда не требуется, он как будто не существует.

Единственным надежным решением, которое я нашел, было вручную require все файлы, которые я хотел включить в свой отчет о покрытии. Я создаю файл include-all.test.js вместе с другими тестовыми сценариями и добавляю следующий фрагмент кода:

var glob = require( 'glob' )
var path = require( 'path' );

glob.sync( './path/to/js/code/*.js' ).forEach( function( file ) {
    // we don't care about errors here, we just want to require the file
    try {
        require( path.resolve( file ) );
    } catch(e) {}
});

Это гарантирует, что ваши непроверенные файлы будут включены в отчет о покрытии istanbul.