rename project to IntelliJ *Platform* Pugin Template

pull/9/head
Jakub Chrzanowski 4 years ago
parent 527557dd5e
commit 0d149ce5dd

@ -4,4 +4,4 @@
## [Unreleased] ## [Unreleased]
### Added ### 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)

@ -1,9 +1,9 @@
# %NAME% # %NAME%
![Build](https://github.com/JetBrains/intellij-plugin-template/workflows/Build/badge.svg) ![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg)
<!-- Plugin description --> <!-- Plugin description -->
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 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. 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).

@ -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 # the template-specific files and configurations. This workflow is supposed to be triggered automatically
# when a new template-based repository has been created. # when a new template-based repository has been created.
@ -10,11 +10,11 @@ on:
jobs: 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: template-cleanup:
name: Template Cleanup name: Template Cleanup
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: github.repository != 'JetBrains/intellij-plugin-template' if: github.repository != 'JetBrains/intellij-platform-plugin-template'
steps: steps:
# Check out current repository # Check out current repository

@ -1,6 +1,6 @@
<!-- Keep a Changelog guide -> https://keepachangelog.com --> <!-- Keep a Changelog guide -> https://keepachangelog.com -->
# IntelliJ Plugin Template Changelog # IntelliJ Platform Plugin Template Changelog
## [Unreleased] ## [Unreleased]
### Added ### Added

@ -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) [![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) [![Slack](https://img.shields.io/badge/Slack-%23intellij--plugin--template-blue)](https://plugins.jetbrains.com/slack)
<!-- Plugin description --> <!-- Plugin description -->
**IntelliJ Plugin Template** is a repository that provides a pure boilerplate for creating a plugin project with ease **IntelliJ Platform Plugin Template** is a repository that provides a pure boilerplate for creating a plugin project
designed as a **GitHub Template Repository** (check the [Creating a repository from a template][gh-template] article). 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 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 developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages and keeping
everything in the most straightforward manner. 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 [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. 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 IntelliJ Platform Plugin Template project provides already preconfigured Gradle configuration, however feel free
the [Using Gradle][docs:using-gradle] articles for better understanding and customisation of your build. 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: The most significant parts of the current configuration are:
- Configuration written with [Gradle Kotlin DSL][gradle-kotlin-dsl] - 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
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. directory. It describes the overall information about the plugin, its dependencies, extensions, and listeners.
```xml ```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 ├── MyBundle.kt Bundle class providing access to the resources messages
├── listeners ├── listeners
│   ├── MyDynamicPluginListener.kt Dynamic Plugin listener - notifies about the dynamic plugin lifecycle │   ├── MyDynamicPluginListener.kt Dynamic Plugin listener - handles plugin lifecycle events
│   └── MyProjectManagerListener.kt Project Manager listener - notifies about the project open event │   └── MyProjectManagerListener.kt Project Manager listener - handles project lifecycle
└── services └── services
├── MyApplicationService.kt Application level service available for all projects ├── MyApplicationService.kt Application level service available for all projects
└── MyProjectService.kt Project level service └── 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
Continuous Integration depends on the GitHub Actions, which is a set of workflows
Unit tests Unit tests
Detekt Detekt
verifyPlugin 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 [code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples
[gradle-intellij-plugin]: https://github.com/JetBrains/gradle-intellij-plugin [gradle-intellij-plugin]: https://github.com/JetBrains/gradle-intellij-plugin
[gradle-changelog-plugin]: https://github.com/JetBrains/gradle-changelog-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 [marketplace-plugin-page]: https://plugins.jetbrains.com/plugin/0-TODO
[slack]: https://plugins.jetbrains.com/slack [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 [forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development

Loading…
Cancel
Save