hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-29 17:57:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

"Plugin Repository" -> "JetBrains Marketplace"

Browse Source
This commit is contained in:
Yann Cébron 2022-01-06 13:41:37 +01:00
parent 6e40e60173
commit 3ad26427fb
8 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/basics/getting_started.md
View File

@ -1,6 +1,6 @@
[//]: # (title: Creating Your First Plugin) [//]: # (title: Creating Your First Plugin)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
This documentation section will help you get started with developing plugins for the IntelliJ Platform. This documentation section will help you get started with developing plugins for the IntelliJ Platform.
You can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/) as your IDE (it is highly recommended to use the latest available version). You can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/) as your IDE (it is highly recommended to use the latest available version).
@ -25,9 +25,9 @@ Specific to development of IntelliJ Platform plugins with the Gradle plugin for
* Switching the version of the target IntelliJ Platform (IDE), * Switching the version of the target IntelliJ Platform (IDE),
* Changing the target IntelliJ Platform-based IDE, e.g., from IntelliJ IDEA to PyCharm, * Changing the target IntelliJ Platform-based IDE, e.g., from IntelliJ IDEA to PyCharm,
* Running a plugin against alternate versions of the JetBrains runtime. * Running a plugin against alternate versions of the JetBrains runtime.
* Gradle is fully integrated with Continuous Integration systems and [JetBrains Plugin Repository](https://plugins.jetbrains.com), so it is easy to customize and extend the build and publishing processes. * Gradle is fully integrated with Continuous Integration systems and [JetBrains Marketplace](https://plugins.jetbrains.com), so it is easy to customize and extend the build and publishing processes.
* Built-in verification task for <path>plugin.xml</path> and plugin distribution structure. * Built-in verification task for <path>plugin.xml</path> and plugin distribution structure.
* Built-in integration with [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) tool used for running the compatibility checks as performed on [JetBrains Plugin Repository](https://plugins.jetbrains.com). * Built-in integration with [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) tool used for running the compatibility checks as performed on [JetBrains Marketplace](https://plugins.jetbrains.com).
## Using GitHub Template ## Using GitHub Template

6
topics/basics/getting_started/plugin_compatibility.md
View File

@ -1,6 +1,6 @@
[//]: # (title: Plugin Compatibility with IntelliJ Platform Products) [//]: # (title: Plugin Compatibility with IntelliJ Platform Products)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
## Introduction ## Introduction
All products based on the IntelliJ Platform are built on the same underlying API. All products based on the IntelliJ Platform are built on the same underlying API.
@ -147,8 +147,8 @@ For [Gradle-based](gradle_build_system.md) projects, [Plugin Verifier](api_chang
For [DevKit-based](using_dev_kit.md) projects, create an SDK pointing to an installation of the intended target IntelliJ Platform-based product, e.g., PhpStorm, rather than IntelliJ IDEA. For [DevKit-based](using_dev_kit.md) projects, create an SDK pointing to an installation of the intended target IntelliJ Platform-based product, e.g., PhpStorm, rather than IntelliJ IDEA.
Use the same development version of the IntelliJ platform as the targeted product. Use the same development version of the IntelliJ platform as the targeted product.
Based on the tables above, the [JetBrains Plugins Repository](https://plugins.jetbrains.com/) automatically detects the JetBrains products with which a plugin is compatible, and makes the compatibility information available to plugin authors. Based on the tables above, the [JetBrains Marketplace](https://plugins.jetbrains.com/) automatically detects the JetBrains products with which a plugin is compatible, and makes the compatibility information available to plugin authors.
The compatibility information determines if plugins are available at the plugin repository to users of a particular JetBrains product. The compatibility information determines if plugins are available for users of a particular JetBrains product.
## Platform API Version Compatibility ## Platform API Version Compatibility
The API of IntelliJ Platform and bundled plugins may change between releases. The API of IntelliJ Platform and bundled plugins may change between releases.

10
topics/basics/getting_started/publishing_plugin.md
View File

@ -1,9 +1,9 @@
[//]: # (title: Publishing a Plugin) [//]: # (title: Publishing a Plugin)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
When your plugin is ready, you can publish it to a plugin repository so that other users can install it. When your plugin is ready, you can publish it to a plugin repository so that other users can install it.
You can choose to publish it on the [JetBrains Plugins Repository](https://plugins.jetbrains.com) or a [custom plugin repository](update_plugins_format.md). You can choose to publish it on the [JetBrains Marketplace](https://plugins.jetbrains.com) or a [custom plugin repository](update_plugins_format.md).
> Please see [Marketing](marketing.md) for remarks on how to prepare your plugin for optimal presentation. > Please see [Marketing](marketing.md) for remarks on how to prepare your plugin for optimal presentation.
> >
@ -12,8 +12,8 @@ You can choose to publish it on the [JetBrains Plugins Repository](https://plugi
Before publishing your plugin, make sure it is signed. Before publishing your plugin, make sure it is signed.
For more details on generating a proper certificate and configuring the signing process, check the [Plugin Signing](plugin_signing.md) article. For more details on generating a proper certificate and configuring the signing process, check the [Plugin Signing](plugin_signing.md) article.
## Publishing to the JetBrains Plugins Repository ## Publishing to JetBrains Marketplace
To upload your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com), you must log in with your personal JetBrains Account. To upload your plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com), you must log in with your personal JetBrains Account.
**To get your JetBrains account:** **To get your JetBrains account:**
@ -31,4 +31,4 @@ To upload your plugin to the [JetBrains Plugins Repository](https://plugins.jetb
New versions can be uploaded on the plugin's detail page, see [Marketplace Docs](https://plugins.jetbrains.com/docs/marketplace/custom-release-channels.html) for details. New versions can be uploaded on the plugin's detail page, see [Marketplace Docs](https://plugins.jetbrains.com/docs/marketplace/custom-release-channels.html) for details.
## Publishing a Plugin to a Custom Plugin Repository ## Publishing a Plugin to a Custom Plugin Repository
If you plan to publish your plugin to a repository _other than_ the [JetBrains Plugins Repository](https://plugins.jetbrains.com), please refer to the [Publishing to Custom Plugin Repositories](update_plugins_format.md) documentation. If you plan to publish your plugin to a repository _other than_ the [JetBrains Marketplace](https://plugins.jetbrains.com), please refer to the [Publishing to Custom Plugin Repositories](update_plugins_format.md) documentation.

4
topics/basics/getting_started/update_plugins_format.md
View File

@ -1,8 +1,8 @@
[//]: # (title: Publishing a Plugin to a Custom Plugin Repository) [//]: # (title: Publishing a Plugin to a Custom Plugin Repository)
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
If you intend to use a plugin repository _other than_ the [JetBrains Plugins Repository](https://plugins.jetbrains.com), you will need to: If you intend to use a plugin repository _other than_ the [JetBrains Marketplace](https://plugins.jetbrains.com), you will need to:
* Create and maintain an `updatePlugins.xml` file on the HTTPS web server you are using for your custom repository. * Create and maintain an `updatePlugins.xml` file on the HTTPS web server you are using for your custom repository.
This file describes all the plugins available in your custom repository and each plugin's download URL. This file describes all the plugins available in your custom repository and each plugin's download URL.
* Upload your plugin JAR/ZIP file to an HTTPS web server. * Upload your plugin JAR/ZIP file to an HTTPS web server.

4
topics/intro/intellij_platform.md
View File

@ -1,6 +1,6 @@
[//]: # (title: The IntelliJ Platform) [//]: # (title: The IntelliJ Platform)
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
The IntelliJ Platform is not a product in and of itself but provides a platform for building IDEs. The IntelliJ Platform is not a product in and of itself but provides a platform for building IDEs.
It is used to power JetBrains products such as [IntelliJ IDEA](https://www.jetbrains.com/idea/). It is used to power JetBrains products such as [IntelliJ IDEA](https://www.jetbrains.com/idea/).
@ -24,7 +24,7 @@ The IntelliJ Platform includes parsers and a PSI model for many languages, and i
## Plugins ## Plugins
Products built on the IntelliJ Platform are extensible applications, with the platform being responsible for creating components and the injection of dependencies into classes. Products built on the IntelliJ Platform are extensible applications, with the platform being responsible for creating components and the injection of dependencies into classes.
The IntelliJ Platform fully supports plugins, and JetBrains hosts the [JetBrains Plugin Repository](https://plugins.jetbrains.com) can be used to distribute plugins that support one or more of the products. The IntelliJ Platform fully supports plugins, and JetBrains hosts the [JetBrains Marketplace](https://plugins.jetbrains.com) can be used to distribute plugins that support one or more of the products.
It is also possible to distribute plugins using [Custom Plugin Repositories](update_plugins_format.md). It is also possible to distribute plugins using [Custom Plugin Repositories](update_plugins_format.md).
Plugins can extend the platform in many ways, from adding a simple menu item to adding support for a complete language, build system, and debugger. Plugins can extend the platform in many ways, from adding a simple menu item to adding support for a complete language, build system, and debugger.

4
topics/products/android_studio.md
View File

@ -1,12 +1,12 @@
[//]: # (title: Android Studio Plugin Development) [//]: # (title: Android Studio Plugin Development)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
## Introduction ## Introduction
Android Studio plugins extend or add functionality to the [Android Studio IDE](https://developer.android.com/studio). Android Studio plugins extend or add functionality to the [Android Studio IDE](https://developer.android.com/studio).
Plugins can be written in Kotlin or Java, or a mix of both, and are created using IntelliJ IDEA and the [IntelliJ Platform](intellij_platform.md). Plugins can be written in Kotlin or Java, or a mix of both, and are created using IntelliJ IDEA and the [IntelliJ Platform](intellij_platform.md).
It's also helpful to be familiar with [Java Swing](https://docs.oracle.com/javase/8/javase-clienttechnologies.htm). It's also helpful to be familiar with [Java Swing](https://docs.oracle.com/javase/8/javase-clienttechnologies.htm).
Once completed, plugins can be packaged and distributed at [JetBrains Plugin Repository](https://plugins.jetbrains.com). Once completed, plugins can be packaged and distributed at [JetBrains Marketplace](https://plugins.jetbrains.com).
Android Studio plugins are not Android modules or apps to run in the Android operating system, such as smartphones or tablets. Android Studio plugins are not Android modules or apps to run in the Android operating system, such as smartphones or tablets.

4
topics/products/dev_alternate_products.md
View File

@ -1,12 +1,12 @@
[//]: # (title: Plugins Targeting IntelliJ Platform-Based IDEs) [//]: # (title: Plugins Targeting IntelliJ Platform-Based IDEs)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
## Introduction ## Introduction
Plugin projects can target IDEs other than IntelliJ IDEA, as long as the products are based on the [IntelliJ Platform](intellij_platform.md). Plugin projects can target IDEs other than IntelliJ IDEA, as long as the products are based on the [IntelliJ Platform](intellij_platform.md).
Such plugins are developed much like plugin projects that target IntelliJ IDEA. Such plugins are developed much like plugin projects that target IntelliJ IDEA.
They can be written in Kotlin or Java, or a mix of both. They can be written in Kotlin or Java, or a mix of both.
Once completed, the plugins can be packaged and distributed at [JetBrains Plugin Repository](https://plugins.jetbrains.com). Once completed, the plugins can be packaged and distributed at [JetBrains Marketplace](https://plugins.jetbrains.com).
Project configuration attributes common to projects targeting products other than IntelliJ IDEA are described here. Project configuration attributes common to projects targeting products other than IntelliJ IDEA are described here.
Details particular to an IntelliJ Platform-based product are described on the individual product pages in Part VIII. Details particular to an IntelliJ Platform-based product are described on the individual product pages in Part VIII.

4
topics/tutorials/build_system/deployment.md
View File

@ -1,6 +1,6 @@
[//]: # (title: Publishing Plugins with Gradle) [//]: # (title: Publishing Plugins with Gradle)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
Once you have [configured Gradle support](gradle_guide.md), you can automatically build and deploy your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com). Once you have [configured Gradle support](gradle_guide.md), you can automatically build and deploy your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com).
To automatically deploy a plugin, you need to have _already published the plugin to the plugin repository at least once._ To automatically deploy a plugin, you need to have _already published the plugin to the plugin repository at least once._
@ -89,7 +89,7 @@ publishPlugin {
} }
``` ```
When empty, this uses the default plugin repository, available to all [JetBrains Plugins Repository](https://plugins.jetbrains.com/) users. When empty, this uses the default plugin repository, available to all [JetBrains Marketplace](https://plugins.jetbrains.com/) users.
However, you can publish it to an arbitrarily-named channel. However, you can publish it to an arbitrarily-named channel.
These non-default release channels are treated as separate repositories. These non-default release channels are treated as separate repositories.