SolarQube Правила squid: S1451 Должны быть определены заголовки авторских прав и лицензий

Question

Весь анализ кода моего SonarQube Java-проекты не работают по этому правилу.

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

Существует один параметр:

headerFormat Ожидаемый заголовок авторских прав и лицензий (обычный текст)

Но нет примеров того, как это должно быть сконфигурировано. По умолчанию headerFormat пуст, и я не могу найти документацию по настройке этого правила.

Я предполагаю, что должно быть какое-то регулярное выражение или язык шаблона, который можно использовать?

Answer 1

squid:S1451 "Copyright and license headers should be defined" имеет два параметра:

1. headerFormat
2. isRegularExpression

В headerFormat вы определяете ожидается текст. Если вы установили isRegularExpression в true, тогда текст будет рассматриваться как регулярное выражение.

Если вы используете обычный текст, то вам нужно поставить полную лицензию, например:

/* 
* Maven Plugin Utils 
* http://www.gabrys.biz/projects/maven-plugin-utils/ 
* 
* Copyright (c) 2015 Adam Gabryś 
* 
* This file is licensed under the BSD 3-Clause (the "License"). 
* You may not use this file except in compliance with the License. 
* You may obtain a copy of the License at: 
* 
*  https://raw.githubusercontent.com/gabrysbiz/maven-plugin-utils/master/src/main/resources/license.txt 
*/ 

Если вы используете регулярное выражение, то вы можете пропустить некоторые детали, например:

^\/\*.+www\.gabrys\.biz\/projects\/.+Copyright \(c\) [0-9]{4}.+This file is licensed under the.+\(the "License"\)\..+You may not use this file except in compliance with the License\..+You may obtain a copy of the License at:.+$