Merge branch 'develop' into report-viewer/simple-e2e

jplag · Sep 13, 2023 · 9a13500 · 9a13500
2 parents 28d09c3 + f144902
commit 9a13500
Show file tree

Hide file tree

Showing 44 changed files with 2,246 additions and 142 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -14,10 +14,10 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.0
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.SDQ_DEV_DEPLOY_TOKEN }}
-      - uses: actions/checkout@v3.5.0
+      - uses: actions/checkout@v4
         with:
           repository: ${{ github.repository }}.wiki
           path: wiki

diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up JDK
       uses: actions/setup-java@v3

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -7,7 +7,7 @@ jobs:
   publish-maven-central:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-java@v3
         with:
           java-version: '17'
@@ -17,7 +17,7 @@ jobs:
         with:
           servers: '[{ "id": "ossrh", "username": "jplag", "password": "${{ secrets.OSSRH_TOKEN }}" }]'
       - name: Import GPG key
-        uses: crazy-max/ghaction-import-gpg@v5
+        uses: crazy-max/ghaction-import-gpg@v6
         with:
           gpg_private_key: ${{ secrets.PGP_SECRET }}
           passphrase: ${{ secrets.PGP_PW }}
@@ -29,7 +29,7 @@ jobs:
   publish-release-artifact:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-java@v3
         with:
           java-version: '17'

diff --git a/.github/workflows/report-viewer-build-test.yml b/.github/workflows/report-viewer-build-test.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/report-viewer-dev.yml b/.github/workflows/report-viewer-dev.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/report-viewer-lint.yml b/.github/workflows/report-viewer-lint.yml
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/report-viewer-prettier.yml b/.github/workflows/report-viewer-prettier.yml
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/report-viewer-sonarcloud.yml b/.github/workflows/report-viewer-sonarcloud.yml
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.actor != 'dependabot[bot]' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - name: SonarCloud Scan

diff --git a/.github/workflows/report-viewer-unit.yml b/.github/workflows/report-viewer-unit.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/report-viewer.yml b/.github/workflows/report-viewer.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/sonarcloud-branch.yml b/.github/workflows/sonarcloud-branch.yml
@@ -21,7 +21,7 @@ jobs:
     if: ${{ github.actor != 'dependabot[bot]' }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - name: Set up JDK

diff --git a/.github/workflows/sonarcloud-pr.yml b/.github/workflows/sonarcloud-pr.yml
@@ -42,7 +42,7 @@ jobs:
     needs: get-info
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           repository: ${{ github.event.workflow_run.head_repository.full_name }}
           ref: ${{ github.event.workflow_run.head_branch }}

diff --git a/.github/workflows/spotless.yml b/.github/workflows/spotless.yml
@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up JDK
       uses: actions/setup-java@v3

diff --git a/README.md b/README.md
@@ -19,24 +19,25 @@ JPlag is a system that finds similarities among multiple sets of source code fil
 
 In the following, a list of all supported languages with their supported language version is provided. A language can be selected from the command line using subcommands (jplag [jplag options] <language name> [language options]). Alternatively you can use the legacy "-l" argument.
 
-| Language                                               | Version | CLI Argument Name | [state](https://github.com/jplag/JPlag/wiki/2.-Supported-Languages) |  parser   |
-|--------------------------------------------------------|--------:|-------------------|:-------------------------------------------------------------------:|:---------:|
-| [Java](https://www.java.com)                           |      17 | java              |                               mature                                |   JavaC   |
-| [C/C++](https://isocpp.org)                            |      11 | cpp               |                               legacy                                |  JavaCC   |
-| [C/C++](https://isocpp.org)                            |      14 | cpp2              |                                beta                                 |  ANTLR 4  |
-| [C#](https://docs.microsoft.com/en-us/dotnet/csharp/)  |       6 | csharp            |                                beta                                 |  ANTLR 4  |
-| [Go](https://go.dev)                                   |    1.17 | golang            |                                beta                                 |  ANTLR 4  |
-| [Kotlin](https://kotlinlang.org)                       |     1.3 | kotlin            |                                beta                                 |  ANTLR 4  |
-| [Python](https://www.python.org)                       |     3.6 | python3           |                               legacy                                |  ANTLR 4  |
-| [R](https://www.r-project.org/)                        |   3.5.0 | rlang             |                                beta                                 |  ANTLR 4  |
-| [Rust](https://www.rust-lang.org/)                     |  1.60.0 | rust              |                                beta                                 |  ANTLR 4  |
-| [Scala](https://www.scala-lang.org)                    |  2.13.8 | scala             |                                beta                                 | Scalameta |
-| [Scheme](http://www.scheme-reports.org)                |       ? | scheme            |                               unknown                               |  JavaCC   |
-| [Swift](https://www.swift.org)                         |     5.4 | swift             |                                beta                                 |  ANTLR 4  |
-| [EMF Metamodel](https://www.eclipse.org/modeling/emf/) |  2.25.0 | emf               |                                beta                                 |    EMF    |
-| [EMF Model](https://www.eclipse.org/modeling/emf/)     |  2.25.0 | emf-model         |                                alpha                                |    EMF    |
-| [LLVM IR](https://llvm.org)                            |      15 | llvmir            |                                beta                                 |  ANTLR 4  |
-| Text (naive)                                           |       - | text              |                               legacy                                |  CoreNLP  |
+| Language                                                   |                                                                                Version | CLI Argument Name | [state](https://github.com/jplag/JPlag/wiki/2.-Supported-Languages) |  parser   |
+|------------------------------------------------------------|---------------------------------------------------------------------------------------:|-------------------|:-------------------------------------------------------------------:|:---------:|
+| [Java](https://www.java.com)                               |                                                                                     17 | java              |                               mature                                |   JavaC   |
+| [C/C++](https://isocpp.org)                                |                                                                                     11 | cpp               |                               legacy                                |  JavaCC   |
+| [C/C++](https://isocpp.org)                                |                                                                                     14 | cpp2              |                                beta                                 |  ANTLR 4  |
+| [C#](https://docs.microsoft.com/en-us/dotnet/csharp/)      |                                                                                      6 | csharp            |                                beta                                 |  ANTLR 4  |
+| [Go](https://go.dev)                                       |                                                                                   1.17 | golang            |                                beta                                 |  ANTLR 4  |
+| [Kotlin](https://kotlinlang.org)                           |                                                                                    1.3 | kotlin            |                                beta                                 |  ANTLR 4  |
+| [Python](https://www.python.org)                           |                                                                                    3.6 | python3           |                               legacy                                |  ANTLR 4  |
+| [R](https://www.r-project.org/)                            |                                                                                  3.5.0 | rlang             |                                beta                                 |  ANTLR 4  |
+| [Rust](https://www.rust-lang.org/)                         |                                                                                 1.60.0 | rust              |                                beta                                 |  ANTLR 4  |
+| [Scala](https://www.scala-lang.org)                        |                                                                                 2.13.8 | scala             |                                beta                                 | Scalameta |
+| [Scheme](http://www.scheme-reports.org)                    |                                                                                      ? | scheme            |                               unknown                               |  JavaCC   |
+| [Swift](https://www.swift.org)                             |                                                                                    5.4 | swift             |                                beta                                 |  ANTLR 4  |
+| [EMF Metamodel](https://www.eclipse.org/modeling/emf/)     |                                                                                 2.25.0 | emf               |                                beta                                 |    EMF    |
+| [EMF Model](https://www.eclipse.org/modeling/emf/)         |                                                                                 2.25.0 | emf-model         |                                alpha                                |    EMF    |
+| [LLVM IR](https://llvm.org)                                |                                                                                     15 | llvmir            |                                beta                                 |  ANTLR 4  |
+| [TypeScript](https://www.typescriptlang.org/) / JavaScript | [~5](https://github.com/antlr/grammars-v4/tree/master/javascript/typescript/README.md) | typescript        |                                beta                                 |  ANTLR 4  |
+| Text (naive)                                               |                                                                                      - | text              |                               legacy                                |  CoreNLP  |
 
 ## Download and Installation
 You need Java SE 17 to run or build JPlag.
@@ -161,6 +162,7 @@ Commands:
   scxml
   swift
   text
+  typescript
 ```
 
 ### Java API

diff --git a/cli/pom.xml b/cli/pom.xml
@@ -102,6 +102,11 @@
             <artifactId>emf-model</artifactId>
             <version>${revision}</version>
         </dependency>
+        <dependency>
+            <groupId>de.jplag</groupId>
+            <artifactId>typescript</artifactId>
+            <version>${revision}</version>
+        </dependency>
         <dependency>
             <groupId>de.jplag</groupId>
             <artifactId>llvmir</artifactId>

diff --git a/cli/src/test/java/de/jplag/cli/LanguageTest.java b/cli/src/test/java/de/jplag/cli/LanguageTest.java
@@ -26,7 +26,7 @@ void testInvalidLanguage() {
     @Test
     void testLoading() {
         var languages = LanguageLoader.getAllAvailableLanguages();
-        assertEquals(17, languages.size(), "Loaded Languages: " + languages.keySet());
+        assertEquals(18, languages.size(), "Loaded Languages: " + languages.keySet());
     }
 
     @Test

diff --git a/coverage-report/pom.xml b/coverage-report/pom.xml
@@ -126,6 +126,11 @@
             <artifactId>emf-model</artifactId>
             <version>${revision}</version>
         </dependency>
+        <dependency>
+            <groupId>de.jplag</groupId>
+            <artifactId>typescript</artifactId>
+            <version>${revision}</version>
+        </dependency>
         <dependency>
             <groupId>de.jplag</groupId>
             <artifactId>llvmir</artifactId>

diff --git a/language-antlr-utils/pom.xml b/language-antlr-utils/pom.xml
@@ -14,7 +14,7 @@
         <dependency>
             <groupId>org.antlr</groupId>
             <artifactId>antlr4-runtime</artifactId>
-            <version>4.13.0</version>
+            <version>4.13.1</version>
         </dependency>
         <dependency>
             <groupId>de.jplag</groupId>

diff --git a/language-api/src/main/java/de/jplag/options/OptionType.java b/language-api/src/main/java/de/jplag/options/OptionType.java
@@ -21,6 +21,14 @@ private IntegerType() {
         }
     }
 
+    static final class BooleanType extends OptionType<Boolean> {
+        public static final BooleanType INSTANCE = new BooleanType();
+
+        private BooleanType() {
+            super(Boolean.class);
+        }
+    }
+
     public static StringType string() {
         return StringType.INSTANCE;
     }
@@ -29,6 +37,10 @@ public static IntegerType integer() {
         return IntegerType.INSTANCE;
     }
 
+    public static BooleanType bool() {
+        return BooleanType.INSTANCE;
+    }
+
     private final Class<T> javaType;
 
     private OptionType(Class<T> javaType) {

diff --git a/languages/pom.xml b/languages/pom.xml
@@ -26,6 +26,7 @@
         <module>scxml</module>
         <module>swift</module>
         <module>text</module>
+        <module>typescript</module>
         <module>llvmir</module>
     </modules>
     <dependencies>

diff --git a/languages/scala/pom.xml b/languages/scala/pom.xml
@@ -10,7 +10,7 @@
     <artifactId>scala</artifactId>
 
     <properties>
-        <scala.version>2.13.11</scala.version>
+        <scala.version>2.13.12</scala.version>
         <scala.compat.version>2.13</scala.compat.version>
     </properties>
 
@@ -25,7 +25,7 @@
         <dependency>
             <groupId>org.scalameta</groupId>
             <artifactId>scalameta_${scala.compat.version}</artifactId>
-            <version>4.8.9</version>
+            <version>4.8.10</version>
         </dependency>
     </dependencies>
 

diff --git a/languages/typescript/README.md b/languages/typescript/README.md
@@ -0,0 +1,24 @@
+# JPlag TypeScript language module
+Due to TypeScript being a superset of JavaScript this frontend can also parse JavaScript files.
+<br>
+The JPlag TypeScript module allows the use of JPlag with submissions in TypeScript. <br>
+It is based on the [TypeScript ANTLR4 grammar](https://github.com/antlr/grammars-v4/tree/master/javascript/typescript), licensed under the Apache 2.0.
+
+
+### TypeScript specification compatibility
+> This TypeScript grammar does not exactly correspond to the TypeScript standard. The main goal during developing was practical usage, performance, and clarity (getting rid of duplicates).
+
+Since the grammar has no support for decorators the version can be estimated < 5.0. The grammar can still parse files with decorators, but can not extract a tokens for them.
+<br> The grammar can parse multiple language features from version 4.x.
+<br> Because of this the version is still given as an estimated v5.
+
+If there are any major updates or fixes to the grammar<a href="#footnote-1"><sup>1</sup></a>, they should surely be applied to this module as well.
+
+### Token Extraction
+The choice of tokens is intended to be similar to the Java or Python modules. It includes a range of nesting structures (class, method, control flow expressions) as well as variable declaration, object creation and assignment.
+
+### Usage
+To use the TypeScript module, use the `typescript` subcommand in the CLI, or use a `JPlagOption` object with `new de.jplag.typescript.TypeScriptLanguage()` as `language` in the Java API as described in the usage information in the [readme of the main project](https://github.com/jplag/JPlag#usage) and [in the wiki](https://github.com/jplag/JPlag/wiki/1.-How-to-Use-JPlag).
+
+#### Footnotes
+<section id="footnote-1"><sup>1 </sup>The grammar files are taken from grammar-v4, with the most recent modification in <a href="https://github.com/antlr/grammars-v4/commit/764afe99457c07ae81ac07ed3a351a96fb5330d8">commit 768b12e</a> from March 2023.</section>
diff --git a/languages/typescript/pom.xml b/languages/typescript/pom.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>de.jplag</groupId>
+        <artifactId>languages</artifactId>
+        <version>${revision}</version>
+    </parent>
+    <artifactId>typescript</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.antlr</groupId>
+            <artifactId>antlr4-runtime</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>de.jplag</groupId>
+            <artifactId>language-antlr-utils</artifactId>
+            <version>${revision}</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.antlr</groupId>
+                <artifactId>antlr4-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>antlr4</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>