@necrobox/eslint-plugin-no-only-tests
v6.0.0
Published
Disallow the use of describe.only() and it.only()
Maintainers
Readme
@necrobox/eslint-plugin-no-only-tests
eslint-plugin-no-only-tests — это плагин ESLint, который проверяет наличие в файлах describe.only() и it.only(), и в случае их обнаружения показывает предупреждение.
Установка
Для начала необходимо установить ESLint:
$ npm i eslint --save-devДалее установить сам плагин:
$ npm install @necrobox/eslint-plugin-no-only-tests --save-devИспользование
Необходимо добавить @necrobox/eslint-plugin-no-only-tests в раздел plugins конфигурационного файла .eslintrc.
Можно опустить префикс eslint-plugin-:
{
"plugins": [
"@necrobox/no-only-tests"
]
}Далее настроить правило в разделе rules:
{
"rules": {
"@necrobox/no-only-tests/no-only": 2
}
}Мотивация
Когда разработчик отлаживает тесты локально, он может для упрощения процесса оставить включёнными только те из них,
которые сломаны. Удобнее всего это делать с помощью метода only в it и describe.
Однако, на CI нужно запускать все тесты.
Потому мы включаем в нашем ESLint-конфиге этот плагин, и он проверяет,
не используется ли метод only в файлах с тестами. А сам линтер запускаем с помощью прекоммит-хука,
тем самым блокируя возможность коммита в случае наличия only в кодовой базе.
