Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Typescript language module #1260

Merged
merged 26 commits into from
Sep 6, 2023
Merged

Add Typescript language module #1260

Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
712826a
Add Files for typescript
Kr0nox Jun 26, 2023
9d1ee88
Merge branch 'develop' into feature/ts-lang
Kr0nox Jul 2, 2023
97aa8cb
adjust to new system
Kr0nox Jul 3, 2023
9f4720a
Add Base Grammar files
Kr0nox Jul 3, 2023
e15eb63
Most language Features
Kr0nox Jul 11, 2023
8915983
Merge remote-tracking branch 'origin/develop' into feature/ts-lang
Kr0nox Jul 11, 2023
da95a26
Merge remote-tracking branch 'origin/develop' into feature/ts-lang
Kr0nox Jul 30, 2023
466fc4c
implemented all token types
Kr0nox Jul 30, 2023
65a4c79
Merge remote-tracking branch 'origin/develop' into feature/ts-lang
Kr0nox Aug 14, 2023
35774e4
Added strict option
Kr0nox Aug 14, 2023
20b71c6
js test
Kr0nox Aug 14, 2023
5dcb654
remove wildcard imports
Kr0nox Aug 14, 2023
ea840e3
register language in cli
Kr0nox Aug 15, 2023
3d26cfd
documentation
Kr0nox Aug 15, 2023
a1c3fc3
spottless
Kr0nox Aug 15, 2023
96b40a7
more documentation
Kr0nox Aug 23, 2023
6a1d216
Merge remote-tracking branch 'origin/develop' into feature/ts-lang
Kr0nox Aug 23, 2023
cb3c0fd
fix test skip
Kr0nox Aug 23, 2023
61e25d7
fix test
Kr0nox Aug 23, 2023
ec0c5f0
adjust version in readme
Kr0nox Sep 1, 2023
1708cb9
spotless
Kr0nox Sep 1, 2023
d795035
fix last codesmell
Kr0nox Sep 1, 2023
a364bfe
implement comments
Kr0nox Sep 5, 2023
c5f0c26
Merge branch 'develop' into feature/ts-lang
dfuchss Sep 5, 2023
d00ab7a
add revision version
Kr0nox Sep 5, 2023
97aefae
Merge branch 'develop' into feature/ts-lang
dfuchss Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -161,6 +162,7 @@ Commands:
scxml
swift
text
typescript
```

### Java API
Expand Down
5 changes: 5 additions & 0 deletions cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion cli/src/test/java/de/jplag/cli/LanguageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions coverage-report/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
12 changes: 12 additions & 0 deletions language-api/src/main/java/de/jplag/options/OptionType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand All @@ -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) {
Expand Down
1 change: 1 addition & 0 deletions languages/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
<module>scxml</module>
<module>swift</module>
<module>text</module>
<module>typescript</module>
<module>llvmir</module>
</modules>
<dependencies>
Expand Down
24 changes: 24 additions & 0 deletions languages/typescript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 Kotlin module, add the `-l typescript` flag 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).
Kr0nox marked this conversation as resolved.
Show resolved Hide resolved

#### 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>
40 changes: 40 additions & 0 deletions languages/typescript/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>4.4.0-SNAPSHOT</version>
Kr0nox marked this conversation as resolved.
Show resolved Hide resolved
<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>
Loading