Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexanderprendota/kotlin-samples-verifier
Kotlin documentation testing tool
https://github.com/alexanderprendota/kotlin-samples-verifier
Last synced: about 2 months ago
JSON representation
Kotlin documentation testing tool
- Host: GitHub
- URL: https://github.com/alexanderprendota/kotlin-samples-verifier
- Owner: AlexanderPrendota
- License: apache-2.0
- Created: 2020-03-10T09:14:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T16:41:54.000Z (2 months ago)
- Last Synced: 2024-10-24T14:28:21.109Z (about 2 months ago)
- Language: Kotlin
- Homepage:
- Size: 959 KB
- Stars: 6
- Watchers: 4
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kotlin samples verifier
Kotlin documentation testing tool.
A library that extracts embedded code snippets from HTML and Markdown files from a remote git repository, runs them and collects results.
# Setup
## Execution
Check and Collect send calls to [kotlin-compiler-server](https://github.com/AlexanderPrendota/kotlin-compiler-server) to execute code,
URL is passed as an argument to the factory create method and set to `http://localhost:8080/` by default.
Gradle tasks to run server using docker:
* Pull server docker image and start it as a docker container:
```shell
./gradlew dockerRun
```
* Stop and remove docker container:
```shell
./gradlew dockerStop dockerRemoveContainer
```
Also, the tool can collect snippets from the changes between two commits or two branches.
## Gradle
Maven Central:
```
dependencies {
...
implementation("io.github.alexanderprendota:kotlin-samples-verifier:1.1.4:1.1.0")
}
```
# Console Client
* Download Kotlin dependencies and build project:
```shell
./gradlew build -x test
./gradlew installDist
```
### Options:
| Name (alias) | Format | Description | Default |
| ------------- |:-------------:| :-----:|:-------------:|
|-snippet-flags (-f) | [String[,]] | Flags for code snippets, separated by \",\" like so: \"attr1,attr2\"| n/a |
|-ignore-attributes | [String[,]] | Attributes (name and value separated by \\\":\\\" (name:value)) for code snippets to ignore, separated by \\\",\\\" like so: \\\"attr1,attr2\\\" | null |
|-parse-directory | [String] | Regexp for directories to be processed | null |
|-ignore-directory | [String] | Regexp for directories to be ignored | null |
|-parse-tags | [String[,]] | Html tags to be accepted as code snippets, works for both html and md. Default (code) for MD so only fencedCodeBlocks are accepted as code snippets | null |
|-compiler-url | [String] | Kotlin compiler URL | `http://localhost:8080/` |
|-commits | [String [,String]] | Considering only the changed files between two arbitrary commits \"commit1,commit2\" or starting from \"commit1\" if \"commit2\" on one side is omitted | null |
|-file-type | [FileType] | MD or HTML (type of files to be processed) | MD |
|-kotlin-env | [KotlinEnv] | JS or JVM | JVM |
|-repository (-r) | [String] | Git repository URL with samples to execute| n/a |
|-tag-filter | [String] | User filter for tag containing snippet like so: (#tag=\"name\" & attr1=\"val\"). It also supports !, &, / operations | "" |
|-ignore-tag-filter | [String] | User filter for ignoring of tag including inners tags | "" |
#### Only for collect:
| Name (alias) | Format | Description | Default |
| ------------- |:-------------:| :-----:|:-------------:|
|-out (-o) | [String] | Filename to store results | n/a |
### Example:
```shell
./client/build/install/client/bin/client check -r https://github.com/AlexanderPrendota/kotlin-samples-verifier.git -f run-kotlin
```
# Usage Example
```kotlin
val samplesVerifier = SamplesVerifierFactory.create().configure {
snippetFlags = hashSetOf("run-kotlin")
ignoreAttributes = hashSetOf(Attribute("data-highlight-only", ""))
parseTags = hashSetOf("code", "div")
}
val repositoryURL = "https://github.com/AlexanderPrendota/kotlin-samples-verifier.git"
// log execution results
samplesVerifier.check(repositoryURL, "master", FileType.MD)
// get results as Map
val results = samplesVerifier.collect(repositoryURL, "master", FileType.MD)
// process files from list
val filenames = listOf(...)
val results2 = samplesVerifier.collect(filenames, FileType.MD)
```