diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..bd9f9fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug report +description: Create a report to help us improve +labels: ["bug"] +body: + + - type: textarea + id: issue + attributes: + label: What happened? + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output or stack trace + description: | + Please copy and paste any relevant log output. + Add the full stack trace if available. + If possible, run the failing task with `--stacktrace` flag. + + *This will be automatically formatted into code, so there is no need for backticks.* + render: shell + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior – provide your build configuration. + validations: + required: true + + - type: input + id: version + attributes: + label: Gradle IntelliJ Plugin version + placeholder: 1.16.0 + validations: + required: true + + - type: input + id: gradle + attributes: + label: Gradle version + placeholder: 8.2.1 + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + options: + - macOS + - Linux + - Windows + + - type: input + id: url + attributes: + label: Link to build, i.e. failing GitHub Action job + placeholder: https://github.com/username/project/actions/runs/1234567890 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..58278e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Documentation + url: https://github.com/JetBrains/intellij-platform-plugin-template + about: Check the README file in the first place. + - name: Getting Help + url: https://plugins.jetbrains.com/docs/intellij/getting-help.html + about: Check if you search for a help in plugin development. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9c13061 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,32 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["enhancement"] +body: + + - type: textarea + id: cause + attributes: + label: Describe the need of your request + description: A clear and concise description of what the need or problem is. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed solution + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives you've considered + description: What did you try so far to accomplish the goal? + + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..9be205f --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,17 @@ +# Dependabot configuration: +# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + # Maintain dependencies for Gradle dependencies + - package-ecosystem: "gradle" + directory: "/" + target-branch: "next" + schedule: + interval: "daily" + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + target-branch: "next" + schedule: + interval: "daily" diff --git a/.github/readme/draft-release.png b/.github/readme/draft-release.png new file mode 100644 index 0000000..f15caeb Binary files /dev/null and b/.github/readme/draft-release.png differ diff --git a/.github/readme/get-from-version-control.png b/.github/readme/get-from-version-control.png new file mode 100644 index 0000000..86ebfda Binary files /dev/null and b/.github/readme/get-from-version-control.png differ diff --git a/.github/readme/intellij-platform-plugin-template-dark.svg b/.github/readme/intellij-platform-plugin-template-dark.svg new file mode 100644 index 0000000..e0bd869 --- /dev/null +++ b/.github/readme/intellij-platform-plugin-template-dark.svg @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.github/readme/intellij-platform-plugin-template-light.svg b/.github/readme/intellij-platform-plugin-template-light.svg new file mode 100644 index 0000000..becd633 --- /dev/null +++ b/.github/readme/intellij-platform-plugin-template-light.svg @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.github/readme/intellij-platform-plugin-template.png b/.github/readme/intellij-platform-plugin-template.png new file mode 100644 index 0000000..435804b Binary files /dev/null and b/.github/readme/intellij-platform-plugin-template.png differ diff --git a/.github/readme/project-structure-sdk.png b/.github/readme/project-structure-sdk.png new file mode 100644 index 0000000..f403ef1 Binary files /dev/null and b/.github/readme/project-structure-sdk.png differ diff --git a/.github/readme/qodana.png b/.github/readme/qodana.png new file mode 100644 index 0000000..bf7775e Binary files /dev/null and b/.github/readme/qodana.png differ diff --git a/.github/readme/run-debug-configurations.png b/.github/readme/run-debug-configurations.png new file mode 100644 index 0000000..a021802 Binary files /dev/null and b/.github/readme/run-debug-configurations.png differ diff --git a/.github/readme/run-logs.png b/.github/readme/run-logs.png new file mode 100644 index 0000000..b18620c Binary files /dev/null and b/.github/readme/run-logs.png differ diff --git a/.github/readme/settings-secrets.png b/.github/readme/settings-secrets.png new file mode 100644 index 0000000..9588551 Binary files /dev/null and b/.github/readme/settings-secrets.png differ diff --git a/.github/readme/ui-testing.png b/.github/readme/ui-testing.png new file mode 100644 index 0000000..204828a Binary files /dev/null and b/.github/readme/ui-testing.png differ diff --git a/.github/readme/use-this-template.png b/.github/readme/use-this-template.png new file mode 100644 index 0000000..6eb49f5 Binary files /dev/null and b/.github/readme/use-this-template.png differ diff --git a/.github/template-cleanup/.github/dependabot.yml b/.github/template-cleanup/.github/dependabot.yml new file mode 100644 index 0000000..fe30e00 --- /dev/null +++ b/.github/template-cleanup/.github/dependabot.yml @@ -0,0 +1,15 @@ +# Dependabot configuration: +# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + # Maintain dependencies for Gradle dependencies + - package-ecosystem: "gradle" + directory: "/" + schedule: + interval: "daily" + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/template-cleanup/CHANGELOG.md b/.github/template-cleanup/CHANGELOG.md new file mode 100644 index 0000000..619f92d --- /dev/null +++ b/.github/template-cleanup/CHANGELOG.md @@ -0,0 +1,7 @@ + + +# %NAME% Changelog + +## [Unreleased] +### Added +- 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 new file mode 100644 index 0000000..0f703da --- /dev/null +++ b/.github/template-cleanup/README.md @@ -0,0 +1,44 @@ +# %NAME% + +![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg) +[![Version](https://img.shields.io/jetbrains/plugin/v/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) +[![Downloads](https://img.shields.io/jetbrains/plugin/d/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) + +## Template ToDo list +- [x] Create a new [IntelliJ Platform Plugin Template][template] project. +- [ ] Get familiar with the [template documentation][template]. +- [ ] Adjust the [pluginGroup](./gradle.properties), [plugin ID](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin). +- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description]) +- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate). +- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. +- [ ] Set the `PLUGIN_ID` in the above README badges. +- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables). +- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate). +- [ ] Click the Watch button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. + + +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. + +To keep everything working, do not remove `` sections. + + +## Installation + +- Using the IDE built-in plugin system: + + Settings/Preferences > Plugins > Marketplace > Search for "%NAME%" > + Install + +- Manually: + + Download the [latest release](https://github.com/%REPOSITORY%/releases/latest) and install it manually using + Settings/Preferences > Plugins > ⚙️ > Install plugin from disk... + + +--- +Plugin based on the [IntelliJ Platform Plugin Template][template]. + +[template]: https://github.com/JetBrains/intellij-platform-plugin-template +[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation diff --git a/.github/template-cleanup/gradle.properties b/.github/template-cleanup/gradle.properties new file mode 100644 index 0000000..1395677 --- /dev/null +++ b/.github/template-cleanup/gradle.properties @@ -0,0 +1,34 @@ +# IntelliJ Platform Artifacts Repositories -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html + +pluginGroup = %GROUP% +pluginName = %NAME% +pluginRepositoryUrl = https://github.com/%REPOSITORY% +# SemVer format -> https://semver.org +pluginVersion = 0.0.1 + +# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html +pluginSinceBuild = 223 +pluginUntilBuild = 233.* + +# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension +platformType = IC +platformVersion = 2022.3.3 + +# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html +# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22 +platformPlugins = + +# Gradle Releases -> https://github.com/gradle/gradle/releases +gradleVersion = 8.5 + +# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib +kotlin.stdlib.default.dependency = false + +# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html +org.gradle.configuration-cache = true + +# Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html +org.gradle.caching = true + +# Enable Gradle Kotlin DSL Lazy Property Assignment -> https://docs.gradle.org/current/userguide/kotlin_dsl.html#kotdsl:assignment +systemProp.org.gradle.unsafe.kotlin.assignment = true diff --git a/.github/template-cleanup/settings.gradle.kts b/.github/template-cleanup/settings.gradle.kts new file mode 100644 index 0000000..a223046 --- /dev/null +++ b/.github/template-cleanup/settings.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.7.0" +} + +rootProject.name = "%NAME%" diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..6e21b5a --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,265 @@ +# GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps: +# - Validate Gradle Wrapper. +# - Run 'test' and 'verifyPlugin' tasks. +# - Run Qodana inspections. +# - Run the 'buildPlugin' task and prepare artifact for further tests. +# - Run the 'runPluginVerifier' task. +# - Create a draft release. +# +# The workflow is triggered on push and pull_request events. +# +# GitHub Actions reference: https://help.github.com/en/actions +# +## JBIJPPTPL + +name: Build +on: + # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g., for dependabot pull requests) + push: + branches: [ main ] + # Trigger the workflow on any pull request + pull_request: + +jobs: + + # Prepare environment and build the plugin + build: + name: Build + runs-on: ubuntu-latest + outputs: + version: ${{ steps.properties.outputs.version }} + changelog: ${{ steps.properties.outputs.changelog }} + pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }} + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Validate wrapper + - name: Gradle Wrapper Validation + uses: gradle/wrapper-validation-action@v1.1.0 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Setup Gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + with: + gradle-home-cache-cleanup: true + + # Set environment variables + - name: Export Properties + id: properties + shell: bash + run: | + PROPERTIES="$(./gradlew properties --console=plain -q)" + VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')" + CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)" + + echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT + + echo "changelog<> $GITHUB_OUTPUT + echo "$CHANGELOG" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier + + # Build plugin + - name: Build plugin + run: ./gradlew buildPlugin + + # Prepare plugin archive content for creating artifact + - name: Prepare Plugin Artifact + id: artifact + shell: bash + run: | + cd ${{ github.workspace }}/build/distributions + FILENAME=`ls *.zip` + unzip "$FILENAME" -d content + + echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT + + # Store already-built plugin as an artifact for downloading + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: ${{ steps.artifact.outputs.filename }} + path: ./build/distributions/content/*/* + + # Run tests and upload a code coverage report + test: + name: Test + needs: [ build ] + runs-on: ubuntu-latest + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Setup Gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + with: + gradle-home-cache-cleanup: true + + # Run tests + - name: Run Tests + run: ./gradlew check + + # Collect Tests Result of failed tests + - name: Collect Tests Result + if: ${{ failure() }} + uses: actions/upload-artifact@v3 + with: + name: tests-result + path: ${{ github.workspace }}/build/reports/tests + + # Upload the Kover report to CodeCov + - name: Upload Code Coverage Report + uses: codecov/codecov-action@v3 + with: + files: ${{ github.workspace }}/build/reports/kover/report.xml + + # Run Qodana inspections and provide report + inspectCode: + name: Inspect code + needs: [ build ] + runs-on: ubuntu-latest + permissions: + contents: write + checks: write + pull-requests: write + steps: + + # Free GitHub Actions Environment Disk Space + - name: Maximize Build Space + uses: jlumbroso/free-disk-space@main + with: + tool-cache: false + large-packages: false + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Run Qodana inspections + - name: Qodana - Code Inspection + uses: JetBrains/qodana-action@v2023.2.8 + with: + cache-default-branch-only: true + + # Run plugin structure verification along with IntelliJ Plugin Verifier + verify: + name: Verify plugin + needs: [ build ] + runs-on: ubuntu-latest + steps: + + # Free GitHub Actions Environment Disk Space + - name: Maximize Build Space + uses: jlumbroso/free-disk-space@main + with: + tool-cache: false + large-packages: false + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Setup Gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + with: + gradle-home-cache-cleanup: true + + # Cache Plugin Verifier IDEs + - name: Setup Plugin Verifier IDEs Cache + uses: actions/cache@v3 + with: + path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides + key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }} + + # Run Verify Plugin task and IntelliJ Plugin Verifier tool + - name: Run Plugin Verification tasks + run: ./gradlew runPluginVerifier -Dplugin.verifier.home.dir=${{ needs.build.outputs.pluginVerifierHomeDir }} + + # Collect Plugin Verifier Result + - name: Collect Plugin Verifier Result + if: ${{ always() }} + uses: actions/upload-artifact@v3 + with: + name: pluginVerifier-result + path: ${{ github.workspace }}/build/reports/pluginVerifier + + # Prepare a draft release for GitHub Releases page for the manual verification + # If accepted and published, release workflow would be triggered + releaseDraft: + name: Release draft + if: github.event_name != 'pull_request' + needs: [ build, test, inspectCode, verify ] + runs-on: ubuntu-latest + permissions: + contents: write + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Remove old release drafts by using the curl request for the available releases with a draft flag + - name: Remove Old Release Drafts + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + gh api repos/{owner}/{repo}/releases \ + --jq '.[] | select(.draft == true) | .id' \ + | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{} + + # Create a new release draft which is not publicly visible and requires manual acceptance + - name: Create Release Draft + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + gh release create v${{ needs.build.outputs.version }} \ + --draft \ + --title "v${{ needs.build.outputs.version }}" \ + --notes "$(cat << 'EOM' + ${{ needs.build.outputs.changelog }} + EOM + )" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..0d48e56 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,103 @@ +# GitHub Actions Workflow created for handling the release process based on the draft release prepared with the Build workflow. +# Running the publishPlugin task requires all following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN. +# See https://plugins.jetbrains.com/docs/intellij/plugin-signing.html for more information. + +name: Release +on: + release: + types: [prereleased, released] + +jobs: + + # Prepare and publish the plugin to JetBrains Marketplace repository + release: + name: Publish Plugin + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + with: + ref: ${{ github.event.release.tag_name }} + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Setup Gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + with: + gradle-home-cache-cleanup: true + + # Set environment variables + - name: Export Properties + id: properties + shell: bash + run: | + CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d' + ${{ github.event.release.body }} + EOM + )" + + echo "changelog<> $GITHUB_OUTPUT + echo "$CHANGELOG" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + # Update Unreleased section with the current release note + - name: Patch Changelog + if: ${{ steps.properties.outputs.changelog != '' }} + env: + CHANGELOG: ${{ steps.properties.outputs.changelog }} + run: | + ./gradlew patchChangelog --release-note="$CHANGELOG" + + # Publish the plugin to JetBrains Marketplace + - name: Publish Plugin + env: + PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }} + CERTIFICATE_CHAIN: ${{ secrets.CERTIFICATE_CHAIN }} + PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }} + PRIVATE_KEY_PASSWORD: ${{ secrets.PRIVATE_KEY_PASSWORD }} + run: ./gradlew publishPlugin + + # Upload artifact as a release asset + - name: Upload Release Asset + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh release upload ${{ github.event.release.tag_name }} ./build/distributions/* + + # Create a pull request + - name: Create Pull Request + if: ${{ steps.properties.outputs.changelog != '' }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + VERSION="${{ github.event.release.tag_name }}" + BRANCH="changelog-update-$VERSION" + LABEL="release changelog" + + git config user.email "action@github.com" + git config user.name "GitHub Action" + + git checkout -b $BRANCH + git commit -am "Changelog update - $VERSION" + git push --set-upstream origin $BRANCH + + gh label create "$LABEL" \ + --description "Pull requests with release changelog update" \ + --force \ + || true + + gh pr create \ + --title "Changelog update - \`$VERSION\`" \ + --body "Current pull request contains patched \`CHANGELOG.md\` file for the \`$VERSION\` version." \ + --label "$LABEL" \ + --head $BRANCH diff --git a/.github/workflows/run-ui-tests.yml b/.github/workflows/run-ui-tests.yml new file mode 100644 index 0000000..05e483b --- /dev/null +++ b/.github/workflows/run-ui-tests.yml @@ -0,0 +1,65 @@ +# GitHub Actions Workflow for launching UI tests on Linux, Windows, and Mac in the following steps: +# - Prepare and launch IDE with your plugin and robot-server plugin, which is needed to interact with the UI. +# - Wait for IDE to start. +# - Run UI tests with a separate Gradle task. +# +# Please check https://github.com/JetBrains/intellij-ui-test-robot for information about UI tests with IntelliJ Platform. +# +# Workflow is triggered manually. + +name: Run UI Tests +on: + workflow_dispatch + +jobs: + + testUI: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + include: + - os: ubuntu-latest + runIde: | + export DISPLAY=:99.0 + Xvfb -ac :99 -screen 0 1920x1080x16 & + gradle runIdeForUiTests & + - os: windows-latest + runIde: start gradlew.bat runIdeForUiTests + - os: macos-latest + runIde: ./gradlew runIdeForUiTests & + + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Set up Java environment for the next steps + - name: Setup Java + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + + # Setup Gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + with: + gradle-home-cache-cleanup: true + + # Run IDEA prepared for UI testing + - name: Run IDE + run: ${{ matrix.runIde }} + + # Wait for IDEA to be started + - name: Health Check + uses: jtalk/url-health-check-action@v3 + with: + url: http://127.0.0.1:8082 + max-attempts: 15 + retry-delay: 30s + + # Run tests + - name: Tests + run: ./gradlew test diff --git a/.github/workflows/template-cleanup.yml b/.github/workflows/template-cleanup.yml new file mode 100644 index 0000000..f80003a --- /dev/null +++ b/.github/workflows/template-cleanup.yml @@ -0,0 +1,81 @@ +# 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. + +name: Template Cleanup +on: + push: + branches: [main] + +jobs: + + # Run a cleaning process only if the workflow is triggered by the non-"intellij-platform-plugin-template" repository. + template-cleanup: + name: Template Cleanup + runs-on: ubuntu-latest + if: github.event.repository.name != 'intellij-platform-plugin-template' + permissions: + contents: write + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Cleanup project + - name: Cleanup + run: | + export LC_CTYPE=C + export LANG=C + + # Prepare variables + NAME="${GITHUB_REPOSITORY##*/}" + ACTOR=$(echo $GITHUB_ACTOR | tr '[:upper:]' '[:lower:]') + SAFE_NAME=$(echo $NAME | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]') + SAFE_ACTOR=$(echo $ACTOR | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]') + GROUP="com.github.$SAFE_ACTOR.$SAFE_NAME" + + # Replace placeholders in the template-cleanup files + sed -i "s/%NAME%/$NAME/g" .github/template-cleanup/* + sed -i "s/%REPOSITORY%/${GITHUB_REPOSITORY/\//\\/}/g" .github/template-cleanup/* + sed -i "s/%GROUP%/$GROUP/g" .github/template-cleanup/* + + # Replace template package name in project files with $GROUP + find src -type f -exec sed -i "s/org.jetbrains.plugins.template/$GROUP/g" {} + + find src -type f -exec sed -i "s/IntelliJ Platform Plugin/$NAME/g" {} + + find src -type f -exec sed -i "s/JetBrains/$ACTOR/g" {} + + + # Move content + mkdir -p src/main/kotlin/${GROUP//.//} + mkdir -p src/test/kotlin/${GROUP//.//} + cp -R .github/template-cleanup/. . + cp -R src/main/kotlin/org/jetbrains/plugins/template/* src/main/kotlin/${GROUP//.//}/ + cp -R src/test/kotlin/org/jetbrains/plugins/template/* src/test/kotlin/${GROUP//.//}/ + + # Cleanup + rm -rf \ + .github/ISSUE_TEMPLATE \ + .github/readme \ + .github/template-cleanup \ + .github/workflows/template-cleanup.yml \ + .github/workflows/template-verify.yml \ + .idea/icon.png \ + src/main/kotlin/org \ + src/test/kotlin/org \ + src/main/resources/META-INF/pluginIcon.svg \ + CODE_OF_CONDUCT.md \ + LICENSE + + # Commit modified files + - name: Commit files + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git add . + git commit -m "Template cleanup" + + # Push changes + - name: Push changes + uses: ad-m/github-push-action@master + with: + branch: main + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/template-verify.yml b/.github/workflows/template-verify.yml new file mode 100644 index 0000000..56544f5 --- /dev/null +++ b/.github/workflows/template-verify.yml @@ -0,0 +1,43 @@ +# GitHub Actions Workflow verifies if the template repository is consistent with all provided content. + +name: Template Verify +on: + # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g., for dependabot pull requests) + push: + branches: [main] + paths: ['**/gradle.properties'] + # Trigger the workflow on any pull request + pull_request: + paths: ['**/gradle.properties'] + +jobs: + + build: + name: Template Verify + if: github.event.repository.name == 'intellij-platform-plugin-template' + runs-on: ubuntu-latest + outputs: + version: ${{ steps.properties.outputs.version }} + changelog: ${{ steps.properties.outputs.changelog }} + steps: + + # Check out current repository + - name: Fetch Sources + uses: actions/checkout@v4 + + # Compare `gradle.properties` with `.github/template-cleanup/gradle.properties` + - name: Verify gradle.properties + run: | + echo "\`\`\`diff" >> $GITHUB_STEP_SUMMARY + + diff -U 0 \ + -I '^pluginVersion' \ + -I '^pluginGroup' \ + -I '^pluginName' \ + -I '^pluginRepositoryUrl' \ + --label .github/template-cleanup/gradle.properties \ + --label gradle.properties \ + .github/template-cleanup/gradle.properties gradle.properties \ + >> $GITHUB_STEP_SUMMARY + + echo "\`\`\`" >> $GITHUB_STEP_SUMMARY diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e2e5d94 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.gradle +.idea +.qodana +build diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..ce1c62c --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,16 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/icon.png b/.idea/icon.png new file mode 100644 index 0000000..c8fabc8 Binary files /dev/null and b/.idea/icon.png differ diff --git a/.run/Run IDE for UI Tests.run.xml b/.run/Run IDE for UI Tests.run.xml new file mode 100644 index 0000000..ee99b7e --- /dev/null +++ b/.run/Run IDE for UI Tests.run.xml @@ -0,0 +1,25 @@ + + + + + + + + true + true + false + false + + + \ No newline at end of file diff --git a/.run/Run Plugin.run.xml b/.run/Run Plugin.run.xml new file mode 100644 index 0000000..d15ff68 --- /dev/null +++ b/.run/Run Plugin.run.xml @@ -0,0 +1,24 @@ + + + + + + + + true + true + false + + + \ No newline at end of file diff --git a/.run/Run Qodana.run.xml b/.run/Run Qodana.run.xml new file mode 100644 index 0000000..c92f33c --- /dev/null +++ b/.run/Run Qodana.run.xml @@ -0,0 +1,30 @@ + + + + + + + + true + true + false + false + + + \ No newline at end of file diff --git a/.run/Run Tests.run.xml b/.run/Run Tests.run.xml new file mode 100644 index 0000000..132d9ad --- /dev/null +++ b/.run/Run Tests.run.xml @@ -0,0 +1,24 @@ + + + + + + + + true + true + false + + + diff --git a/.run/Run Verifications.run.xml b/.run/Run Verifications.run.xml new file mode 100644 index 0000000..3a8d688 --- /dev/null +++ b/.run/Run Verifications.run.xml @@ -0,0 +1,26 @@ + + + + + + + + true + true + false + + + + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fde9b62 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,686 @@ + + +# IntelliJ Platform Plugin Template Changelog + +## [Unreleased] + +### Changed + +- Upgrade Gradle Wrapper to `8.5` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.1` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.21` +- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.5` +- Dependencies - upgrade `annotations` to `24.1.0` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.8` +- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `4` + +## [1.11.2] - 2023-10-06 + +### Changed + +- Upgrade Gradle Wrapper to `8.4` +- Gradle - use JetBrains Runtime +- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `0.7.0` +- Change since/until build to `223-233.*` (2022.3-2023.3.*) +- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.0` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.10` +- Dependencies - upgrade `org.jetbrains.changelog` to `2.2.0` +- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `4` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.6` + +## [1.11.1] - 2023-08-17 + +### Fixed + +- GitHub Actions: publish workflow fails due to the existing `release changelog` label + +### Changed + +- Upgrade Gradle Wrapper to `8.3` + +## [1.11.0] - 2023-08-07 + +### Changed + +- GitHub Actions: move the `Maximize Build Space` step from the `Build` job to `Inspect code` and `Verify plugin` jobs +- Update `platformVersion` to `2022.3.3` +- Change since/until build to `223-232.*` (2022.3-2023.2.*) +- `MyBundle`: remove `SpreadOperator` suppression +- `MyBundle.properties`: remove unused `name` property + +## [1.10.0] - 2023-08-04 + +### Added + +- [Foojay Toolchains Plugin](https://github.com/gradle/foojay-toolchains) integration +- GitHub Actions: set `gradle-home-cache-cleanup: true` flag to the Gradle Build Action +- GitHub Actions: use `jlumbroso/free-disk-space` to free disk space + +### Changed + +- GitHub Actions: rearrange the Build workflow +- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.3` +- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.1.0` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.1` + +### Fixed + +- GitHub Actions: Fixed Kover report path when uploading the code coverage report + +## [1.9.0] - 2023-07-11 + +### Added + +- GitHub Actions — use Java `17` explicitly + +### Changed + +- Upgrade Gradle Wrapper to `8.2.1` +- Dependencies — upgrade `org.jetbrains.changelog` to `2.1.2` +- GitHub Actions — rearrange the Build workflow + +### Fixed + +- Fixed copying files issue when running the `Template Cleanup` workflow + +## [1.8.0] - 2023-07-07 + +### Changed + +- GitHub Actions: Build workflow refactoring +- Upgrade Gradle Wrapper to `8.2` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.0` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.15.0` +- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.1` +- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.2` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.5` + +### Fixed + +- Dependabot workflow points to `next` branch in a newly created project + +### Removed + +- Removed workaround for Kotlin Compiler `OutOfMemoryError` as the issue is gone with Kotlin `1.9.0` + +## [1.7.0] - 2023-06-07 + +### Added + +- GitHub Actions — enable caching +- Specify `projectJDK: 17` in `qodana.yml` +- Specify `linter` property in `qodana.yml` + +### Changed + +- Use Java `17` for JVM Toolchain +- Change since/until build to `222-232.*` (2022.2–2023.2.*) +- Dependencies - upgrade `org.jetbrains.intellij` to `1.14.1` +- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.0` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.21` +- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.1` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.0` +- Upgrade Gradle Wrapper to `8.1.1` +- GitHub Actions — switch to Java 17 +- Update Run Configuration entries +- Adjust Kover configuration + +### Fixed + +- Example code — Fixed deprecated usage of `ContentFactory` in `MyToolWindowFactory` +- Example code — Migrate from the deprecated `FrameStateListener.onFrameActivated()` to `ApplicationActivationListener.applicationActivated(IdeFrame)` + +### Removed + +- Remove `gradleJvm` property from the `.idea/gradle.xml` file +- GitHub Actions — Drop unused `name` output from the `Build` workflow + +## [1.6.0] - 2023-04-13 + +### Added + +- Temporary workaround for Kotlin Compiler `OutOfMemoryError` -> https://jb.gg/intellij-platform-kotlin-oom +- Gradle version catalog integration +- Gradle Kotlin DSL Lazy Property Assignment +- Enable Gradle Build Cache + +### Changed + +- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.3` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.20` +- Upgrade Gradle Wrapper to `8.1` +- Remove `UnusedProperty` suppression in `gradle.properties` file +- Rename `org.gradle.unsafe.configuration-cache` to `org.gradle.configuration-cache` in `gradle.properties` + +## [1.5.0] - 2023-03-10 + +### Added + +- Migrate to Gradle Provider API improving configuration cache compatibility +- Example code - `FrameStateListener` application listener +- Example code - `MyToolWindowFactory` tool window basic implementation + +### Changed + +- Update `platformVersion` to `2022.1.4` +- Change since/until build to `221-231.*` (2022.1-2023.1.*) +- Example code - registered project service changed into a lightweight one +- GitHub Actions — pass changelog release notes as a multi-line content +- GitHub Actions — provide `plugin.verifier.home.dir` variable as a system property instead of project property +- Template Cleanup: remove default `pluginIcon.svg` icon +- Upgrade Gradle Wrapper to `8.0.2` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.10` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.2` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.4` +- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.6` + +### Fixed + +- Resolving the content for the `patchPluginXML.changeNotes` property + +### Removed + +- Example code — application service +- Example code — deprecated `ProjectManagerListener` application listener + +## [1.4.0] - 2023-01-13 + +### Changed + +- GitHub Actions — use `GITHUB_OUTPUT` environment file instead of `::set-output`. +- Upgrade Gradle Wrapper to `7.6` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.0` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.12.0` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.0` + +### Fixed + +- Fallback to the unreleased change notes when the plugin in current was not released yet + +## [1.3.0] - 2022-11-17 + +### Added + +- [Kover](https://github.com/Kotlin/kotlinx-kover) integration +- Enable [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) in `gradle.proeprties` +- GitHub Actions — mark the pull request created with _Publish Plugin_ workflow with `release changelog` label +- GitHub Actions — send code coverage reports to [CodeCov](https://codecov.io) +- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.6.1` + +### Changed + +- Update `changelog` extension configuration in `build.gradle.kts` file +- Update `pluginUntilBuild` to include `223.*` (2022.3.*) +- Use `kotlin.jvmToolchain(11)` shorthand in Gradle configuration +- Dependencies - upgrade `org.jetbrains.intellij` to `1.10.0` +- Dependencies - upgrade `org.jetbrains.changelog` to `2.0.0` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.21` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.3` +- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.5` +- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `v3` +- Use `file` instead of `projectDir.resolve` in Gradle configuration file + +### Fixed + +- Update broken link in `gradle.properties` +- GitHub Actions — use `$BRANCH` for creating changelog pull request + +## [1.2.0] - 2022-08-07 + +### Added + +- Use JVM toolchain for configuring source/target compilation compatibility +- Make sure GitHub Actions release jobs have write permissions +- Example implementation: Add `TODO()` with a hint to remove stale sample code +- Exclude `.qodana` directory from Qodana analysis +- Maximize disk space on GitHub Actions + +### Changed + +- Upgrade Gradle Wrapper to `7.5.1` +- Update `platformVersion` to `2021.3.3` +- Change since/until build to `213-222.*` (2021.3-2022.2) +- Dependencies - upgrade `org.jetbrains.intellij` to `1.8.0` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.10` +- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `3` +- Dependencies (GitHub Actions) - upgrade `actions/cache` to `3` +- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `3` +- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `3` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.1` + +### Fixed + +- Pass Plugin Signing secrets as environment variables in the Release workflow + +### Removed + +- Removed Gradle caching from GitHub Actions + +## [1.1.2] - 2022-02-11 + +### Changed + +- Update `platformVersion` to `2021.1.3` for compatibility with Apple M1 +- Change since/until build to `211-213.*` (2021.1-2021.3) +- Upgrade Gradle Wrapper to `7.4` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.4.0` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.5` + +## [1.1.1] - 2022-01-24 + +### Changed + +- GitHub Actions — fixed duplicated `.zip` extension in artifact file's name of the build flow +- Upgrade Gradle Wrapper to `7.3.3` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.1` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.10` +- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.3` +- Dependencies (GitHub Actions) - upgrade `actions/cache` to `2.1.7` + +## [1.1.0] - 2021-11-16 + +### Added + +- GitHub Actions: Collect Qodana/Tests/Plugin Verifier results as artifacts + +### Changed + +- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.0` +- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.1` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.0` +- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `2` +- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `2.3.5` +- GitHub Actions general performance refactoring +- GitHub Actions — prepare plugin archive content to be archived at once +- GitHub Actions — patch changelog only if change notes are provided +- Update `pluginUntilBuild` to include `213.*` (2021.3.*) +- Upgrade Gradle Wrapper to `7.3` + +### Fixed + +- Fixed passing change notes from `CHANGELOG.md` to the Release Draft +- Fixed passing updated change notes from the Release Draft to `patchChangelog` Gradle task +- Fixed `QODANA_SHOW_REPORT` environment variable resolving for Gradle `6.x` + +### Removed + +- Removed the `pluginVerifierIdeVersions` configuration to use a default IDEs list provided by the `listProductsReleases` task for `runPluginVerifier` +- Removed `platformDownloadSources` from Gradle configuration to use default value +- Removed `updateSinceUntilBuild.set(true)` from Gradle configuration to use default value + +## [1.0.0] - 2021-09-07 + +### Added + +- Plugin Signing +- Qodana integration +- Functional tests +- Compatibility with Java 11 +- `Run Qodana` and `Run IDE for UI Tests` run configurations +- Use Gradle `wrapper` task to handle Gradle updates +- JVM compatibility version extracted to `gradle.properties` file +- Suppress `UnusedProperty` inspection for the `kotlin.stdlib.default.dependency` in `gradle.properties` + +### Changed + +- GitHub Actions: Switch to Java 11 +- GitHub Actions: Update Build and Release flows +- GitHub Actions: Use Gradle cache provided with `actions/setup-java` +- Update `pluginVerifierIdeVersions` to `2020.3.4, 2021.1.3, 2021.2.1` +- Change since/until build to `203-212.*` +- Upgrade Gradle Wrapper to `7.2` +- Gradle – Changelog plugin configuration update +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.30` +- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.0` +- Dependencies - upgrade `org.jetbrains.intellij` to `1.1.6` +- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.4` + +### Fixed + +- Use `DynamicBundle` instead of `AbstractBundle` in `MyBundle.kt` + +### Removed + +- Removed `detekt`/`ktlint` integration + +## [0.10.1] - 2021-05-31 + +### Added + +- Introduced `next` branch in the root repository to make `main` always a stable one + +### Changed + +- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.6` +- Trigger GitHub Actions `Build` workflows only on pushes to `main` branch or pull request to avoid duplicated checks + +## [0.10.0] - 2021-05-27 + +### Changed + +- Remove reference to the `jcenter()` from Gradle configuration file +- Update `pluginVerifierIdeVersions` to `2020.2.4, 2020.3.4, 2021.1.2` +- Update `pluginUntilBuild` to include `211.*` (2021.1.*) +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.10` +- Dependencies - upgrade `detekt-formatting from` to `1.17.1` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.17.1` +- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.5` +- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v2.3.4` +- Dependencies (GitHub Actions) - upgrade `actions/upload-release-asset` to `v1.0.2` +- Dependencies (GitHub Actions) - upgrade `actions/create-release` to `v1.1.4` +- Upgrade Gradle Wrapper to `7.0.2` + +## [0.9.0] - 2021-03-29 + +### Added + +- `properties` shorthand function for accessing `gradle.properties` in a cleaner way +- Dependabot check for GitHub Actions used in [workflow files](.github/workflows) + +### Changed + +- Dependencies - upgrade `detekt-formatting from` to `1.16.0` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.16.0` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.32` +- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.2` +- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.4` + +### Fixed + +- Fix `README.md` file resolution in the `build.gradle.kts` + +## [0.8.3] - 2021-02-23 + +### Changed + +- Dependencies - upgrade `org.jetbrains.intellij` to `0.7.2` +- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `10.0.0` +- Update `platformVersion` to `2020.2.4` for compatibility with macOS Big Sur +- Upgrade Gradle Wrapper to `6.8.3` + +## [0.8.2] - 2021-02-09 + +### Changed + +- Use `-bin` distribution of the Gradle Wrapper +- Upgrade Gradle Wrapper to `6.8.2` +- Update `pluginVerifierIdeVersions` in `gradle.properties` files +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.30` +- Dependencies - upgrade `org.jetbrains.changelog` to `1.1.1` +- Configure the `changelog` Gradle plugin + +## [0.8.1] - 2021-01-12 + +### Added + +- README: Dependencies management section + +### Changed + +- Upgrade Gradle Wrapper to `6.8` +- Dependencies - upgrade `org.jetbrains.changelog` to `1.0.0` + +### Fixed + +- Template Cleanup: Escape GitHub username to avoid incorrect characters in class package name +- Template Cleanup: Run `ktlintFormat` task to fix imports order +- GitHub Actions: Use the correct property in the "Upload artifact" step + +## [0.8.0] - 2020-12-21 + +### Added + +- Dependabot integration +- Show `idea.log` logs of the run IDE in the Run console +- README: FAQ section + +### Changed + +- `build.gradle.kts`: simpler syntax for configuring `KotlinCompile` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.21` +- Dependencies - upgrade `detekt-formatting` to `1.15.0` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.15.0` +- README: Clarifying the Java usage in the project +- `pluginVerifierIdeVersions` - upgrade to `2020.1.4, 2020.2.3, 2020.3.1` + +### Fixed + +- Return `Supplier<@Nls String>` instead of `String` in `MyBundle.messagePointer` + +## [0.7.1] - 2020-12-02 + +### Changed + +- Upgrade Gradle Wrapper to `6.7.1` +- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.5` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.20` +- Update the base platform version to 2020.1 +- Change since/until build to `201-203.*` + +## [0.7.0] - 2020-11-16 + +### Added + +- Predefined Run/Debug Configurations +- Project icon for development purposes + +### Changed + +- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.3` + +## [0.6.1] - 2020-11-05 + +### Added + +- GitHub Actions — use hash based on `pluginVerifierIdeVersions` in `Setup Plugin Verifier IDEs Cache` step + +### Changed + +- Use [Kotlin extension function](https://plugins.jetbrains.com/docs/intellij/plugin-services.html#retrieving-a-service) to retrieve the `MyProjectService` in the `MyProjectManagerListener` +- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.2` +- Update `pluginVerifierIdeVersions` in the `gradle.properties` files + +## [0.6.0] - 2020-10-29 + +### Added + +- Integration with [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) through the [Gradle IntelliJ Plugin](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#runpluginverifier-task) `runPluginVerifier` task +- Cache downloaded IDEs used by Plugin Verifier for the verification + +### Changed + +- Switch Gradle Wrapper to `-all` to improve the IntelliSense +- Update detekt config to be in line with IJ settings +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.2` +- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.1` +- GitHub Actions — `gradleValidation` update to `gradle/wrapper-validation-action@v1.0.3` +- GitHub Actions — `releaseDraft` update to `actions/download-artifact@v2` + +### Removed + +- Remove Third-party IntelliJ Plugin Verifier GitHub Action + +## [0.5.1] - 2020-10-15 + +### Added + +- Missing properties in the `gradle.properties` template file + +### Changed + +- Upgrade Gradle Wrapper to `6.7` +- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.2` + +## [0.5.0] - 2020-10-12 + +### Added + +- Introduced `platformPlugins` property in `gradle.properties` for configuring dependencies to bundled/external plugins + +### Changed + +- Disable "Release Draft" job for pull requests in the "Build" GitHub Actions Workflow +- Dependencies - upgrade `org.jetbrains.intellij` to `0.5.0` +- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.1` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.1` +- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.1` +- Remove LICENSE file during the Template Cleanup workflow + +## [0.4.0] - 2020-10-02 + +### Added + +- Fix default to opt-out of bundling Kotlin standard library in plugin distribution + +### Changed + +- GitHub Actions: allow releasing plugin even for the base project +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.10` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.13.1` + +### Fixed + +- `pluginName` variable name collision with `intellij` closure getter in Gradle configuration #29 + +## [0.3.2] - 2020-08-09 + +### Changed + +- Simplify and optimize GitHub Actions +- Gradle Wrapper upgrade to `6.6.1` +- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.0` +- Dependencies - upgrade `org.jetbrains.intellij` to `0.4.22` +- Dependencies - upgrade `org.jetbrains.changelog` to `0.5.0` +- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.12.0` +- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.0` +- Rename `master` branch to `main` + +### Fixed + +- GitHub Actions — cache Gradle dependencies and wrapper separately + +## [0.3.1] - 2020-07-31 + +### Added + +- Better handling of the Gradle plugin description extraction from the README file +- GitHub Actions — cache Gradle Wrapper + +### Changed + +- Gradle - remove kotlin("stdlib-jdk8") dependency to decrease the plugin artifact size +- Dependencies - bump ktlint to `9.3.0` +- GitHub Actions — make *Update Changelog* job dependent on the *Publish Plugin* +- GitHub Actions — run plugin verifier against `2019.3` `2020.1` `2020.2` + +### Fixed + +- Resolve ktlint reports +- GitHub Actions — Plugin Verifier broken for artifacts with spaces in name + +## [0.3.0] - 2020-07-07 + +### Added + +- Set the publishing channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel + +### Changed + +- Update `org.jetbrains.changelog` dependency to `v0.3.3` +- Update Gradle Wrapper to `v6.5.1` +- Run GitHub Actions Release workflow on `prereleased` event +- GitHub Actions — Release, separate changelog-related job from the release + +### Fixed + +- Remove vendor website from `plugin.xml` +- Update Template Cleanup workflow test to avoid running it on forks + +## [0.2.0] - 2020-07-02 + +### Added + +- JetBrains Plugin badges and TODO list for the end users +- `ktlint` integration + +### Changed + +- `pluginUntilBuild` set to the correct format: `201.*` +- Bump detekt dependency to `1.10.0` + +### Fixed + +- GitHub Actions — Template Cleanup, fixed adding files to git +- Update Template plugin name on cleanup +- Set `buildUponDefaultConfig = true` in detekt configuration + +## [0.1.0] - 2020-06-26 + +### Added + +- `settings.gradle.kts` for the [performance purposes](https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#always_define_a_settings_file) +- `#REMOVE-ON-CLEANUP#` token to mark content to be removed with **Template Cleanup** workflow + +### Changed + +- README proofreading +- GitHub Actions — Update IDE versions for the Plugin Verifier +- Update platformVersion to `2020.1.2` + +## [0.0.2] - 2020-06-22 + +### Added + +- [Gradle Changelog Plugin](https://github.com/JetBrains/gradle-changelog-plugin) integration + +### Changed + +- Bump Detekt version +- Change pluginSinceBuild to 193 + +## [0.0.1] + +### Added + +- Initial project scaffold +- GitHub Actions to automate testing and deployment +- Kotlin support + +[Unreleased]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.11.2...HEAD +[1.11.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.11.1...v1.11.2 +[1.11.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.11.0...v1.11.1 +[1.11.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.10.0...v1.11.0 +[1.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.9.0...v1.10.0 +[1.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.8.0...v1.9.0 +[1.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.7.0...v1.8.0 +[1.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.6.0...v1.7.0 +[1.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.5.0...v1.6.0 +[1.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.4.0...v1.5.0 +[1.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.3.0...v1.4.0 +[1.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.2.0...v1.3.0 +[1.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.1.2...v1.2.0 +[1.1.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.1.1...v1.1.2 +[1.1.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.1.0...v1.1.1 +[1.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.0.0...v1.1.0 +[1.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.10.1...v1.0.0 +[0.10.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.10.0...v0.10.1 +[0.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.9.0...v0.10.0 +[0.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.8.3...v0.9.0 +[0.8.3]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.8.2...v0.8.3 +[0.8.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.8.1...v0.8.2 +[0.8.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.8.0...v0.8.1 +[0.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.7.1...v0.8.0 +[0.7.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.7.0...v0.7.1 +[0.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.6.1...v0.7.0 +[0.6.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.6.0...v0.6.1 +[0.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.5.1...v0.6.0 +[0.5.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.5.0...v0.5.1 +[0.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.4.0...v0.5.0 +[0.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.3.2...v0.4.0 +[0.3.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.3.1...v0.3.2 +[0.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.3.0...v0.3.1 +[0.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.2.0...v0.3.0 +[0.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.1.0...v0.2.0 +[0.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v0.0.2...v0.1.0 +[0.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/commits/v0.0.2 +[0.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/commits diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..85ed20d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,4 @@ +## Code of Conduct + +This project and the corresponding community is governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it. + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..77057df --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2000-2021 JetBrains s.r.o. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7f8cce --- /dev/null +++ b/README.md @@ -0,0 +1,630 @@ +# IntelliJ Platform Plugin Template + +[![official JetBrains project](https://jb.gg/badges/official.svg)][jb:github] +[![Twitter Follow](https://img.shields.io/badge/follow-%40JBPlatform-1DA1F2?logo=twitter)](https://twitter.com/JBPlatform) +[![Build](https://github.com/JetBrains/intellij-platform-plugin-template/workflows/Build/badge.svg)][gh:build] +[![Slack](https://img.shields.io/badge/Slack-%23intellij--platform-blue?style=flat-square&logo=Slack)](https://plugins.jetbrains.com/slack) + +![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-dark] +![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-light] + +> **Note** +> +> Click the Use this template button and clone it in IntelliJ IDEA. + + +**IntelliJ Platform Plugin Template** is a repository that provides a pure template to make it easier to create a new plugin project (check the [Creating a repository from a template][gh:template] article). + +The main goal of this template is to speed up the setup phase of plugin development for both new and experienced developers by preconfiguring the project scaffold and CI, linking to the proper documentation pages, and keeping everything organized. + +[gh:template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template + + +If you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro] + +> **Note** +> +> Click the Watch button on the top to be notified about releases containing new features and fixes. + +### Table of contents + +In this README, we will highlight the following elements of template-project creation: + +- [Getting started](#getting-started) +- [Gradle configuration](#gradle-configuration) +- [Plugin template structure](#plugin-template-structure) +- [Plugin configuration file](#plugin-configuration-file) +- [Sample code](#sample-code): + - listeners – project lifecycle listener + - services – project and application-level services +- [Testing](#testing) + - [Functional tests](#functional-tests) + - [Code coverage](#code-coverage) + - [UI tests](#ui-tests) +- [Qodana integration](#qodana-integration) +- [Predefined Run/Debug configurations](#predefined-rundebug-configurations) +- [Continuous integration](#continuous-integration) based on GitHub Actions + - [Dependencies management](#dependencies-management) with Dependabot + - [Changelog maintenance](#changelog-maintenance) with the Gradle Changelog Plugin + - [Release flow](#release-flow) using GitHub Releases + - [Plugin signing](#plugin-signing) with your private certificate + - [Publishing the plugin](#publishing-the-plugin) with the Gradle IntelliJ Plugin +- [FAQ](#faq) +- [Useful links](#useful-links) + + +## Getting started + +Before we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Templates. +By creating a new project using the current template, you start with no history or reference to this repository. +This allows you to create a new repository easily without copying and pasting previous content, clone repositories, or clearing the history manually. + +All you have to do is click the Use this template button (you must be logged in with your GitHub account). + +![Use this template][file:use-this-template.png] + +After using the template to create your blank project, the [Template Cleanup][file:template_cleanup.yml] workflow will be triggered to override or remove any template-specific configurations, such as the plugin name, current changelog, etc. +Once this is complete, the project is ready to be cloned to your local environment and opened with [IntelliJ IDEA][jb:download-ij]. + +The most convenient way for getting your new project from GitHub is the Get from VCS action available on the Welcome Screen, where you can filter your GitHub repository by its name. + +![Get from Version Control][file:get-from-version-control] + +The next step, after opening your project in IntelliJ IDEA, is to set the proper SDK to Java in version `17` within the [Project Structure settings][docs:project-structure-settings]. + +![Project Structure — SDK][file:project-structure-sdk.png] + +For the last step, you have to manually review the configuration variables described in the [`gradle.properties`][file:gradle.properties] file and *optionally* move sources from the *com.github.username.repository* package to the one that works best for you. +Then you can get to work implementing your ideas. + +> **Note** +> +> To use Java in your plugin, create the `/src/main/java` directory. + + +## Gradle configuration + +The recommended method for plugin development involves using the [Gradle][gradle] setup with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] installed. +The `gradle-intellij-plugin` makes it possible to run the IDE with your plugin and publish your plugin to JetBrains Marketplace. + +> **Note** +> +> Make sure to always upgrade to the latest version of `gradle-intellij-plugin`. + +A project built using the IntelliJ Platform Plugin Template includes a Gradle configuration already set up. +Feel free to read through the [Using Gradle][docs:using-gradle] articles to understand your build better and learn how to customize it. + +The most significant parts of the current configuration are: +- Integration with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] for smoother development. +- Configuration written with [Gradle Kotlin DSL][gradle:kotlin-dsl]. +- Support for Kotlin and Java implementation. +- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes based on the `CHANGELOG.md` file. +- [Plugin publishing][docs:publishing] using the token. + +For more details regarding Kotlin integration, please see [Kotlin for Plugin Developers][docs:kotlin] in the IntelliJ Platform Plugin SDK documentation. + +### Gradle properties + +The project-specific configuration file [`gradle.properties`][file:gradle.properties] contains: + +| Property name | Description | +|-----------------------|-----------------------------------------------------------------------------------------------------------| +| `pluginGroup` | Package name - after *using* the template, this will be set to `com.github.username.repo`. | +| `pluginName` | Plugin name displayed in JetBrains Marketplace. | +| `pluginRepositoryUrl` | Repository URL used for generating URLs by the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] | +| `pluginVersion` | The current version of the plugin in [SemVer][semver] format. | +| `pluginSinceBuild` | The `since-build` attribute of the `` tag. | +| `pluginUntilBuild` | The `until-build` attribute of the `` tag. | +| `platformType` | The type of IDE distribution. | +| `platformVersion` | The version of the IntelliJ Platform IDE will be used to build the plugin. | +| `platformPlugins` | Comma-separated list of dependencies to the bundled IDE plugins and plugins from the Plugin Repositories. | +| `gradleVersion` | Version of Gradle used for plugin development. | + +The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details. + +In addition, extra behaviors are configured through the [`gradle.properties`][file:gradle.properties] file, such as: + +| Property name | Value | Description | +|--------------------------------------------------|---------|------------------------------------------------------------------------------------------------| +| `kotlin.stdlib.default.dependency` | `false` | Opt-out flag for bundling [Kotlin standard library][docs:kotlin-stdlib] | +| `org.gradle.configuration-cache` | `true` | Enable [Gradle Configuration Cache][gradle:configuration-cache] | +| `org.gradle.caching` | `true` | Enable [Gradle Build Cache][gradle:build-cache] | +| `systemProp.org.gradle.unsafe.kotlin.assignment` | `true` | Enable [Gradle Kotlin DSL Lazy Property Assignment][gradle:kotlin-dsl-assignment] | + +### Environment variables + +Some values used for the Gradle configuration shouldn't be stored in files to avoid publishing them to the Version Control System. + +To avoid that, environment variables are introduced, which can be provided within the *Run/Debug Configuration* within the IDE, or on the CI – like for GitHub: `⚙️ Settings > Secrets`. + +Environment variables used by the current project are related to the [plugin signing](#plugin-signing) and [publishing](#publishing-the-plugin). + +| Environment variable name | Description | +|---------------------------|--------------------------------------------------------------------------------------------------------------| +| `PRIVATE_KEY` | Certificate private key, should contain: `-----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY-----` | +| `PRIVATE_KEY_PASSWORD` | Password used for encrypting the certificate file. | +| `CERTIFICATE_CHAIN` | Certificate chain, should contain: `-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----` | +| `PUBLISH_TOKEN` | Publishing token generated in your JetBrains Marketplace profile dashboard. | + +For more details on how to generate proper values, check the relevant sections mentioned above. + +To configure GitHub secret environment variables, go to the `⚙️ Settings > Secrets` section of your project repository: + +![Settings > Secrets][file:settings-secrets.png] + +## Plugin template structure + +A generated IntelliJ Platform Plugin Template repository contains the following content structure: + +``` +. +├── .github/ GitHub Actions workflows and Dependabot configuration files +├── .run/ Predefined Run/Debug Configurations +├── build/ Output build directory +├── gradle +│ ├── wrapper/ Gradle Wrapper +│ └── libs.versions.toml Gradle version catalog +├── src Plugin sources +│ ├── main +│ │ ├── kotlin/ Kotlin production sources +│ │ └── resources/ Resources - plugin.xml, icons, messages +│ └── test +│ ├── kotlin/ Kotlin test sources +│ └── testData/ Test data used by tests +├── .gitignore Git ignoring rules +├── build.gradle.kts Gradle configuration +├── CHANGELOG.md Full change history +├── gradle.properties Gradle configuration properties +├── gradlew *nix Gradle Wrapper script +├── gradlew.bat Windows Gradle Wrapper script +├── LICENSE License, MIT by default +├── qodana.yml Qodana configuration file +├── README.md README +└── settings.gradle.kts Gradle project settings +``` + +In addition to the configuration files, the most crucial part is the `src` directory, which contains our implementation and the manifest for our plugin – [plugin.xml][file:plugin.xml]. + +> **Note** +> +> To use Java in your plugin, create the `/src/main/java` directory. + + +## Plugin configuration file + +The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` directory. +It provides general information about the plugin, its dependencies, extensions, and listeners. + +```xml + + org.jetbrains.plugins.template + Template + JetBrains + + com.intellij.modules.platform + + messages.MyBundle + + + + + + + + + +``` + +You can read more about this file in the [Plugin Configuration File][docs:plugin.xml] section of our documentation. + + +## Sample code + +The prepared template provides as little code as possible because it is impossible for a general scaffold to fulfill all the specific requirements for all types of plugins (language support, build tools, VCS related tools). +Therefore, the template contains only the following files: + +``` +. +├── listeners +│ └── MyApplicationActivationListener.kt Application activation listener — detects when IDE frame is activated +├── services +│ └── MyProjectService.kt Project level service +├── toolWindow +│ └── MyToolWindowFactory.kt Tool window factory — creates tool window content +└── MyBundle.kt Bundle class providing access to the resources messages +``` + +These files are located in `src/main/kotlin`. +This location indicates the language being used. +So if you decide to use Java instead (or in addition to Kotlin), these sources should be located in the `src/main/java` directory. + +To start with the actual implementation, you may check our [IntelliJ Platform SDK DevGuide][docs], which contains an introduction to the essential areas of the plugin development together with dedicated tutorials. + +> **Warning** +> +> Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`. + +For those who value example codes the most, there are also available [IntelliJ SDK Code Samples][gh:code-samples] and [IntelliJ Platform Explorer][jb:ipe] – a search tool for browsing Extension Points inside existing implementations of open-source IntelliJ Platform plugins. + + +## Testing + +[Testing plugins][docs:testing-plugins] is an essential part of the plugin development to make sure that everything works as expected between IDE releases and plugin refactorings. +The IntelliJ Platform Plugin Template project provides integration of two testing approaches – functional and UI tests. + +### Functional tests + +Most of the IntelliJ Platform codebase tests are model-level, run in a headless environment using an actual IDE instance. +The tests usually test a feature as a whole rather than individual functions that comprise its implementation, like in unit tests. + +In `src/test/kotlin`, you'll find a basic `MyPluginTest` test that utilizes `BasePlatformTestCase` and runs a few checks against the XML files to indicate an example operation of creating files on the fly or reading them from `src/test/testData/rename` test resources. + +> **Note** +> +> Run your tests using predefined *Run Tests* configuration or by invoking the `./gradlew check` Gradle task. + +### Code coverage + +The [Kover][gh:kover] – a Gradle plugin for Kotlin code coverage agents: IntelliJ and JaCoCo – is integrated into the project to provide the code coverage feature. +Code coverage makes it possible to measure and track the degree of plugin sources testing. +The code coverage gets executed when running the `check` Gradle task. +The final test report is sent to [CodeCov][codecov] for better results visualization. + +### UI tests + +If your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they utilize. + +[IntelliJ UI Test Robot][gh:intellij-ui-test-robot] allows you to write and execute UI tests within the IntelliJ IDE running instance. +You can use the [XPath query language][xpath] to find components in the currently available IDE view. +Once IDE with `robot-server` has started, you can open the `http://localhost:8082` page that presents the currently available IDEA UI components hierarchy in HTML format and use a simple `XPath` generator, which can help test your plugin's interface. + +> **Note** +> +> Run IDE for UI tests using predefined *Run IDE for UI Tests* and then *Run Tests* configurations or by invoking the `./gradlew runIdeForUiTests` and `./gradlew check` Gradle tasks. + +Check the UI Test Example project you can use as a reference for setting up UI testing in your plugin: [intellij-ui-test-robot/ui-test-example][gh:ui-test-example]. + +```kotlin +class MyUITest { + + @Test + fun openAboutFromWelcomeScreen() { + val robot = RemoteRobot("http://127.0.0.1:8082") + robot.find(byXpath("//div[@myactionlink = 'gearHover.svg']")).click() + // ... + } +} +``` + +![UI Testing][file:ui-testing.png] + +A dedicated [Run UI Tests](.github/workflows/run-ui-tests.yml) workflow is available for manual triggering to run UI tests against three different operating systems: macOS, Windows, and Linux. +Due to its optional nature, this workflow isn't set as an automatic one, but this can be easily achieved by changing the `on` trigger event, like in the [Build](.github/workflows/build.yml) workflow file. + +## Qodana integration + +To increase the project value, the IntelliJ Platform Plugin Template got integrated with [Qodana][jb:qodana], a code quality monitoring platform that allows you to check the condition of your implementation and find any possible problems that may require enhancing. + +Qodana brings into your CI/CD pipelines all the smart features you love in the JetBrains IDEs and generates an HTML report with the actual inspection status. + +Qodana inspections are accessible within the project on two levels: + +- using the [Qodana IntelliJ GitHub Action][jb:qodana-github-action], run automatically within the [Build](.github/workflows/build.yml) workflow, +- with the [Gradle Qodana Plugin][gh:gradle-qodana-plugin], so you can use it on the local environment or any CI other than GitHub Actions. + +Qodana inspection is configured with the `qodana { ... }` section in the Gradle build file and [`qodana.yml`][file:qodana.yml] YAML configuration file. + +> **Note** +> +> Qodana requires Docker to be installed and available in your environment. + +To run inspections, you can use a predefined *Run Qodana* configuration, which will provide a full report on `http://localhost:8080`, or invoke the Gradle task directly with the `./gradlew runInspections` command. + +A final report is available in the `./build/reports/inspections/` directory. + +![Qodana][file:qodana.png] + + +## Predefined Run/Debug configurations + +Within the default project structure, there is a `.run` directory provided containing predefined *Run/Debug configurations* that expose corresponding Gradle tasks: + +![Run/Debug configurations][file:run-debug-configurations.png] + +| Configuration name | Description | +|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Run Plugin | Runs [`:runIde`][gh:gradle-intellij-plugin-runIde] Gradle IntelliJ Plugin task. Use the *Debug* icon for plugin debugging. | +| Run Verifications | Runs [`:runPluginVerifier`][gh:gradle-intellij-plugin-runPluginVerifier] Gradle IntelliJ Plugin task to check the plugin compatibility against the specified IntelliJ IDEs. | +| Run Tests | Runs [`:test`][gradle:lifecycle-tasks] Gradle task. | +| Run IDE for UI Tests | Runs [`:runIdeForUiTests`][gh:intellij-ui-test-robot] Gradle IntelliJ Plugin task to allow for running UI tests within the IntelliJ IDE running instance. | +| Run Qodana | Runs [`:runInspections`][gh:gradle-qodana-plugin] Gradle Qodana Plugin task. Starts Qodana inspections in a Docker container and serves generated report on `localhost:8080`. | + +> **Note** +> +> You can find the logs from the running task in the `idea.log` tab. +> +> ![Run/Debug configuration logs][file:run-logs.png] + + +## Continuous integration + +Continuous integration depends on [GitHub Actions][gh:actions], a set of workflows that make it possible to automate your testing and release process. +Thanks to such automation, you can delegate the testing and verification phases to the Continuous Integration (CI) and instead focus on development (and writing more tests). + +In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows: + +- [Build](.github/workflows/build.yml) + - Triggered on `push` and `pull_request` events. + - Runs the *Gradle Wrapper Validation Action* to verify the wrapper's checksum. + - Runs the `verifyPlugin` and `test` Gradle tasks. + - Builds the plugin with the `buildPlugin` Gradle task and provides the artifact for the next jobs in the workflow. + - Verifies the plugin using the *IntelliJ Plugin Verifier* tool. + - Prepares a draft release of the GitHub Releases page for manual verification. +- [Release](.github/workflows/release.yml) + - Triggered on `released` event. + - Updates `CHANGELOG.md` file with the content provided with the release note. + - Signs the plugin with a provided certificate before publishing. + - Publishes the plugin to JetBrains Marketplace using the provided `PUBLISH_TOKEN`. + - Sets publish channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel. + - Patches the Changelog and commits. +- [Run UI Tests](.github/workflows/run-ui-tests.yml) + - Triggered manually. + - Runs for macOS, Windows, and Linux separately. + - Runs `runIdeForUiTests` and `test` Gradle tasks. +- [Template Cleanup](.github/workflows/template-cleanup.yml) + - Triggered once on the `push` event when a new template-based repository has been created. + - Overrides the scaffold with files from the `.github/template-cleanup` directory. + - Overrides JetBrains-specific sentences or package names with ones specific to the target repository. + - Removes redundant files. + +All the workflow files have accurate documentation, so it's a good idea to take a look through their sources. + +### Dependencies management + +This Template project depends on Gradle plugins and external libraries – and during the development, you will add more of them. + +All plugins and dependencies used by Gradle are managed with [Gradle version catalog][gradle:version-catalog], which defines versions and coordinates of your dependencies in the [`gradle/libs.versions.toml`][file:libs.versions.toml] file. + +> **Note** +> +> To add a new dependency to the project, in the `dependencies { ... }` block, add: +> +> ```kotlin +> dependencies { +> implementation(libs.annotations) +> } +> ``` +> +> and define the dependency in the [`gradle/libs.versions.toml`][file:libs.versions.toml] file as follows: +> ```toml +> [versions] +> annotations = "24.0.1" +> +> [libraries] +> annotations = { group = "org.jetbrains", name = "annotations", version.ref = "annotations" } +> ``` + +Keeping the project in good shape and having all the dependencies up-to-date requires time and effort, but it is possible to automate that process using [Dependabot][gh:dependabot]. + +Dependabot is a bot provided by GitHub to check the build configuration files and review any outdated or insecure dependencies of yours – in case if any update is available, it creates a new pull request providing [the proper change][gh:dependabot-pr]. + +> **Note** +> +> Dependabot doesn't yet support checking of the Gradle Wrapper. +> Check the [Gradle Releases][gradle:releases] page and update your `gradle.properties` file with: +> ```properties +> gradleVersion = ... +> ``` +> and run +> ```bash +> ./gradlew wrapper +> ``` + +### Changelog maintenance + +When releasing an update, it is essential to let your users know what the new version offers. +The best way to do this is to provide release notes. + +The changelog is a curated list that contains information about any new features, fixes, and deprecations. +When they're provided, these lists are available in a few different places: +- the [CHANGELOG.md](./CHANGELOG.md) file, +- the [Releases page][gh:releases], +- the *What's new* section of JetBrains Marketplace Plugin page, +- and inside the Plugin Manager's item details. + +There are many methods for handling the project's changelog. +The one used in the current template project is the [Keep a Changelog][keep-a-changelog] approach. + +The [Gradle Changelog Plugin][gh:gradle-changelog-plugin] takes care of propagating information provided within the [CHANGELOG.md](./CHANGELOG.md) to the [Gradle IntelliJ Plugin][gh:gradle-intellij-plugin]. +You only have to take care of writing down the actual changes in proper sections of the `[Unreleased]` section. + +You start with an almost empty changelog: + +``` +# YourPlugin Changelog + +## [Unreleased] +### Added +- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) +``` + +Now proceed with providing more entries to the `Added` group, or any other one that suits your change the most (see [How do I make a good changelog?][keep-a-changelog-how] for more details). + +When releasing a plugin update, you don't have to care about bumping the `[Unreleased]` header to the upcoming version – it will be handled automatically on the Continuous Integration (CI) after you publish your plugin. +GitHub Actions will swap it and provide you an empty section for the next release so that you can proceed with your development: + +``` +# YourPlugin Changelog + +## [Unreleased] + +## [0.0.1] +### Added +- An awesome feature +- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) + +### Fixed +- One annoying bug +``` + +To configure how the Changelog plugin behaves, i.e., to create headers with the release date, see [Gradle Changelog Plugin][gh:gradle-changelog-plugin] README file. + +### Release flow + +The release process depends on the workflows already described above. +When your main branch receives a new pull request or a direct push, the [Build](.github/workflows/build.yml) workflow runs multiple tests on your plugin and prepares a draft release. + +![Release draft][file:draft-release.png] + +The draft release is a working copy of a release, which you can review before publishing. +It includes a predefined title and git tag, the current plugin version, for example, `v0.0.1`. +The changelog is provided automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin]. +An artifact file is also built with the plugin attached. +Every new Build overrides the previous draft to keep your *Releases* page clean. + +When you edit the draft and use the Publish release button, GitHub will tag your repository with the given version and add a new entry to the Releases tab. +Next, it will notify users who are *watching* the repository, triggering the final [Release](.github/workflows/release.yml) workflow. + +### Plugin signing + +Plugin Signing is a mechanism introduced in the 2021.2 release cycle to increase security in [JetBrains Marketplace](https://plugins.jetbrains.com) and all of our IntelliJ-based IDEs. + +JetBrains Marketplace signing is designed to ensure that plugins aren't modified over the course of the publishing and delivery pipeline. + +The current project provides a predefined plugin signing configuration that lets you sign and publish your plugin from the Continuous Integration (CI) and local environments. +All the configuration related to the signing should be provided using [environment variables](#environment-variables). + +To find out how to generate signing certificates, check the [Plugin Signing][docs:plugin-signing] section in the IntelliJ Platform Plugin SDK documentation. + +> **Note** +> +> Remember to encode your secret environment variables using `base64` encoding to avoid issues with multi-line values. + +### Publishing the plugin + +Releasing a plugin to JetBrains Marketplace is a straightforward operation that uses the `publishPlugin` Gradle task provided by the [gradle-intellij-plugin][gh:gradle-intellij-plugin-docs]. +In addition, the [Release](.github/workflows/release.yml) workflow automates this process by running the task when a new release appears in the GitHub Releases section. + +> **Note** +> +> Set a suffix to the plugin version to publish it in the custom repository channel, i.e. `v1.0.0-beta` will push your plugin to the `beta` [release channel][docs:release-channel]. + +The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the _Secrets_ section of the repository _Settings_. + +You can get that token in your JetBrains Marketplace profile dashboard in the [My Tokens][jb:my-tokens] tab. + +> **Warning** +> +> Before using the automated deployment process, it is necessary to manually create a new plugin in JetBrains Marketplace to specify options like the license, repository URL, etc. +> Please follow the [Publishing a Plugin][docs:publishing] instructions. + + +## FAQ + +### How to use Java in my project? + +Java language is supported by default along with Kotlin. +Initially, the `/src/main/kotlin` directory is available with minimal examples. +You can still replace it or add the `/src/main/java` directory to start working with Java language instead. + +### How to disable *tests* or *build* job using the `[skip ci]` commit message? + +Since February 2021, GitHub Actions [support the skip CI feature][github-actions-skip-ci]. +If the message contains one of the following strings: `[skip ci]`, `[ci skip]`, `[no ci]`, `[skip actions]`, or `[actions skip]` – workflows will not be triggered. + +### Why draft release no longer contains built plugin artifact? + +All the binaries created with each workflow are still available, but as an output artifact of each run together with tests and Qodana results. +That approach gives more possibilities for testing and debugging pre-releases, for example, in your local environment. + +## Useful links + +- [IntelliJ Platform SDK Plugin SDK][docs] +- [Gradle IntelliJ Plugin Documentation][gh:gradle-intellij-plugin-docs] +- [IntelliJ Platform Explorer][jb:ipe] +- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines] +- [IntelliJ Platform UI Guidelines][jb:ui-guidelines] +- [JetBrains Marketplace Paid Plugins][jb:paid-plugins] +- [Kotlin UI DSL][docs:kotlin-ui-dsl] +- [IntelliJ SDK Code Samples][gh:code-samples] +- [JetBrains Platform Slack][jb:slack] +- [JetBrains Platform Twitter][jb:twitter] +- [IntelliJ IDEA Open API and Plugin Development Forum][jb:forum] +- [Keep a Changelog][keep-a-changelog] +- [GitHub Actions][gh:actions] + +[docs]: https://plugins.jetbrains.com/docs/intellij?from=IJPluginTemplate +[docs:intellij-platform-kotlin-oom]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html#incremental-compilation +[docs:intro]: https://plugins.jetbrains.com/docs/intellij/intellij-platform.html?from=IJPluginTemplate +[docs:kotlin-ui-dsl]: https://plugins.jetbrains.com/docs/intellij/kotlin-ui-dsl-version-2.html?from=IJPluginTemplate +[docs:kotlin]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate +[docs:kotlin-stdlib]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate#kotlin-standard-library +[docs:plugin.xml]: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html?from=IJPluginTemplate +[docs:publishing]: https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate +[docs:release-channel]: https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate#specifying-a-release-channel +[docs:using-gradle]: https://plugins.jetbrains.com/docs/intellij/developing-plugins.html?from=IJPluginTemplate +[docs:plugin-signing]: https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate +[docs:project-structure-settings]: https://www.jetbrains.com/help/idea/project-settings-and-structure.html +[docs:testing-plugins]: https://plugins.jetbrains.com/docs/intellij/testing-plugins.html?from=IJPluginTemplate + +[file:draft-release.png]: ./.github/readme/draft-release.png +[file:get-from-version-control]: ./.github/readme/get-from-version-control.png +[file:gradle.properties]: ./gradle.properties +[file:intellij-platform-plugin-template-dark]: ./.github/readme/intellij-platform-plugin-template-dark.svg#gh-dark-mode-only +[file:intellij-platform-plugin-template-light]: ./.github/readme/intellij-platform-plugin-template-light.svg#gh-light-mode-only +[file:libs.versions.toml]: ./gradle/libs.versions.toml +[file:project-structure-sdk.png]: ./.github/readme/project-structure-sdk.png +[file:plugin.xml]: ./src/main/resources/META-INF/plugin.xml +[file:qodana.png]: ./.github/readme/qodana.png +[file:qodana.yml]: ./qodana.yml +[file:run-debug-configurations.png]: ./.github/readme/run-debug-configurations.png +[file:run-logs.png]: ./.github/readme/run-logs.png +[file:settings-secrets.png]: ./.github/readme/settings-secrets.png +[file:template_cleanup.yml]: ./.github/workflows/template-cleanup.yml +[file:ui-testing.png]: ./.github/readme/ui-testing.png +[file:use-this-template.png]: ./.github/readme/use-this-template.png + +[gh:actions]: https://help.github.com/en/actions +[gh:build]: https://github.com/JetBrains/intellij-platform-plugin-template/actions?query=workflow%3ABuild +[gh:code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples +[gh:dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-dependencies-updated-automatically +[gh:dependabot-pr]: https://github.com/JetBrains/intellij-platform-plugin-template/pull/73 +[gh:gradle-changelog-plugin]: https://github.com/JetBrains/gradle-changelog-plugin +[gh:gradle-intellij-plugin]: https://github.com/JetBrains/gradle-intellij-plugin +[gh:gradle-intellij-plugin-docs]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html +[gh:gradle-intellij-plugin-runIde]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runide +[gh:gradle-intellij-plugin-runPluginVerifier]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runpluginverifier +[gh:gradle-qodana-plugin]: https://github.com/JetBrains/gradle-qodana-plugin +[gh:intellij-ui-test-robot]: https://github.com/JetBrains/intellij-ui-test-robot +[gh:kover]: https://github.com/Kotlin/kotlinx-kover +[gh:releases]: https://github.com/JetBrains/intellij-platform-plugin-template/releases +[gh:ui-test-example]: https://github.com/JetBrains/intellij-ui-test-robot/tree/master/ui-test-example + +[gradle]: https://gradle.org +[gradle:build-cache]: https://docs.gradle.org/current/userguide/build_cache.html +[gradle:configuration-cache]: https://docs.gradle.org/current/userguide/configuration_cache.html +[gradle:kotlin-dsl]: https://docs.gradle.org/current/userguide/kotlin_dsl.html +[gradle:kotlin-dsl-assignment]: https://docs.gradle.org/current/userguide/kotlin_dsl.html#kotdsl:assignment +[gradle:lifecycle-tasks]: https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks +[gradle:releases]: https://gradle.org/releases +[gradle:version-catalog]: https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog + +[jb:github]: https://github.com/JetBrains/.github/blob/main/profile/README.md +[jb:download-ij]: https://www.jetbrains.com/idea/download +[jb:forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development +[jb:ipe]: https://jb.gg/ipe +[jb:my-tokens]: https://plugins.jetbrains.com/author/me/tokens +[jb:paid-plugins]: https://plugins.jetbrains.com/docs/marketplace/paid-plugins-marketplace.html +[jb:qodana]: https://www.jetbrains.com/help/qodana +[jb:qodana-github-action]: https://www.jetbrains.com/help/qodana/qodana-intellij-github-action.html +[jb:quality-guidelines]: https://plugins.jetbrains.com/docs/marketplace/quality-guidelines.html +[jb:slack]: https://plugins.jetbrains.com/slack +[jb:twitter]: https://twitter.com/JBPlatform +[jb:ui-guidelines]: https://jetbrains.github.io/ui + +[codecov]: https://codecov.io +[github-actions-skip-ci]: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/ +[keep-a-changelog]: https://keepachangelog.com +[keep-a-changelog-how]: https://keepachangelog.com/en/1.0.0/#how +[semver]: https://semver.org +[xpath]: https://www.w3.org/TR/xpath-21/ diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..bf0c939 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,131 @@ +import org.jetbrains.changelog.Changelog +import org.jetbrains.changelog.markdownToHTML + +fun properties(key: String) = providers.gradleProperty(key) +fun environment(key: String) = providers.environmentVariable(key) + +plugins { + id("java") // Java support + alias(libs.plugins.kotlin) // Kotlin support + alias(libs.plugins.gradleIntelliJPlugin) // Gradle IntelliJ Plugin + alias(libs.plugins.changelog) // Gradle Changelog Plugin + alias(libs.plugins.qodana) // Gradle Qodana Plugin + alias(libs.plugins.kover) // Gradle Kover Plugin +} + +group = properties("pluginGroup").get() +version = properties("pluginVersion").get() + +// Configure project's dependencies +repositories { + mavenCentral() +} + +// Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog +dependencies { +// implementation(libs.annotations) +} + +// Set the JVM language level used to build the project. Use Java 11 for 2020.3+, and Java 17 for 2022.2+. +kotlin { + @Suppress("UnstableApiUsage") + jvmToolchain { + languageVersion = JavaLanguageVersion.of(17) + vendor = JvmVendorSpec.JETBRAINS + } +} + +// Configure Gradle IntelliJ Plugin - read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html +intellij { + pluginName = properties("pluginName") + version = properties("platformVersion") + type = properties("platformType") + + // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file. + plugins = properties("platformPlugins").map { it.split(',').map(String::trim).filter(String::isNotEmpty) } +} + +// Configure Gradle Changelog Plugin - read more: https://github.com/JetBrains/gradle-changelog-plugin +changelog { + groups.empty() + repositoryUrl = properties("pluginRepositoryUrl") +} + +// Configure Gradle Qodana Plugin - read more: https://github.com/JetBrains/gradle-qodana-plugin +qodana { + cachePath = provider { file(".qodana").canonicalPath } + reportPath = provider { file("build/reports/inspections").canonicalPath } + saveReport = true + showReport = environment("QODANA_SHOW_REPORT").map { it.toBoolean() }.getOrElse(false) +} + +// Configure Gradle Kover Plugin - read more: https://github.com/Kotlin/kotlinx-kover#configuration +koverReport { + defaults { + xml { + onCheck = true + } + } +} + +tasks { + wrapper { + gradleVersion = properties("gradleVersion").get() + } + + patchPluginXml { + version = properties("pluginVersion") + sinceBuild = properties("pluginSinceBuild") + untilBuild = properties("pluginUntilBuild") + + // Extract the section from README.md and provide for the plugin's manifest + pluginDescription = providers.fileContents(layout.projectDirectory.file("README.md")).asText.map { + val start = "" + val end = "" + + with (it.lines()) { + if (!containsAll(listOf(start, end))) { + throw GradleException("Plugin description section not found in README.md:\n$start ... $end") + } + subList(indexOf(start) + 1, indexOf(end)).joinToString("\n").let(::markdownToHTML) + } + } + + val changelog = project.changelog // local variable for configuration cache compatibility + // Get the latest available change notes from the changelog file + changeNotes = properties("pluginVersion").map { pluginVersion -> + with(changelog) { + renderItem( + (getOrNull(pluginVersion) ?: getUnreleased()) + .withHeader(false) + .withEmptySections(false), + Changelog.OutputType.HTML, + ) + } + } + } + + // Configure UI tests plugin + // Read more: https://github.com/JetBrains/intellij-ui-test-robot + runIdeForUiTests { + systemProperty("robot-server.port", "8082") + systemProperty("ide.mac.message.dialogs.as.sheets", "false") + systemProperty("jb.privacy.policy.text", "") + systemProperty("jb.consents.confirmation.enabled", "false") + } + + signPlugin { + certificateChain = environment("CERTIFICATE_CHAIN") + privateKey = environment("PRIVATE_KEY") + password = environment("PRIVATE_KEY_PASSWORD") + } + + publishPlugin { + dependsOn("patchChangelog") + token = environment("PUBLISH_TOKEN") + // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3 + // Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more: + // https://plugins.jetbrains.com/docs/intellij/deployment.html#specifying-a-release-channel + channels = properties("pluginVersion").map { listOf(it.split('-').getOrElse(1) { "default" }.split('.').first()) } + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..6d9bbd4 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,34 @@ +# IntelliJ Platform Artifacts Repositories -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html + +pluginGroup = org.jetbrains.plugins.template +pluginName = IntelliJ Platform Plugin Template +pluginRepositoryUrl = https://github.com/JetBrains/intellij-platform-plugin-template +# SemVer format -> https://semver.org +pluginVersion = 1.11.3 + +# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html +pluginSinceBuild = 223 +pluginUntilBuild = 233.* + +# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension +platformType = IC +platformVersion = 2022.3.3 + +# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html +# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22 +platformPlugins = + +# Gradle Releases -> https://github.com/gradle/gradle/releases +gradleVersion = 8.5 + +# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib +kotlin.stdlib.default.dependency = false + +# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html +org.gradle.configuration-cache = true + +# Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html +org.gradle.caching = true + +# Enable Gradle Kotlin DSL Lazy Property Assignment -> https://docs.gradle.org/current/userguide/kotlin_dsl.html#kotdsl:assignment +systemProp.org.gradle.unsafe.kotlin.assignment = true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..febb8cd --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,20 @@ +[versions] +# libraries +annotations = "24.1.0" + +# plugins +kotlin = "1.9.21" +changelog = "2.2.0" +gradleIntelliJPlugin = "1.16.1" +qodana = "0.1.13" +kover = "0.7.5" + +[libraries] +annotations = { group = "org.jetbrains", name = "annotations", version.ref = "annotations" } + +[plugins] +changelog = { id = "org.jetbrains.changelog", version.ref = "changelog" } +gradleIntelliJPlugin = { id = "org.jetbrains.intellij", version.ref = "gradleIntelliJPlugin" } +kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" } +kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" } +qodana = { id = "org.jetbrains.qodana", version.ref = "qodana" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1af9e09 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/qodana.yml b/qodana.yml new file mode 100644 index 0000000..cbf640f --- /dev/null +++ b/qodana.yml @@ -0,0 +1,12 @@ +# Qodana configuration: +# https://www.jetbrains.com/help/qodana/qodana-yaml.html + +version: 1.0 +linter: jetbrains/qodana-jvm-community:latest +projectJDK: "17" +profile: + name: qodana.recommended +exclude: + - name: All + paths: + - .qodana diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..897361b --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.7.0" +} + +rootProject.name = "IntelliJ Platform Plugin Template" diff --git a/src/main/kotlin/org/jetbrains/plugins/template/MyBundle.kt b/src/main/kotlin/org/jetbrains/plugins/template/MyBundle.kt new file mode 100644 index 0000000..0bcd9fd --- /dev/null +++ b/src/main/kotlin/org/jetbrains/plugins/template/MyBundle.kt @@ -0,0 +1,20 @@ +package org.jetbrains.plugins.template + +import com.intellij.DynamicBundle +import org.jetbrains.annotations.NonNls +import org.jetbrains.annotations.PropertyKey + +@NonNls +private const val BUNDLE = "messages.MyBundle" + +object MyBundle : DynamicBundle(BUNDLE) { + + @JvmStatic + fun message(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) = + getMessage(key, *params) + + @Suppress("unused") + @JvmStatic + fun messagePointer(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) = + getLazyMessage(key, *params) +} diff --git a/src/main/kotlin/org/jetbrains/plugins/template/listeners/MyApplicationActivationListener.kt b/src/main/kotlin/org/jetbrains/plugins/template/listeners/MyApplicationActivationListener.kt new file mode 100644 index 0000000..7f03dd4 --- /dev/null +++ b/src/main/kotlin/org/jetbrains/plugins/template/listeners/MyApplicationActivationListener.kt @@ -0,0 +1,12 @@ +package org.jetbrains.plugins.template.listeners + +import com.intellij.openapi.application.ApplicationActivationListener +import com.intellij.openapi.diagnostic.thisLogger +import com.intellij.openapi.wm.IdeFrame + +internal class MyApplicationActivationListener : ApplicationActivationListener { + + override fun applicationActivated(ideFrame: IdeFrame) { + thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.") + } +} diff --git a/src/main/kotlin/org/jetbrains/plugins/template/services/MyProjectService.kt b/src/main/kotlin/org/jetbrains/plugins/template/services/MyProjectService.kt new file mode 100644 index 0000000..afa770f --- /dev/null +++ b/src/main/kotlin/org/jetbrains/plugins/template/services/MyProjectService.kt @@ -0,0 +1,17 @@ +package org.jetbrains.plugins.template.services + +import com.intellij.openapi.components.Service +import com.intellij.openapi.diagnostic.thisLogger +import com.intellij.openapi.project.Project +import org.jetbrains.plugins.template.MyBundle + +@Service(Service.Level.PROJECT) +class MyProjectService(project: Project) { + + init { + thisLogger().info(MyBundle.message("projectService", project.name)) + thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.") + } + + fun getRandomNumber() = (1..100).random() +} diff --git a/src/main/kotlin/org/jetbrains/plugins/template/toolWindow/MyToolWindowFactory.kt b/src/main/kotlin/org/jetbrains/plugins/template/toolWindow/MyToolWindowFactory.kt new file mode 100644 index 0000000..0e61940 --- /dev/null +++ b/src/main/kotlin/org/jetbrains/plugins/template/toolWindow/MyToolWindowFactory.kt @@ -0,0 +1,45 @@ +package org.jetbrains.plugins.template.toolWindow + +import com.intellij.openapi.components.service +import com.intellij.openapi.diagnostic.thisLogger +import com.intellij.openapi.project.Project +import com.intellij.openapi.wm.ToolWindow +import com.intellij.openapi.wm.ToolWindowFactory +import com.intellij.ui.components.JBLabel +import com.intellij.ui.components.JBPanel +import com.intellij.ui.content.ContentFactory +import org.jetbrains.plugins.template.MyBundle +import org.jetbrains.plugins.template.services.MyProjectService +import javax.swing.JButton + + +class MyToolWindowFactory : ToolWindowFactory { + + init { + thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.") + } + + override fun createToolWindowContent(project: Project, toolWindow: ToolWindow) { + val myToolWindow = MyToolWindow(toolWindow) + val content = ContentFactory.getInstance().createContent(myToolWindow.getContent(), null, false) + toolWindow.contentManager.addContent(content) + } + + override fun shouldBeAvailable(project: Project) = true + + class MyToolWindow(toolWindow: ToolWindow) { + + private val service = toolWindow.project.service() + + fun getContent() = JBPanel>().apply { + val label = JBLabel(MyBundle.message("randomLabel", "?")) + + add(label) + add(JButton(MyBundle.message("shuffle")).apply { + addActionListener { + label.text = MyBundle.message("randomLabel", service.getRandomNumber()) + } + }) + } + } +} diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml new file mode 100644 index 0000000..a812002 --- /dev/null +++ b/src/main/resources/META-INF/plugin.xml @@ -0,0 +1,18 @@ + + + org.jetbrains.plugins.template + IntelliJ Platform Plugin Template + JetBrains + + com.intellij.modules.platform + + messages.MyBundle + + + + + + + + + diff --git a/src/main/resources/META-INF/pluginIcon.svg b/src/main/resources/META-INF/pluginIcon.svg new file mode 100644 index 0000000..af611a5 --- /dev/null +++ b/src/main/resources/META-INF/pluginIcon.svg @@ -0,0 +1,11 @@ + + + + + + + + + + diff --git a/src/main/resources/messages/MyBundle.properties b/src/main/resources/messages/MyBundle.properties new file mode 100644 index 0000000..2e041d8 --- /dev/null +++ b/src/main/resources/messages/MyBundle.properties @@ -0,0 +1,3 @@ +projectService=Project service: {0} +randomLabel=The random number is: {0} +shuffle=Shuffle diff --git a/src/test/kotlin/org/jetbrains/plugins/template/MyPluginTest.kt b/src/test/kotlin/org/jetbrains/plugins/template/MyPluginTest.kt new file mode 100644 index 0000000..3945372 --- /dev/null +++ b/src/test/kotlin/org/jetbrains/plugins/template/MyPluginTest.kt @@ -0,0 +1,39 @@ +package org.jetbrains.plugins.template + +import com.intellij.ide.highlighter.XmlFileType +import com.intellij.openapi.components.service +import com.intellij.psi.xml.XmlFile +import com.intellij.testFramework.TestDataPath +import com.intellij.testFramework.fixtures.BasePlatformTestCase +import com.intellij.util.PsiErrorElementUtil +import org.jetbrains.plugins.template.services.MyProjectService + +@TestDataPath("\$CONTENT_ROOT/src/test/testData") +class MyPluginTest : BasePlatformTestCase() { + + fun testXMLFile() { + val psiFile = myFixture.configureByText(XmlFileType.INSTANCE, "bar") + val xmlFile = assertInstanceOf(psiFile, XmlFile::class.java) + + assertFalse(PsiErrorElementUtil.hasErrors(project, xmlFile.virtualFile)) + + assertNotNull(xmlFile.rootTag) + + xmlFile.rootTag?.let { + assertEquals("foo", it.name) + assertEquals("bar", it.value.text) + } + } + + fun testRename() { + myFixture.testRename("foo.xml", "foo_after.xml", "a2") + } + + fun testProjectService() { + val projectService = project.service() + + assertNotSame(projectService.getRandomNumber(), projectService.getRandomNumber()) + } + + override fun getTestDataPath() = "src/test/testData/rename" +} diff --git a/src/test/testData/rename/foo.xml b/src/test/testData/rename/foo.xml new file mode 100644 index 0000000..b21e9f2 --- /dev/null +++ b/src/test/testData/rename/foo.xml @@ -0,0 +1,3 @@ + + 1>Foo + diff --git a/src/test/testData/rename/foo_after.xml b/src/test/testData/rename/foo_after.xml new file mode 100644 index 0000000..980ca96 --- /dev/null +++ b/src/test/testData/rename/foo_after.xml @@ -0,0 +1,3 @@ + + Foo +