https://github.com/sya-ri/KGit

Kotlin Wrapper Library of JGit
https://github.com/sya-ri/KGit

git gradle jgit kgit kotlin kotlin-wrapper-library

Last synced: 8 days ago
JSON representation

Kotlin Wrapper Library of JGit

• Host: GitHub
• URL: https://github.com/sya-ri/KGit
• Owner: sya-ri
• License: epl-2.0
• Created: 2021-01-08T07:46:11.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-10T20:20:24.000Z (27 days ago)
• Last Synced: 2024-10-28T09:06:54.215Z (10 days ago)
• Topics: git, gradle, jgit, kgit, kotlin, kotlin-wrapper-library
• Language: Java
• Homepage:
• Size: 464 KB
• Stars: 29
• Watchers: 2
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KGit

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/sya-ri/KGit)](https://github.com/sya-ri/KGit/releases/latest)

[![maven-central](https://img.shields.io/maven-central/v/com.github.sya-ri/kgit)](https://search.maven.org/artifact/com.github.sya-ri/kgit)

[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)

KGit is Kotlin Wrapper Library of [JGit](https://eclipse.org/jgit).

- Null Safety Methods

- Command Settings Available Using Lambda Function (No Method Chain)

- Support JGit features: `7.0.0.202409031743-r`

## Examples

### Clone Repository

#### JGit

```kotlin

val git: Git = Git.cloneRepository()

                  .setURI("https://github.com/sya-ri/KGit")

                  .setTimeout(60)

                  .setProgressMonitor(TextProgressMonitor())

                  .call()

```

#### KGit

```kotlin

val git: KGit = KGit.cloneRepository {

    setURI("https://github.com/sya-ri/KGit")

    setTimeout(60)

    setProgressMonitor(TextProgressMonitor())

}

```

## Installation

> [!TIP]

>

> - KGit bundles `org.eclipse.jgit:org.eclipse.jgit`.

> - Install the jgit extension library if necessary.

### build.gradle

```groovy

repositories {

    mavenCentral()

}

dependencies {

    implementation 'com.github.sya-ri:kgit:1.1.0'

}

```

### build.gradle.kts

```kotlin

repositories {

    mavenCentral()

}

dependencies {

    implementation("com.github.sya-ri:kgit:1.1.0")

}

```

## Develop

### Git Commit

#### Before Commit

Run the gradle task to check the code format.

```

gradle lintKotlin

```

#### Template

```

: 

```

#### Type

- **feat**: A new feature

- **fix**: A bug fix

- **docs**: Documentation only changes

- **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)

- **refactor**: A code change that neither fixes a bug nor adds a feature

- **perf**: A code change that improves performance

- **test**: Adding missing or correcting existing tests

- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation