Skip to content

Commit

Permalink
Merge pull request #131 from Peefy/kotlin-lib-tests-and-docs
Browse files Browse the repository at this point in the history
feat: add all suites and examples for kotlin API
  • Loading branch information
Peefy authored Aug 13, 2024
2 parents f538c97 + d99a53b commit b6193b5
Show file tree
Hide file tree
Showing 22 changed files with 1,012 additions and 13 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,36 @@ main();

### Kotlin

Refer to [this](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages) to configure your Maven; set up your GitHub account and Token in the `settings.xml`.

#### Maven

In your project's pom.xml, configure our repository as follows:

```xml
<repositories>
<repository>
<id>github</id>
<url>https://maven.pkg.github.com/kcl-lang/*</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
```

This way you'll be able to import the above dependency to use the SDK.

```xml
<dependency>
<groupId>com.kcl</groupId>
<artifactId>kcl-lib</artifactId>
<version>0.10.0-alpha.2-SNAPSHOT</version>
</dependency>
```

Write the code

```kotlin
import com.kcl.api.API
import com.kcl.api.execProgramArgs
Expand Down
5 changes: 1 addition & 4 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,9 @@ public class ExecProgramTest {
## Developing

- Install `Java 8+`
- Install `Maven`
- Install `cargo` and `Python` (for Rust code building)

```shell
pnpm install
```

### Building

```shell
Expand Down
2 changes: 1 addition & 1 deletion java/src/test/java/com/kcl/ListOptionsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

public class ListOptionsTest {
@Test
public void testParseProgram() throws Exception {
public void testListOptionsApi() throws Exception {
ParseProgram_Args args = ParseProgram_Args.newBuilder().addPaths("./src/test_data/option/main.k").build();

API apiInstance = new API();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import com.kcl.api.Spec.LoadSettingsFiles_Args;
import com.kcl.api.Spec.LoadSettingsFiles_Result;

public class LoadSettingsFileTest {
public class LoadSettingsFilesTest {
@Test
public void testLoadSettingsFile() throws Exception {
API api = new API();
Expand Down
2 changes: 1 addition & 1 deletion java/src/test/java/com/kcl/TestingTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

public class TestingTest {
@Test
public void testLintPathApi() throws Exception {
public void testTestingApi() throws Exception {
API apiInstance = new API();
Test_Args args = Test_Args.newBuilder().addPkgList("./src/test_data/testing/...").build();
Test_Result result = apiInstance.test(args);
Expand Down
Loading

0 comments on commit b6193b5

Please sign in to comment.