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

"first plugin": cleanups

Browse Source
This commit is contained in:
Yann Cébron 2022-03-10 15:15:38 +01:00
parent 771e3e7431
commit c50773386e
3 changed files with 6 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
topics/basics/getting_started.md
View File

@ -15,24 +15,10 @@ There are three supported workflows available for building plugins.
The recommended workflow for new projects is to [use GitHub Template](#using-github-template) or to [use Gradle](#using-gradle) to create everything from scratch. The recommended workflow for new projects is to [use GitHub Template](#using-github-template) or to [use Gradle](#using-gradle) to create everything from scratch.
The old [Plugin DevKit](#using-devkit) workflow still supports existing projects. The old [Plugin DevKit](#using-devkit) workflow still supports existing projects.
> If a new plugin will be Scala-based, a dedicated SBT plugin [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) is available. > If a new plugin will be Scala-based, a dedicated [SBT plugin](https://github.com/JetBrains/sbt-idea-plugin) is available.
> >
{type="note"} {type="note"}
The Gradle workflow offers several advantages:
* Representations of source sets, modules, and projects are portable,
* Projects of any size or complexity usually require scripts for build management, which Gradle handles natively,
* Training, documentation, and community help for general Gradle topics are widely available.
Specific to development of IntelliJ Platform plugins with the Gradle plugin for IntelliJ IDEA:
* Changing plugin targets is more comfortable because it is all done in the Gradle build file:
* 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 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 Marketplace](https://plugins.jetbrains.com).
## Using GitHub Template ## Using GitHub Template
* [Developing plugins using GitHub Template](github_template.md) * [Developing plugins using GitHub Template](github_template.md)
@ -49,7 +35,6 @@ Specific to development of IntelliJ Platform plugins with the Gradle plugin for
* [Developing plugins using DevKit](using_dev_kit.md) * [Developing plugins using DevKit](using_dev_kit.md)
* [Setting Up a Development Environment](setting_up_environment.md) * [Setting Up a Development Environment](setting_up_environment.md)
* [Creating a Plugin Project](creating_plugin_project.md) * [Creating a Plugin Project](creating_plugin_project.md)
* [Creating Actions](working_with_custom_actions.md)
* [Running and Debugging a Plugin](running_and_debugging_a_plugin.md) * [Running and Debugging a Plugin](running_and_debugging_a_plugin.md)
* [Deploying a Plugin](deploying_plugin.md) * [Deploying a Plugin](deploying_plugin.md)
* [Publishing a Plugin](publishing_plugin.md) * [Publishing a Plugin](publishing_plugin.md)

1
topics/basics/getting_started/using_dev_kit.md
View File

@ -13,7 +13,6 @@ In this section:
* [Setting Up a Development Environment](setting_up_environment.md) * [Setting Up a Development Environment](setting_up_environment.md)
* [Creating a Plugin Project](creating_plugin_project.md) * [Creating a Plugin Project](creating_plugin_project.md)
* [Creating Actions](working_with_custom_actions.md)
* [Running and Debugging a Plugin](running_and_debugging_a_plugin.md) * [Running and Debugging a Plugin](running_and_debugging_a_plugin.md)
* [Deploying a Plugin](deploying_plugin.md) * [Deploying a Plugin](deploying_plugin.md)
* [Publishing a Plugin](publishing_plugin.md) * [Publishing a Plugin](publishing_plugin.md)

10
topics/tutorials/gradle_build_system.md
View File

@ -3,7 +3,7 @@
<!-- 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. --> <!-- 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 [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) Gradle plugin is the recommended solution for building IntelliJ Platform plugins. The [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) Gradle plugin is the recommended solution for building IntelliJ Platform plugins.
The plugin takes care of the dependencies of your plugin project - both the base IDE and other plugin dependencies. The plugin takes care of the dependencies of your plugin project — both the base IDE and other plugin dependencies.
It provides tasks to run the IDE with your plugin and to package and publish your plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com). It provides tasks to run the IDE with your plugin and to package and publish your plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com).
To make sure that a plugin is not affected by [API changes](api_changes_list.md), which may happen between major releases of the platform, you can quickly verify your plugin against other IDEs and releases. To make sure that a plugin is not affected by [API changes](api_changes_list.md), which may happen between major releases of the platform, you can quickly verify your plugin against other IDEs and releases.
@ -11,7 +11,7 @@ To make sure that a plugin is not affected by [API changes](api_changes_list.md)
> >
{type="tip"} {type="tip"}
> If a new plugin will be Scala-based, a dedicated SBT plugin [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) is available. > If a new plugin will be Scala-based, a dedicated [SBT plugin](https://github.com/JetBrains/sbt-idea-plugin) is available.
> >
{type="note"} {type="note"}
@ -24,6 +24,6 @@ To make sure that a plugin is not affected by [API changes](api_changes_list.md)
Below are a series of guides to developing and deploying Gradle-based IntelliJ Platform Plugins: Below are a series of guides to developing and deploying Gradle-based IntelliJ Platform Plugins:
* [Getting Started with Gradle](gradle_prerequisites.md) * [](gradle_prerequisites.md)
* [Configuring Gradle Projects](gradle_guide.md) * [](gradle_guide.md)
* [Publishing Plugins with Gradle](deployment.md) * [](deployment.md)