hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +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)
<!-- 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.
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),
* Changing the target IntelliJ Platform-based IDE, e.g., from IntelliJ IDEA to PyCharm,
* 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 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

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

@ -1,6 +1,6 @@
[//]: # (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
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.
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.
The compatibility information determines if plugins are available at the plugin repository to users of a particular JetBrains product.
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 for users of a particular JetBrains product.
## Platform API Version Compatibility
The API of IntelliJ Platform and bundled plugins may change between releases.

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

@ -1,9 +1,9 @@
[//]: # (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.
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.
>
@ -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.
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
To upload your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com), you must log in with your personal JetBrains Account.
## Publishing to JetBrains Marketplace
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:**
@ -25,10 +25,10 @@ To upload your plugin to the [JetBrains Plugins Repository](https://plugins.jetb
1. [Log in to JetBrains Plugins Repository](https://plugins.jetbrains.com/author/me) with your personal JetBrains account.
2. On your Profile page that opens, click **Add new plugin**.
3. Fill in the **Add new plugin** form that opens and click the **Add the plugin** button to upload your plugin.
### Uploading a New Version
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
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)
<!-- 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.
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.

10
topics/intro/intellij_platform.md
View File

@ -1,6 +1,6 @@
[//]: # (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.
It is used to power JetBrains products such as [IntelliJ IDEA](https://www.jetbrains.com/idea/).
@ -9,7 +9,7 @@ It is also Open Source and can be used by third parties to build IDEs, such as [
The IntelliJ Platform provides all of the infrastructures that these IDEs need to provide rich language tooling support.
It is a component-driven, cross-platform JVM based application host with a high-level user interface toolkit for creating tool windows, tree views, and lists (supporting fast search) as well as popup menus and dialogs.
The IntelliJ Platform has a full-text editor with abstract implementations of syntax highlighting, code folding, code completion, and other rich text editing features.
The IntelliJ Platform has a full-text editor with abstract implementations of syntax highlighting, code folding, code completion, and other rich text editing features.
An image editor is also included.
Furthermore, it includes open APIs to build standard IDE functionality, such as a project model and a build system.
@ -24,7 +24,7 @@ The IntelliJ Platform includes parsers and a PSI model for many languages, and i
## 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.
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).
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.
@ -41,7 +41,7 @@ The IntelliJ Platform is Open Source, under the [Apache License](upsource:///LIC
While this guide refers to the IntelliJ Platform as a separate entity, there is no "IntelliJ Platform" GitHub repository.
Instead, the platform is considered to be an almost complete overlap with the IntelliJ IDEA Community Edition, which is a free and Open Source version of IntelliJ IDEA Ultimate (the GitHub repository linked above is the [JetBrains/intellij-community](https://github.com/JetBrains/intellij-community) repository).
Please note: starting with 2021.1 release, some plugins bundled with IntelliJ IDEA Community Edition are not open-source.
Please note: starting with 2021.1 release, some plugins bundled with IntelliJ IDEA Community Edition are not open-source.
The version of the IntelliJ Platform is defined by the version of the corresponding release of IntelliJ IDEA Community Edition.
For example, to build a plugin against IntelliJ IDEA (2019.1.1), build #191.6707.61 means specifying the same build number tag to get the correct Intellij Platform files from the `intellij-community` repository.
@ -89,4 +89,4 @@ This means that creating a plugin for Rider involves two parts - a plugin that l
Fortunately, many plugins can simply work with the ReSharper backend.
The Rider takes care of displaying the results of inspections and code completion, and many plugins can be written that don't require an IntelliJ UI component.
More details can be found in the *Part VIII - Product Specific* section.
More details can be found in the *Part VIII - Product Specific* section.

8
topics/products/android_studio.md
View File

@ -1,12 +1,12 @@
[//]: # (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
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).
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.
@ -72,7 +72,7 @@ Otherwise, if only general IntelliJ Platform features (APIs) are used, then a de
```xml
<depends>com.intellij.modules.androidstudio</depends>
```
### Android Specific Extension Points
See _Android Plugin_ section in [Extension Point List](extension_point_list.md).
@ -88,7 +88,7 @@ When learning new development configurations, it is helpful to have some represe
* [Android postfix plugin](https://github.com/takahirom/android-postfix-plugin) for Android Studio.
* [Flutter Plugin](https://github.com/flutter/flutter-intellij).
* Bal Sikandar's [list of Android Studio plugins](https://github.com/balsikandar/Android-Studio-Plugins).
## FAQ
### How To Sync Gradle Project

4
topics/products/dev_alternate_products.md
View File

@ -1,12 +1,12 @@
[//]: # (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
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.
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.
Details particular to an IntelliJ Platform-based product are described on the individual product pages in Part VIII.

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

@ -1,10 +1,10 @@
[//]: # (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).
To automatically deploy a plugin, you need to have _already published the plugin to the plugin repository at least once._
Please see the guide page for manually [publishing a plugin](publishing_plugin.md) for the first time and [Building Distribution](#building-distribution) on obtaining the initial plugin distribution artifact.
Please see the guide page for manually [publishing a plugin](publishing_plugin.md) for the first time and [Building Distribution](#building-distribution) on obtaining the initial plugin distribution artifact.
> Please see [Marketing](marketing.md) for remarks on how to prepare your plugin for optimal presentation.
>
@ -51,7 +51,7 @@ Note that you still need to put some default values (can be empty) in the Gradle
### Using Parameters for the Gradle Task
Like using environment variables, you can also pass your token as a parameter to the Gradle task.
For example, you can provide the parameter
For example, you can provide the parameter
```bash
-Dorg.gradle.project.intellijPublishToken=YOUR_HUB_TOKEN_HERE
@ -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.
These non-default release channels are treated as separate repositories.