Here-Be-Dragons

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

Here-Be-Dragons

(★ 318)

An Intellij/Android Studio plugin to help visualise side effects in your code.

Here-Be-Dragons Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Deprecated
This project is no longer maintained. No new issues or pull requests will be accepted. You can still use the source or fork the project to suit your needs.

# Here Be Dragons
Here be dragons is an Intellij/Android Studio plugin that let's you annotate your impure Java methods with the `@SideEffect` annotation and shows a little dragon icon in the gutter when you call them.

![How the plugin works](https://raw.githubusercontent.com/anupcowkur/Here-Be-Dragons/master/here-be-dragons.gif)

# Why would I want to do this?
When writing functional style code, isolating impure and pure functions becomes very important. This helps you visually identify which methods are impure when a bunch of methods are being called in a code block.

For a beginner friendly introduction to functional programming in Android, please checkout out my [blog series](https://medium.freecodecamp.com/functional-programming-for-android-developers-part-1-a58d40d6e742#.z2eewm52o).

# Installation
## Install the plugin
[Download](https://github.com/anupcowkur/here-be-dragons/releases/download/v1.0.1/here-be-dragons-1.0.1.jar) the plugin jar and select "Install Plugin From Disk" in IntelliJ's plugin preferences.

## Add the annotation library
Add the jcenter repository to your gradle build file if it's not already present:

```groovy
repositories {
    jcenter()
}
```

Next, add the lib containing the `@SideEffect` annotation as a dependency:

```groovy
dependencies {
    compile 'com.anupcowkur:here-be-dragons-annotation:1.0.1'
}
```

# Usage
Simpy add the `@SideEffect` annotation to any method you want like this:

```java
import com.anupcowkur.herebedragons.SideEffect;

public class Test {
    @SideEffect
    public void foo() {
        // do some impure things
    }
}
```

And when you call the method anywhere, you'll see the dragon icon show up in the IDE gutter.

# License
This project is licensed under the [MIT License](https://github.com/anupcowkur/here-be-dragons/blob/master/License.txt)

Here-Be-Dragons

Here-Be-Dragons Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Here-Be-Dragons

Here-Be-Dragons Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README