Port of work-in-progress patch to OmegaT into a plugin.

briacp · Mar 9, 2019 · 8984029 · 8984029
1 parent 3b0bf19
commit 8984029
Show file tree

Hide file tree

Showing 17 changed files with 1,735 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,7 @@ gradle-app.setting
 
 # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
 # gradle/wrapper/gradle-wrapper.properties
+/bin/
+.classpath
+.project
+.settings/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Add
+- foo
+- boo
+
+### Changed
+
+### Fixed
+
+[Unreleased]: https://github.com/miurahr/omegat-plugin-skelton/compare/v0.1...HEAD
diff --git a/COPYING b/COPYING
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# OMT OmegaT Package Plugin
+
+
+
+## Test report
+
+You will find a test results report at `build/reports/` and can show it with your favorite web browser.
+
+## Installation
+
+You can get a plugin jar file from zip/tgz distribution file.
+OmegaT plugin should be placed in `$HOME/.omegat/plugin` or `C:\Program Files\OmegaT\plugin`
+depending on your operating system.
+
+## License
+
+This project is distributed under the GNU general public license version 3 or later.
+
diff --git a/build.gradle b/build.gradle
@@ -0,0 +1,113 @@
+plugins {
+    id 'java'
+    id 'findbugs'
+    id 'checkstyle'
+    id 'distribution'
+    id 'maven'
+    id 'idea'
+}
+
+repositories {
+    maven {
+        url "https://dl.bintray.com/omegat-org/maven"
+    }
+    jcenter()
+}
+
+def compileDependencies = [
+        'org.omegat:omegat:4.1.3-02',
+        'commons-io:commons-io:2.4',
+        'commons-lang:commons-lang:2.6'
+]
+
+def testDependencies = [
+        'junit:junit:4.12',
+        'xmlunit:xmlunit:1.6',
+        'org.madlonkay.supertmxmerge:supertmxmerge:2.0.1'
+]
+
+dependencies {
+
+    compileDependencies.each {
+        compileOnly it
+        testImplementation it
+    }
+
+    testDependencies.each {
+        testImplementation it
+    }
+}
+
+
+tasks.withType(JavaCompile) {
+    options.compilerArgs << "-Xlint:deprecation" << "-Xlint:unchecked"
+}
+
+jar {
+    manifest {
+        // plugin's main class name is defined in gradle.properties file.
+        attributes(
+                "OmegaT-Plugins": pluginMainClass,
+                "Plugin-Version": pluginVersion,
+                "Plugin-Name": pluginName
+        )
+    }
+}
+
+/* Checkstyle */
+checkstyle {
+    config = resources.text.fromFile("${rootProject.projectDir}/config/checkstyle/checkstyle.xml")
+    ignoreFailures = true
+    toolVersion = '7.1'
+    sourceSets = [project.sourceSets.main]
+}
+tasks.checkstyleMain.setGroup('Verification')
+tasks.remove(tasks['checkstyleTest'])
+
+/* FindBugs */
+findbugs {
+    ignoreFailures = true
+    sourceSets = [project.sourceSets.main]
+}
+
+tasks.withType(FindBugs) {
+    setGroup('Verification')
+    reports {
+        xml.enabled = false
+        html.enabled = true
+    }
+}
+tasks.remove(tasks['findbugsTest'])
+
+artifacts {
+    archives jar
+}
+
+distTar {
+    compression = Compression.GZIP
+}
+
+distributions {
+    main {
+        contents {
+            from('README.md', 'COPYING')
+            into('docs') {
+                from 'CHANGELOG.md'
+            }
+
+            from(jar) {
+                into 'plugin'
+            }
+        }
+    }
+}
+
+task deployOmegaT(type: Copy) {
+
+        from 'build/install/plugin-omt-package/plugin'
+        into omegatDir
+        include('*.jar')
+
+}
+
+installDist.dependsOn deployOmegaT
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -0,0 +1,188 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+
+  Checkstyle configuration that checks the sun coding conventions from:
+
+    - the Java Language Specification at
+      http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+    - the Javadoc guidelines at
+      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+    - some best practices
+
+  Checkstyle is very configurable. Be sure to read the documentation at
+  http://checkstyle.sf.net (or in your downloaded distribution).
+
+  Most Checks are configurable, be sure to consult the documentation.
+
+  To completely disable a check, just comment it out or delete it from the file.
+
+  Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+    <property name="charset" value="UTF-8"/>
+
+    <property name="severity" value="warning"/>
+
+    <property name="fileExtensions" value="java, properties, xml"/>
+
+    <!-- Checks whether files end with a new line.                        -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- Checks that property files contain the same keys.         -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+    <module name="Translation"/>
+
+    <!-- Checks for Size Violations.                    -->
+    <!-- See http://checkstyle.sf.net/config_sizes.html -->
+    <module name="FileLength"/>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+    <module name="FileTabCharacter"/>
+
+    <!-- Miscellaneous other checks.                   -->
+    <!-- See http://checkstyle.sf.net/config_misc.html -->
+    <module name="RegexpSingleline">
+       <property name="format" value="\s+$"/>
+       <property name="minimum" value="0"/>
+       <property name="maximum" value="0"/>
+       <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+    <!-- Checks for Headers                                -->
+    <!-- See http://checkstyle.sf.net/config_header.html   -->
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/config/checkstyle/header.txt"/>
+        <property name="fileExtensions" value="java"/>
+    </module>
+
+    <module name="SuppressWarningsFilter" />
+    <module name="TreeWalker">
+
+        <module name="SuppressWarningsHolder" />
+
+        <!-- Checks for Javadoc comments.                     -->
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+        <module name="JavadocMethod">
+            <property name="scope" value="public"/>
+        </module>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable">
+            <property name="scope" value="public"/>
+        </module>
+        <module name="JavadocStyle"/>
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+        <!-- Checks for imports                              -->
+        <!-- See http://checkstyle.sf.net/config_import.html -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+        <module name="RedundantImport"/>
+        <module name="UnusedImports">
+            <property name="processJavadoc" value="false"/>
+        </module>
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->
+        <module name="LineLength">
+            <property name="max" value="100"/>
+        </module>
+
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+        <!-- Checks for whitespace                               -->
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+
+        <!-- Modifier Checks                                    -->
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+        <!-- Checks for common coding problems               -->
+        <!-- See http://checkstyle.sf.net/config_coding.html -->
+        <module name="AvoidInlineConditionals"/>
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="HiddenField" >
+          <property name="ignoreSetter" value="true" />
+          <property name="ignoreConstructorParameter" value="true" />
+        </module>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <!-- <module name="MagicNumber"/> -->
+        <module name="MissingSwitchDefault"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See http://checkstyle.sf.net/config_design.html -->
+        <!--
+        <module name="DesignForExtension"/>
+        -->
+        <module name="FinalClass"/>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier">
+          <property name="protectedAllowed" value="true" />
+        </module>
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See http://checkstyle.sf.net/config_misc.html -->
+        <module name="ArrayTypeStyle"/>
+        <module name="FinalParameters"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+    </module>
+
+</module>
diff --git a/config/checkstyle/header.txt b/config/checkstyle/header.txt
@@ -0,0 +1,25 @@
+/**************************************************************************
+ OmegaT - Computer Assisted Translation (CAT) tool
+          with fuzzy matching, translation memory, keyword search,
+          glossaries, and translation leveraging into updated projects.
+
+ Copyright (C) 2016 Hiroshi Miura
+               Home page: http://www.omegat.org/
+               Support center: http://groups.yahoo.com/group/OmegaT/
+
+ 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 <http://www.gnu.org/licenses/>.
+ **************************************************************************/
+
diff --git a/gradle.properties b/gradle.properties
@@ -0,0 +1,5 @@
+pluginMainClass=net.briac.omegat.plugin.omt.ManageOMTPackage
+pluginName=OMT Package Plugin
+pluginVersion=1.0
+
+omegatDir=C:/Users/briac/AppData/Roaming/OmegaT/plugins/
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,6 @@
+#Fri Mar 08 21:45:51 CET 2019
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip