Как убедиться, что у каждого исходного файла есть заголовок комментария, скрипт githook или npm? - PullRequest
0 голосов
/ 15 февраля 2019

В соответствии с требованиями законодательства нашего проекта каждый отдельный файл исходного кода должен иметь несколько строк вверху:

1 //// File: filename.js
2 //// Description: Blah blah blah
3 //// Copyright: Blah Blah Blah
4 //// Changes: Blah

Да, это избыточно с информацией об управлении версиями.У нас нет выбора, поэтому я бы хотел максимально автоматизировать его.Если в каких-либо файлах этого нет, то должно быть выдано предупреждение, как это делает линтер.

Я не вижу никаких правил ESLint для этого, но можно ли его добавить (через плагин?)

Мы используем create-реагировать-приложение, так как я понимаю, добавление правила lint возможно только в том случае, если мы извлечем, что нам не нужно делать.

Так что, возможно, лучшерешение будет через пользовательский Git-хук или пре-скрипт npm.Существует ли что-нибудь подобное?

Мне не удалось найти что-то конкретное для Node.js для принудительного применения комментариев заголовка.Единственное, что я смог найти при таком применении, было ответ о StyleCop для C # с неработающей ссылкой.

...