intellij-platform-gradle-plugin icon indicating copy to clipboard operation
intellij-platform-gradle-plugin copied to clipboard

Consider adjusting the plugin name: org.jetbrains.intellij has too broad meaning

Open vlsi opened this issue 3 years ago • 6 comments

The current plugin name is org.jetbrains.intellij, and it says literally nothing to the build script reader.

The rule of thumb is that an unprepared reader should understand what the build script is about. In other words:

plugins {
    `java-library` // <-- oh, this makes the project to be a java library
    `signing` // <-- this adds signing feature
    id("org.jetbrains.intellij") // ?? What features does it add?
}

There might be lots of Gradle plugins shared by IntelliJ team, and it would be sad if they all were named org.jetbrains.intellij.

Here are some ideas:

  • org.jetbrains.intellij-plugin
  • org.jetbrains.intellij-platform-plugin
  • org.jetbrains.jbr-download (JBR download might be useful on its own without adding all the rest tasks)

Note: multiple plugins can go in the very same jar, so the renaming is not really disruptive.

Here's a relevant Gradle documentation section: https://docs.gradle.org/current/userguide/designing_gradle_plugins.html#capabilities-vs-conventions I agree it might be hard to understand from the first read, so here's my issue to improve the doc :) https://github.com/gradle/gradle/issues/17198

vlsi avatar May 18 '21 11:05 vlsi

Sorry, we don't have a plan for changing the name.

hsz avatar Jun 30 '21 14:06 hsz

org.jetbrains.intellij looks like fine group for plugins

Like org.jetbrains.kotlin:

  • org.jetbrains.kotlin.js
  • org.jetbrains.kotlin.jvm

turansky avatar Mar 01 '22 20:03 turansky

on that basis perhaps org.jetbrains.intellij.sdk would be a better name

SingingBush avatar Jun 17 '22 07:06 SingingBush

The base name will be changed to IntelliJ Platform Gradle Plugin That could automatically lead to the ID change to org.jetbrains.intellij.platform

hsz avatar Feb 10 '23 09:02 hsz

Can this opportunity be used to rename the repo to intellij-platform-gradle-plugin (IPGP) like there is android-gradle-plugin, kotlin-gradle-plugin, sqldelight-gradle-plugin? Or maybe name the repo intellij-platform and have a module named gradle-plugin (to account for a future where there are multiple plugins?)

martinbonnin avatar Apr 24 '23 13:04 martinbonnin

Yes, the repository name can be adjusted as well. GitHub handles redirections nicely, so there won't be any issues here.

hsz avatar Apr 24 '23 14:04 hsz

As mentioned above, the 2.0 release introduces:

  • new name: IntelliJ Platform Gradle Plugin
  • new ID: org.jetbrains.intellij.platform
  • new repository name: https://github.com/JetBrains/intellij-platform-gradle-plugin

hsz avatar Mar 14 '24 13:03 hsz