https://github.com/lachlanmckee/revisit-alerts
Lint rules that alert developers when code needs to be revisited
https://github.com/lachlanmckee/revisit-alerts
Last synced: 7 months ago
JSON representation
Lint rules that alert developers when code needs to be revisited
- Host: GitHub
- URL: https://github.com/lachlanmckee/revisit-alerts
- Owner: LachlanMcKee
- License: apache-2.0
- Created: 2021-08-28T21:58:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-09T16:58:05.000Z (over 2 years ago)
- Last Synced: 2025-02-12T05:56:55.726Z (9 months ago)
- Language: Kotlin
- Size: 117 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Revisit Alerts
Provides a variety of 'revisit' annotations that alert developers (using lint rules) when code needs to be revisited.
## How to use
The annotations are used in the following ways:
### RevisitDate
The `Revisit.ByDate` annotation allows you to specify a date in the future when something should be revisited.
```kotlin
import com.lachlanmckee.revisit.Revisit
@Revisit.ByDate(day = 1, month = Revisit.Month.JANUARY, year = 3000, reason = "For testing purposes")
fun foo() {
}
```
### RevisitFromDate
The `Revisit.FromDate` annotation allows you to specify a date (typically the date which the annotation was added) and a number of days in the future when something should be revisited.
```kotlin
import com.lachlanmckee.revisit.Revisit
@Revisit.FromDate(day = 1, month = Revisit.Month.JANUARY, year = 2000, delay = Revisit.Delay.ONE_MONTH, reason = "For testing purposes")
fun foo() {
}
```
To see this in practice, please take a look at the [revisit-alerts-sample](revisit-alerts-sample) directory.
## Download
This library is available on Maven, you can add it to your project using the following gradle dependencies:
```gradle
implementation 'net.lachlanmckee.revisit:alerts:1.0.0'
```