https://github.com/zacsweers/auto-service-ksp

A KSP implementation of AutoService
https://github.com/zacsweers/auto-service-ksp

autoservice compiler-plugin kotlin kotlin-symbol-processing ksp

Last synced: 12 days ago
JSON representation

A KSP implementation of AutoService

• Host: GitHub
• URL: https://github.com/zacsweers/auto-service-ksp
• Owner: ZacSweers
• License: apache-2.0
• Created: 2020-09-26T07:04:54.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T21:08:28.000Z (15 days ago)
• Last Synced: 2024-10-24T09:13:04.288Z (15 days ago)
• Topics: autoservice, compiler-plugin, kotlin, kotlin-symbol-processing, ksp
• Language: Kotlin
• Homepage:
• Size: 468 KB
• Stars: 125
• Watchers: 4
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# auto-service-ksp

A [KSP](https://github.com/google/ksp) implementation of [AutoService](https://github.com/google/auto/tree/master/service).

## Usage

Simply add the auto-service-ksp Gradle Plugin.

[![Maven Central](https://img.shields.io/maven-central/v/dev.zacsweers.autoservice/auto-service-ksp.svg)](https://mvnrepository.com/artifact/dev.zacsweers.autoservice/auto-service-ksp)

```kotlin

plugins {

  id("com.google.devtools.ksp") version ""

  // ...

}

dependencies {

  ksp("dev.zacsweers.autoservice:auto-service-ksp:")

  // NOTE: It's important that you _don't_ use compileOnly here, as it will fail to resolve at compile-time otherwise

  implementation("com.google.auto.service:auto-service-annotations:")

}

```

Then annotate your service implementation with `@AutoService` as your normally would in source files.

## Caveats

While the AutoService _annotation processor_ will merge existing service files, but this is not

currently implemented in this KSP implementation yet.

## Advanced

You can customize behavior via KSP arguments. Currently there are two.

```kotlin

ksp {

  arg("autoserviceKsp.verify", "true")

  arg("autoserviceKsp.verbose", "true")

}

```

`autoserviceKsp.verify` enables extra validation to ensure that the annotated type does, in fact, implement the service

it claims to.

`autoserviceKsp.verbose` enables verbose logging.

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

License

--------

    Copyright 2020 Zac Sweers

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

[snap]: https://oss.sonatype.org/content/repositories/snapshots/dev/zacsweers/autoservice/