咨询IntelliJ自定义插件updatePlugins.xml完整元素及分类添加方法

Hey there! Let's break down how to add categories to your updatePlugins.xml, get the full list of supported elements, and ensure all metadata shows up before plugin download:

1. 添加插件分类 #

要给插件添加分类（这个分类会在IDE的插件仓库浏览器中，下载前就显示出来），直接在<plugin>节点内添加<category>元素即可。你可以使用IntelliJ的标准分类，比如Tools、Frameworks、Version Control，也可以自定义分类。下面是嵌入到你现有结构的示例：

<?xml version="1.0" encoding="UTF-8"?>
<plugins>
  <plugin id="com.yourcompany.yourplugin" 
          url="https://your-repo-url.com/your-plugin.jar" 
          version="1.0.0">
    <name>Your Custom Plugin</name>
    <description>插件的简短或详细描述</description>
    <change-notes>当前版本的更新内容</change-notes>
    <vendor email="your-email@domain.com" url="https://your-site.com">你的名称/公司</vendor>
    <!-- 添加分类 -->
    <category>Tools</category>
  </plugin>
</plugins>

2. updatePlugins.xml支持的完整元素列表 #

updatePlugins.xml遵循IntelliJ平台插件仓库的schema规范，以下是所有关键元素（带*标记的为必填项）：

• 必填元素：

  • id*：必须与插件plugin.xml中的id完全一致
  • url*：指向插件JAR文件的直接链接
  • version*：插件的语义化版本号
  • name*：插件的显示名称

• 可选但实用的元素：

  • description：插件概述（用<![CDATA[...]]>包裹可支持HTML格式）
  • change-notes：版本专属更新日志（同样支持CDATA包裹HTML）
  • vendor：厂商信息，包含邮箱和官网链接
  • category：插件分类，用于仓库浏览归类
  • since-build：支持的最低IntelliJ版本（比如221对应2022.1版本）
  • until-build：支持的最高IntelliJ版本（比如232.*对应2023.2及以下兼容版本）
  • tags：用于搜索的关键词标签，格式为<tags><tag>...</tag></tags>
  • depends：插件依赖，与plugin.xml中的depends条目对应
  • idea-version：另一种指定支持IDE版本的方式，格式为<idea-version since-build="221" until-build="232"/>

下面是包含所有常用元素的完整示例：

<?xml version="1.0" encoding="UTF-8"?>
<plugins>
  <plugin id="com.yourcompany.yourplugin" 
          url="https://your-repo.com/your-plugin-1.0.0.jar" 
          version="1.0.0">
    <name>我的自定义IntelliJ插件</name>
    <description><![CDATA[
      <p>一款提升开发效率的实用插件！</p>
      <p>核心功能：</p>
      <ul>
        <li>自动化重复任务</li>
        <li>自定义代码检查规则</li>
      </ul>
    ]]></description>
    <change-notes><![CDATA[
      <ul>
        <li>初始版本发布</li>
        <li>新增对2023.2版本IDE的支持</li>
      </ul>
    ]]></change-notes>
    <vendor email="support@yourcompany.com" url="https://yourcompany.com">你的公司</vendor>
    <category>Tools</category>
    <since-build>221</since-build>
    <until-build>232.*</until-build>
    <tags>
      <tag>productivity</tag>
      <tag>automation</tag>
    </tags>
    <depends>com.intellij.modules.platform</depends>
  </plugin>
</plugins>

3. 确保元数据在下载前展示的要点 #

要让所有插件信息在IDE仓库浏览器中下载前正常显示，请注意以下几点：

• 绝对不要依赖plugin.xml或build.gradle中的元数据来展示仓库信息——所有需要提前展示的内容（名称、描述、分类等）必须明确写在updatePlugins.xml中。
• 对于多行或HTML格式的内容（比如描述和更新日志），使用<![CDATA[...]]>包裹，确保IDE能正确渲染格式。
• 仔细核对id和version与插件JAR包、plugin.xml中的内容完全一致——不匹配会导致插件检测或安装出现问题。

内容的提问来源于stack exchange，提问作者n3mo