IntelliJ IDEA plugin for JBang

[linux-china]

I have created IntelliJ IDEA plugin for JBang, and now with following features:

• JDK list sync between IntelliJ IDEA and JBang: sync JDKs from JBang to IntelliJ IDEA
• JSON Schema for jbang-catalog.json: code completion to edit jbang-catalog.json

More requirements are welcome, then I can release 0.1.0 version.

[maxandersen]

Nice :) let me know if you want me to create a jbangdev/IntelliJ repo and make you commiter :) Upto you.

How about run/debug via jbang when you detect the ///... on first line ?

IntelliJ has support for shebang but I don't think it recognizes /// syntax.

Also content assist for //DEPS lines into maven dependencies would be nice. Similar for other // commands if possible.

[maxandersen]

p.s. I see your current code is kotlin; any objection we make that just .java so easier to contribute/maintain it ?

[linux-china]

@maxandersen the code is based on https://github.com/JetBrains/intellij-platform-plugin-template Now most JetBrains plugins are written by Kotlin, and plugin developers can find Kotlin examples from current Kotlin code base easily. Kolin is better for plugin developers, and Rust plugin is written by Kotlin totally. https://github.com/intellij-rust/intellij-rust/tree/master/src/main/kotlin

[quintesse]

Indeed, the IntelliJ eco-system uses a lot of Kotlin and is only going to become more so (they are the creators of Kotlin after all)

[quintesse]

Btw @linux-china , I'm not sure I understood your reason for saying code completion on DEPS lines is not needed, can you explain a bit more? I'm not sure what VS Code has to do with code completion in IntelliJ and GitHub codepilot it of course not used by everybody...

[linux-china]

yes, I will implement the code completion for DEPS, and it's normal requirement. I will do some research about code completion in Java comment.

[linux-china]

Run configuration support for JBang: run jbang script from IDE

[quintesse]

Btw I see you wrote:

Install
Preferences > Plugins > Marketplace > Search for "jbang" > Install Plugin > Restart IntelliJ IDEA

In the README. Should that work already? Or should we publish that plugin first? (Because searching for "jbang" doesn't give any results for me right now)

[linux-china]

I will release 0.1.0 version ASAP. Now you can try it by install from Disk.

The following features are not included in 0.1.0 version because of some hard.

• GAV completion for //DEPS
• Classpath setting for single Java file from //DEPS

jbang-intellij-plugin-0.1.0.zip

[linux-china]

@maxandersen @quintesse To be honest, English is not my first language, please correct README.md if spell error.

[maxandersen]

Where is it actually published/hosted from ?

[linux-china]

I have submitted the plugin to https://plugins.jetbrains.com/ It will be available to public after approved, and almost 2 days.

[linux-china]

Directive completion ready now, and I will do more research to implement GAV completion for //DEPS

[maxandersen]

how do you get these completions btw? I don't see them...

[linux-china]

I have uploaded the plugin to plugins.jetbrains.com. Xmas is coming, and I think JetBrains guys will have long holiday. Expect to get approved before Xmas. If some important bugs to the plugin, and I will release a new version ASAP.

The plugin url: https://plugins.jetbrains.com/plugin/18257-jbang

[linux-china]

I don't follow what you mean @linux-china ? To have multi modules you need to have multiple build files / folders don't you ?

Yes, it's hard to fix this problem in IDEA with multi JBang script files. Every script has different JAVA version and dependencies, and you should create a IDEA module for the script. But still ok, IDEA's module is same as SourceSet in Gradle, different SourceSet has different dependencies and language level. But don't worry, IDEA's module and Gradle SourceSet are very light.

I don't know it's good or not to ask the developers to group scripts together as SourceSet, and yes SourceSet is a folder.

[linux-china]

I opened issues on jbang-idea - the sync is very broken IMO. it doesn't seem to sync from build.gradle nor the .java file it simply just injects what is in the gradle dependency container and pushes that into your .java file. Which in majority of cases is not what you want.

Version 0.6.0 is better and still waiting for approval.

[maxandersen]

Im running using latest build 0.7 from main branch

[linux-china]

Some test cases here, and if not correct please correct me.

• Open JBang projedct with idea . without build.gradle: sync dependencies from //DEPS to IDEA's module, just one way
• jbang edit --open=idea HelloWorld.java: sync dependencies between //DEPS and build.gradle , translate implementation to //DEPS and reverse
• Gradle project with multi SourceSets: sync dependencies between //DEPS and build.gradle , translate xxxImplementation to //DEPS and reverse

Some issues:

• implementation platform('bom-here') can not work well and I'm working on it
• Refresh automatically: now you need click Gradle refresh button
• jbang.jar bundle can not work well because of classloader confliction

I'm working on a tool window for JBang, and display all information for script from jbang info tools src/HelloWorld.java and some info from gradle. If not correct and developers can click sync button again.

[maxandersen]

I would just do //DEPS to other Modules and make that work well. The reverse way from build.Gradle is lossy.

[linux-china]

High lighter for JBang directives. If not necessary, and I can disable the feature.

[maxandersen]

looks nice!

[nandorholozsnyak]

Any news on a new release? I'm able to build it from the code, just curious if there will be new updates in the plugins store as well.
On the other hand I know I should create an issue for that, but I am unable to run a JBang script within IDEA, when I click on the icon or just create a run config and try to run the specific file, the following error happens, this is what I see in the logs of IDEA:
Plugin version: 0.8.0
JBang version: 0.86.0

2022-01-08 13:38:53,086 [ 981711]   INFO - xecution.runners.ExecutionUtil - Error running 'RestEasyExample.java by JBang':<br>Cannot run program "jbang" (in directory "/home/nandi/EVCS/VCS/GIT/jbang-terraform-aws"): error=2, No such file or directory 
com.intellij.execution.process.ProcessNotCreatedException: Cannot run program "jbang" (in directory "/home/nandi/EVCS/VCS/GIT/jbang-terraform-aws"): error=2, No such file or directory
	at com.intellij.execution.configurations.GeneralCommandLine.createProcess(GeneralCommandLine.java:364)
	at com.intellij.execution.process.OSProcessHandler.startProcess(OSProcessHandler.java:94)
	at com.intellij.execution.process.OSProcessHandler.<init>(OSProcessHandler.java:46)
	at com.intellij.execution.process.KillableProcessHandler.<init>(KillableProcessHandler.java:41)
	at com.intellij.execution.process.ColoredProcessHandler.<init>(ColoredProcessHandler.java:23)
	at com.intellij.execution.process.ProcessHandlerFactoryImpl.createColoredProcessHandler(ProcessHandlerFactoryImpl.java:33)
	at dev.jbang.idea.run.JBangRunConfiguration$getState$1.startProcess(JBangRunConfiguration.kt:78)
	at com.intellij.execution.configurations.CommandLineState.execute(CommandLineState.java:61)
	at com.intellij.execution.runners.DefaultRunProgramRunner$execute$1.invoke(DefaultRunProgramRunner.kt:29)
	at com.intellij.execution.runners.DefaultRunProgramRunner$execute$1.invoke(DefaultRunProgramRunner.kt:12)
	at com.intellij.execution.impl.ExecutionManagerImpl$startRunProfile$1.invoke(ExecutionManagerImpl.kt:173)
	at com.intellij.execution.impl.ExecutionManagerImpl$startRunProfile$1.invoke(ExecutionManagerImpl.kt:72)
	at com.intellij.execution.impl.ExecutionManagerImpl$doStartRunProfile$startRunnable$1.run(ExecutionManagerImpl.kt:234)
	at com.intellij.openapi.application.TransactionGuardImpl.runWithWritingAllowed(TransactionGuardImpl.java:214)
	at com.intellij.openapi.application.TransactionGuardImpl.access$200(TransactionGuardImpl.java:21)
	at com.intellij.openapi.application.TransactionGuardImpl$2.run(TransactionGuardImpl.java:196)
	at com.intellij.openapi.application.impl.ApplicationImpl.runIntendedWriteActionOnCurrentThread(ApplicationImpl.java:805)
	at com.intellij.openapi.application.impl.ApplicationImpl.lambda$invokeLater$4(ApplicationImpl.java:348)
	at com.intellij.openapi.application.impl.FlushQueue.doRun(FlushQueue.java:82)
	at com.intellij.openapi.application.impl.FlushQueue.runNextEvent(FlushQueue.java:131)
	at com.intellij.openapi.application.impl.FlushQueue.flushNow(FlushQueue.java:47)
	at com.intellij.openapi.application.impl.FlushQueue$FlushNow.run(FlushQueue.java:187)
	at java.desktop/java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:313)
	at java.desktop/java.awt.EventQueue.dispatchEventImpl(EventQueue.java:776)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:727)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:721)
	at java.base/java.security.AccessController.doPrivileged(Native Method)
	at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:85)
	at java.desktop/java.awt.EventQueue.dispatchEvent(EventQueue.java:746)
	at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:891)
	at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:760)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$6(IdeEventQueue.java:447)
	at com.intellij.openapi.progress.impl.CoreProgressManager.computePrioritized(CoreProgressManager.java:818)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$7(IdeEventQueue.java:446)
	at com.intellij.openapi.application.impl.ApplicationImpl.runIntendedWriteActionOnCurrentThread(ApplicationImpl.java:805)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:492)
	at java.desktop/java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:203)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:124)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:113)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:109)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.desktop/java.awt.EventDispatchThread.run(EventDispatchThread.java:90)
Caused by: java.io.IOException: Cannot run program "jbang" (in directory "/home/nandi/EVCS/VCS/GIT/jbang-terraform-aws"): error=2, No such file or directory
	at java.base/java.lang.ProcessBuilder.start(ProcessBuilder.java:1128)
	at java.base/java.lang.ProcessBuilder.start(ProcessBuilder.java:1071)
	at com.intellij.execution.configurations.GeneralCommandLine.startProcess(GeneralCommandLine.java:440)
	at com.intellij.execution.configurations.GeneralCommandLine.createProcess(GeneralCommandLine.java:354)
	... 41 more
Caused by: java.io.IOException: error=2, No such file or directory
	at java.base/java.lang.ProcessImpl.forkAndExec(Native Method)
	at java.base/java.lang.ProcessImpl.<init>(ProcessImpl.java:340)
	at java.base/java.lang.ProcessImpl.start(ProcessImpl.java:271)
	at java.base/java.lang.ProcessBuilder.start(ProcessBuilder.java:1107)
	... 44 more

[maxandersen]

That's weird as the code actually looks exactly there. Can you open a bug on jbang-idea ?

[linux-china]

@nandorholozsnyak It is caused by jbang not in PATH. If you start the project by idea command, for example idea ., and it will work well.

val command = mutableListOf("jbang", "run")

I have fixed this problem to use jbang cmd full path, and new version will be released ASAP

[linux-china]

Because of long holiday, and version 0.7.0 is still waiting for approval and it's almost 2 weeks. I just uploaded new version of 0.8.0

[nandorholozsnyak]

Thank you. I should have checked my PATH. Will check the new version as soon as I can.

[nandorholozsnyak]

BTW, this issue for me is gone on both Windows and Linux (Pop OS) too. Thank you!
I'm at 0.10.0

[linux-china]

GAV completion finished in 0.11.0 version

[nandorholozsnyak]

Just tried it out, superb! Probably the most convenient feature! Congrats.

[maxandersen]

I don't get any auto completion - anything magic to type/press to have it show up ?

[nandorholozsnyak]

Did you update to 0.11.0? Of yes then start typing for example quarkus and it should show the possible dependencies. Or this is what I did at least.

[maxandersen]

Yes. I'm on 0.11 but nothing shows up :/

[maxandersen]

I'll try use it from latest source tomorrow.

[nandorholozsnyak]

Just a quick question, is there anybody whos IDEA also freezes on the Sync action? Is there any way to make it an async background task to sync the dependencies?
jbangdev/jbang-idea#19

[nandorholozsnyak]

Hey @linux-china are you planning to enable/add Debug button feature in the plugin?
Right now if I want to debug it I have to give the --debug flag to the run config and create a Remote JVM Debug config and run it after the JBang script run.

[linux-china]

@nandorholozsnyak Now you can use Debug supplied by IDE. After dependencies synced to IDEA's module, and you can run JBang scripts as normal Java app. Now I use this way to debug JBang scripts. My JBang app structure as following:

jbang-app
  - src
  - resources
  - tests
  - jbang-catalog.json

I can implement debug feature, but I don't how many people will like this feature, and maybe most developers like to debug JBang script as normal Java/Groovy/Kotlin script in IDEA.

[nandorholozsnyak]

Cool thank you. I mostly use/create Quarkus based apps and in these cases I have to override the main entry point, with the debug it maybe a bit easier, but that is fine. And on the other hand, would the Quarkus DEV mode work if I would use a main method entrypoint? It has to be triggered with the -Dquarkus.dev flag when running a jbang script.

[maxandersen]

Debug via jbang would be nice as right now debug via just java does not process //FILES.

Wonder if jbang could register as something to run before java run/debug kicks in ?