chore: CheckStyle checks copyright notice header (#1197)

* chore: test copyright notice with Checkstyle CheckStyle has a directive RegexpHeader since checkstyle version 6.9. We can use it for check copyright notice in source header Signed-off-by: Hiroshi Miura <[email protected]> * style: fix copyright header Signed-off-by: Hiroshi Miura <[email protected]> * fix: remove CopyrightTest.java in aligner Signed-off-by: Hiroshi Miura <[email protected]> * fix: remove CopyrightTest.java in theme module Signed-off-by: Hiroshi Miura <[email protected]> * style: copyright headers in tests Signed-off-by: Hiroshi Miura <[email protected]> --------- Signed-off-by: Hiroshi Miura <[email protected]>
omegat-org · Nov 24, 2024 · 4a568b0 · 4a568b0
1 parent e383b05
commit 4a568b0
Show file tree

Hide file tree

Showing 99 changed files with 193 additions and 1,230 deletions.
diff --git a/aligner/src/main/java/org/omegat/gui/align/AlignerModule.java b/aligner/src/main/java/org/omegat/gui/align/AlignerModule.java
@@ -1,5 +1,4 @@
 /*
- *
  *  OmegaT - Computer Assisted Translation (CAT) tool
  *           with fuzzy matching, translation memory, keyword search,
  *           glossaries, and translation leveraging into updated projects.

diff --git a/aligner/src/test/java/org/omegat/gui/align/CopyrightTest.java b/aligner/src/test/java/org/omegat/gui/align/CopyrightTest.java
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -52,6 +52,18 @@
         <property name="file" value="${config_loc}/suppressions.xml"/>
     </module>
 
+    <module name="RegexpHeader">
+        <property name="headerFile" value="${config_loc}/java.header"/>
+        <property name="multiLines" value="6"/>
+        <property name="fileExtensions" value="java"/>
+    </module>
+
+    <module name="RegexpHeader">
+        <property name="headerFile" value="${config_loc}/properties.header"/>
+        <property name="multiLines" value="6"/>
+        <property name="fileExtensions" value="properties"/>
+    </module>
+
     <!-- Checks for Size Violations.                    -->
     <!-- See https://checkstyle.org/checks/sizes/index.html -->
     <module name="FileLength"/>

diff --git a/config/checkstyle/java.header b/config/checkstyle/java.header
@@ -0,0 +1,24 @@
+^/\*(\*{73,})?$
+OmegaT \- Computer Assisted Translation \(CAT\) tool$
+with fuzzy matching, translation memory, keyword search,$
+glossaries, and translation leveraging into updated projects.$
+^( \*)?$
+(Copyright \(C\)|\s{13}) \d\d\d\d((-|,)\d\d\d\d)? (\w+|\s|,)+
+Home page: https://www.omegat.org/
+Support center: https://omegat.org/support
+^( \*)?$
+This file is part of OmegaT.$
+^( \*)?$
+OmegaT is free software: you can redistribute it and/or modify$
+it under the terms of the GNU General Public License as published by$
+the Free Software Foundation, either version 3 of the License, or$
+\(at your option\) any later version.$
+^( \*)?$
+OmegaT is distributed in the hope that it will be useful,$
+but WITHOUT ANY WARRANTY; without even the implied warranty of$
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the$
+GNU General Public License for more details.$
+^( \*)?$
+You should have received a copy of the GNU General Public License$
+along with this program.  If not, see <https://www.gnu.org/licenses/>.$
+^\s?(\*{73,})?\*/$
diff --git a/config/checkstyle/properties.header b/config/checkstyle/properties.header
@@ -0,0 +1,24 @@
+^#(/?\*{75,})?$
+^# OmegaT \- Computer Assisted Translation \(CAT\) tool$
+^# with fuzzy matching, translation memory, keyword search,$
+^# glossaries, and translation leveraging into updated projects.$
+^#$
+^# (Copyright \(C\)|\s{13}) \d\d\d\d(-\d\d\d\d)? (\w+|\s|,)+
+^# Home page: https://www.omegat.org/
+^# Support center: https://omegat.org/support
+^#$
+^# This file is part of OmegaT.$
+^#$
+^# OmegaT is free software: you can redistribute it and/or modify$
+^# it under the terms of the GNU General Public License as published by$
+^# the Free Software Foundation, either version 3 of the License, or$
+^# \(at your option\) any later version.$
+^# ^( \*)?$
+^# OmegaT is distributed in the hope that it will be useful,$
+^# but WITHOUT ANY WARRANTY; without even the implied warranty of$
+^# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the$
+^# GNU General Public License for more details.$
+^#$
+^# You should have received a copy of the GNU General Public License$
+^# along with this program.  If not, see <https://www.gnu.org/licenses/>.$
+^#(\*{75,}/?)?$
diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml
@@ -31,6 +31,9 @@
 <suppressions>
 
     <!-- Permanently suppress errors/warnings -->
+
+    <!-- ignore -->
+    <suppress files="gen.core.*+" checks="RegexpHeader"/>
 
     <!-- tests -->
     <suppress files="TestCore\.java" checks="MethodLength"/>
@@ -161,7 +164,7 @@
     <suppress checks="(TypeName|MissingSwitchDefault)" files="srtFilter\.java" lines="55,102"/>
     <suppress checks="TypeName" files="XLIFFOptions\.java" lines="67"/>
     <suppress files="XHTMLDialect\.java" checks="InnerAssignment" lines="131,132"/>
-    <suppress files="CamtasiaWindowsDialect\.java" checks="MethodLength" lines="45"/>
+    <suppress files="CamtasiaWindowsDialect\.java" checks="MethodLength" lines="44"/>
     <suppress files="Entry\.java" checks="MethodLength"/>
     <suppress files="Handler\.java" checks="EmptyBlock" lines="857"/>
 

diff --git a/doc_src/build.xml b/doc_src/build.xml
@@ -1,13 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
-/**************************************************************************
- OmegaT - Java based Computer Assisted Translation (CAT) tool
+ OmegaT - Computer Assisted Translation (CAT) tool
+
  Copyright (C) 2011-2012 Didier Briel
                2014-2015 Didier Briel
                2019 Aaron Madlon-Kay
-
-               Home page: http://www.omegat.org/
+               Home page: https://www.omegat.org/
                Support center: https://omegat.org/support
 
  This file is part of OmegaT.
@@ -23,8 +21,7 @@
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
- along with this program.  If not, see <http://www.gnu.org/licenses/>.
-**************************************************************************/
+ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 -->
 <project name="OmegaT documentation" default="all">
 

diff --git a/...nslators/apertium/src/test/java/org/omegat/machinetranslators/apertium/CopyrightTest.java b/...nslators/apertium/src/test/java/org/omegat/machinetranslators/apertium/CopyrightTest.java