Требовать JSDoc на все функции с JSCS
Я использую JSCS для обеспечения согласованного стиля кода в одном из моих проектов.
Есть ли способ использовать JSCS, чтобы проверить, что каждая функция имеет JSDoc?
Что-то, что скажет, что это неверно:
var add = function(x, y) {
return x + y;
};
Но это действительно так:
/**
* Adds two numbers together
* @param {number} x
* @param {number} y
* @returns The sum of x and y
*/
var add = function(x, y) {
return x + y;
};
2 ответа
Решение
Похоже, jscs-jsdoc это делает! Он поставляется как плагин для JSCS, и вы можете включить в свой .jscsrc
:
"plugins": ["jscs-jsdoc"],
"jsDoc": {
"enforceExistence": true
}
Используя grunt, вы можете использовать grunt reg ex check.
Это позволяет запускать проверки на основе regEx для содержимого. Примером репозитория github является тестирование для console.log, но его можно использовать для поиска функции без комментариев jsdoc.
Не идеал, но сделал бы работу, доказывая, что RegEx на пустом месте