From 0d149ce5dda8015b8b187a6541320b22730cf79b Mon Sep 17 00:00:00 2001 From: Jakub Chrzanowski Date: Fri, 19 Jun 2020 07:36:30 +0200 Subject: [PATCH] rename project to IntelliJ *Platform* Pugin Template --- .github/template-cleanup/CHANGELOG.md | 2 +- .github/template-cleanup/README.md | 6 +++--- .github/workflows/template-cleanup.yml | 6 +++--- CHANGELOG.md | 2 +- README.md | 27 ++++++++++++++++---------- 5 files changed, 25 insertions(+), 18 deletions(-) diff --git a/.github/template-cleanup/CHANGELOG.md b/.github/template-cleanup/CHANGELOG.md index 7b8435d..619f92d 100644 --- a/.github/template-cleanup/CHANGELOG.md +++ b/.github/template-cleanup/CHANGELOG.md @@ -4,4 +4,4 @@ ## [Unreleased] ### Added -- Initial scaffold created from [IntelliJ Plugin Template](https://github.com/JetBrains/intellij-plugin-template) +- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) diff --git a/.github/template-cleanup/README.md b/.github/template-cleanup/README.md index bbd752b..f442d5e 100644 --- a/.github/template-cleanup/README.md +++ b/.github/template-cleanup/README.md @@ -1,9 +1,9 @@ # %NAME% -![Build](https://github.com/JetBrains/intellij-plugin-template/workflows/Build/badge.svg) +![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg) -This Fancy IntelliJ Plugin is going to be your implementation of the brilliant ideas that you have. +This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. This specific section is a source for the [plugin.xml](./src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](./build.gradle.kts) during the build process. @@ -25,4 +25,4 @@ To keep everything working, do not remove `` sections. --- -Plugin based on the [IntelliJ Plugin Template](https://github.com/JetBrains/intellij-plugin-template). +Plugin based on the [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template). diff --git a/.github/workflows/template-cleanup.yml b/.github/workflows/template-cleanup.yml index fc84b06..fdaccf1 100644 --- a/.github/workflows/template-cleanup.yml +++ b/.github/workflows/template-cleanup.yml @@ -1,4 +1,4 @@ -# GitHub Actions Workflow responsible for cleaning up the IntelliJ Plugin Template repository from +# GitHub Actions Workflow responsible for cleaning up the IntelliJ Platform Plugin Template repository from # the template-specific files and configurations. This workflow is supposed to be triggered automatically # when a new template-based repository has been created. @@ -10,11 +10,11 @@ on: jobs: - # Run cleaning process only if workflow is triggered by the non-JetBrains/intellij-plugin-template repository. + # Run cleaning process only if workflow is triggered by the non-JetBrains/intellij-platform-plugin-template repository. template-cleanup: name: Template Cleanup runs-on: ubuntu-latest - if: github.repository != 'JetBrains/intellij-plugin-template' + if: github.repository != 'JetBrains/intellij-platform-plugin-template' steps: # Check out current repository diff --git a/CHANGELOG.md b/CHANGELOG.md index 99e1304..56533d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ -# IntelliJ Plugin Template Changelog +# IntelliJ Platform Plugin Template Changelog ## [Unreleased] ### Added diff --git a/README.md b/README.md index e00c485..d84a0e3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# IntelliJ Plugin Template +# IntelliJ Platform Plugin Template [![official JetBrains project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub) -![Build](https://github.com/JetBrains/intellij-plugin-template/workflows/Build/badge.svg) +![Build](https://github.com/JetBrains/intellij-platform-plugin-template/workflows/Build/badge.svg) [![Slack](https://img.shields.io/badge/Slack-%23intellij--plugin--template-blue)](https://plugins.jetbrains.com/slack) -**IntelliJ Plugin Template** is a repository that provides a pure boilerplate for creating a plugin project with ease -designed as a **GitHub Template Repository** (check the [Creating a repository from a template][gh-template] article). +**IntelliJ Platform Plugin Template** is a repository that provides a pure boilerplate for creating a plugin project +with ease designed as a **GitHub Template Repository** (check the [Creating a repository from a template][gh-template] +article). + The main goal for this Template is to speed up the setup phase of the plugin development for the new as well as existing developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages and keeping everything in the most straightforward manner. @@ -52,8 +54,8 @@ The recommended way of the plugin development is using the [Gradle][gradle] setu [gradle-intellij-plugin][gradle-intellij-plugin] installed. The gradle-intellij-plugin provides tasks to run the IDE with your plugin and to publish your plugin to the Marketplace Repository. -IntelliJ Plugin Template project provides already preconfigured Gradle configuration, however feel free to follow -the [Using Gradle][docs:using-gradle] articles for better understanding and customisation of your build. +IntelliJ Platform Plugin Template project provides already preconfigured Gradle configuration, however feel free +to follow the [Using Gradle][docs:using-gradle] articles for better understanding and customisation of your build. The most significant parts of the current configuration are: - Configuration written with [Gradle Kotlin DSL][gradle-kotlin-dsl] @@ -121,7 +123,7 @@ and plugin's manifest - [plugin.xml][file:plugin.xml]. ## Plugin Configuration File -Plugin Configuration File is a [plugin.xml][file:plugin.xml] file located in the `/src/main/resources/META-INF` +Plugin Configuration File is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` directory. It describes the overall information about the plugin, its dependencies, extensions, and listeners. ```xml @@ -154,15 +156,20 @@ general scaffold. Having that in mind, it contains few following files: . ├── MyBundle.kt Bundle class providing access to the resources messages ├── listeners -│   ├── MyDynamicPluginListener.kt Dynamic Plugin listener - notifies about the dynamic plugin lifecycle -│   └── MyProjectManagerListener.kt Project Manager listener - notifies about the project open event +│   ├── MyDynamicPluginListener.kt Dynamic Plugin listener - handles plugin lifecycle events +│   └── MyProjectManagerListener.kt Project Manager listener - handles project lifecycle └── services ├── MyApplicationService.kt Application level service available for all projects └── MyProjectService.kt Project level service ``` +Above files location is `src/main/kotlin`, which indicates the used language - if you will decide to use Java instead, +sources should be located in `src/main/java` directory. + ## Continuous Integration +Continuous Integration depends on the GitHub Actions, which is a set of workflows + Unit tests Detekt verifyPlugin @@ -202,7 +209,7 @@ Cannot find org.jetbrains.plugins.template. Note that you need to upload the plu [code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples [gradle-intellij-plugin]: https://github.com/JetBrains/gradle-intellij-plugin [gradle-changelog-plugin]: https://github.com/JetBrains/gradle-changelog-plugin -[releases]: https://github.com/JetBrains/intellij-plugin-template/releases +[releases]: https://github.com/JetBrains/intellij-platform-plugin-template/releases [marketplace-plugin-page]: https://plugins.jetbrains.com/plugin/0-TODO [slack]: https://plugins.jetbrains.com/slack [forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development