Разработать ESLint правило
- Документировать каждый property внутри всех interface`ов. В том числе для типов функций.
- Документировать функцию вне интерфейса. Иметь флаг, чтобы документирование требовалось только для экспортируемых функций.
- Для проверок ориентироваться на формат TSDoc.
- Если есть параметр в функции, а он не описан - показывать ошибку.
- Если нет @returns в комментарии к функции - показывать ошибку.
- В комментарии к функции после описания всегда требовать пустую строку (перед параметрами или @returns).
- Чтобы можно было отключить правило для конкретной строки или всего файла (не знаю, вшито это сразу в ESLint или нет).
- Если можно вшить в правило, чтобы не требовать документировать в определённых файлах по маске (например,
.styles.ts) - будет здорово. Если нет, то ок, overrides у ESLint достаточно.
Примеры как должно работать