clj4intellij

Library for create IntelliJ plugins with Clojure.

How to use it?

Configure clojurephant first:

build.gradle.kts

plugins {
    ...
    id("dev.clojurephant.clojure") version "VERSION"
}
clojure.builds.named("main") {
    classpath.from(sourceSets.main.get().runtimeClasspath.asPath)
    checkAll()
    aotAll()
    reflection.set("fail")
}

Add clj4intellij as dependency:

build.gradle.kts

repositories {
    ...
    maven {
        name = "Clojars"
        url = uri("https://repo.clojars.org")
    }
}
dependencies {
    ...
    implementation ("com.github.ericdallo:clj4intellij:VERSION")
}

Add an application listener that will change the classloader on IntelliJ startup to load your plugin Clojure code:

src/main/resources/META-INF/plugin.xml

<applicationListeners>
    <listener topic="com.intellij.ide.AppLifecycleListener"
              class="com.github.ericdallo.clj4intellij.listener.ClojureClassLoaderListener"/>
</applicationListeners>

Now you can create clojure namespaces in your sourcepath (ex src/main/clojure), use clj4intellij helpers to create extensions like def-extension or implement yourself extensions using Clojure's gen-class.

Repl support

Add this extension and after startup a random port will be logged in IntelliJ's log, then you can connect from any editor to that port to development:

src/main/resources/META-INF/plugin.xml

<extensions defaultExtensionNs="com.intellij">
    <postStartupActivity implementation="com.github.ericdallo.clj4intellij.extension.NREPLStartup"/>
</extensions>

You can specify a port to always be used in the clj4intellij config file:

src/main/resources/META-INF/clj4intellij.edn

{:nrepl {:port 9876}}

Logging

There is the com.github.ericdallo.clj4intellij.logger ns which can be used to log messages to intelliJ's log via Clojure.

How it works?

This plugin has classes required to make possible code in Clojure a Intellij plugin changing the classloader at IntelliJ's startup.

Also contains useful functions for a more Clojure idiomatic development avoid the directly use of java or Intellij API.

For more information about plugin development, read the IntelliJ Plugin development guide.

Useful namespaces

• com.github.ericdallo.clj4intellij.app-manager to handle Application calls.
• com.github.ericdallo.clj4intellij.action to register actions dynamically.

Plugins using clj4intellij

• clojure-lsp-intellij
• clojure-repl-intellij

Support

Consider support the work of this project here ❤️