https://github.com/exercism/kotlin-analyzer

https://github.com/exercism/kotlin-analyzer

community-contributions-paused exercism-analyzer exercism-tooling

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/exercism/kotlin-analyzer
• Owner: exercism
• Created: 2019-06-18T17:11:03.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T13:50:44.000Z (10 months ago)
• Last Synced: 2024-05-01T11:25:21.618Z (8 months ago)
• Topics: community-contributions-paused, exercism-analyzer, exercism-tooling
• Language: Kotlin
• Size: 98.6 KB
• Stars: 1
• Watchers: 9
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
KOTLIN ANALYZER

=

This is an auto-analyzer for Kotlin exercises on the exercism.io platform.

Build and make final executable

-

_Two way to build the project :_   

- Using gradle wrapper included  

```

./gradlew test installDist

```

- Using docker

```

docker build -t exercism/kotlin-analyzer .

```

It will : build classes and run test classes, then make the distribution (https://docs.gradle.org/current/userguide/distribution_plugin.html)

Run

-

In the `./build/install/kotlinanalyzer` directory, you will find a `bin/kotlinanalyzer` executable file and a `lib` folder with all dependencies. 

Simply execute `./build/install/kotlinanalyzer/bin/kotlinanalyzer` to run the application

(A `bin/analyze.sh` is include to match the Interface of auto-mentoring in exercism.io)

Add an exercise

-

In the package `io.exercism.analyzer.kotlin.exercice`, you'll find an abstract class `Exercise`. Just create a new package for the new exercise and create a new Kotlin class extended the `Exercise` abstract class. 

You only have to implement the rules overriding this function :  

`abstract fun applyRules(file: Node.File): Either`

If you're not aware with functional programming, I use [Arrow](https://arrow-kt.io/).

Don't forget to add unit tests