diff --git a/.idea/compiler.xml b/.idea/compiler.xml index 0e33a0852..55bc0a8b9 100644 --- a/.idea/compiler.xml +++ b/.idea/compiler.xml @@ -4,6 +4,9 @@ + + + diff --git a/code_samples/_gradleCompositeBuild/settings.gradle.kts b/code_samples/_gradleCompositeBuild/settings.gradle.kts index 0f96b40ab..96fa68a4a 100644 --- a/code_samples/_gradleCompositeBuild/settings.gradle.kts +++ b/code_samples/_gradleCompositeBuild/settings.gradle.kts @@ -10,7 +10,6 @@ includeBuild("../conditional_operator_intention") includeBuild("../editor_basics") includeBuild("../facet_basics") includeBuild("../framework_basics") -includeBuild("../kotlin_demo") includeBuild("../live_templates") includeBuild("../max_opened_projects") includeBuild("../module") diff --git a/code_samples/kotlin_demo/.run/Run IDE with Plugin.run.xml b/code_samples/kotlin_demo/.run/Run IDE with Plugin.run.xml deleted file mode 100644 index 48a73549f..000000000 --- a/code_samples/kotlin_demo/.run/Run IDE with Plugin.run.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - true - true - false - - - diff --git a/code_samples/kotlin_demo/README.md b/code_samples/kotlin_demo/README.md index e17afc477..41e70fdbe 100644 --- a/code_samples/kotlin_demo/README.md +++ b/code_samples/kotlin_demo/README.md @@ -1,23 +1,10 @@ # Kotlin Demo [![JetBrains IntelliJ Platform SDK Docs](https://jb.gg/badges/docs.svg)][docs] -*Reference: [Kotlin for Plugin Developers in IntelliJ SDK Docs][docs:kotlin]* - -## Quickstart - -Simple Kotlin Demo project is an example of a minimal Kotlin-based plugin that provides the most straightforward action implemented by the [HelloAction.kt][file:HelloAction] Kotlin class. - -Action, added to the main menu, shows a message dialog when invoked. - -### Actions - -| ID | Implementation | Base Action Class | -|------------------|---------------------------------|-------------------| -| `MyPlugin.Hello` | [HelloAction][file:HelloAction] | `AnAction` | - -*Reference: [Action System in IntelliJ SDK Docs][docs:actions]* +> Plugin Sample has been removed. +> Refer to +> [Kotlin for Plugin Developers in IntelliJ SDK Docs][docs:kotlin] +> on how to set up Kotlin for your plugin project. [docs]: https://plugins.jetbrains.com/docs/intellij/ [docs:actions]: https://plugins.jetbrains.com/docs/intellij/basic-action-system.html [docs:kotlin]: https://plugins.jetbrains.com/docs/intellij/kotlin.html - -[file:HelloAction]: ./src/main/kotlin/org/intellij/sdk/kotlin/HelloAction.kt diff --git a/code_samples/kotlin_demo/build.gradle.kts b/code_samples/kotlin_demo/build.gradle.kts deleted file mode 100644 index fc4a845b2..000000000 --- a/code_samples/kotlin_demo/build.gradle.kts +++ /dev/null @@ -1,43 +0,0 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. - -plugins { - id("java") - id("org.jetbrains.intellij") version "1.17.4" - id("org.jetbrains.kotlin.jvm") version "1.9.25" -} - -group = "org.intellij.sdk" -version = "2.0.0" - -repositories { - mavenCentral() -} - -java { - sourceCompatibility = JavaVersion.VERSION_17 -} - -// See https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html -intellij { - version.set("2023.3.7") -} - -tasks { - buildSearchableOptions { - enabled = false - } - - patchPluginXml { - version.set("${project.version}") - sinceBuild.set("233") - untilBuild.set("242.*") - } - - compileKotlin { - kotlinOptions.jvmTarget = "17" - } - - compileTestKotlin { - kotlinOptions.jvmTarget = "17" - } -} diff --git a/code_samples/kotlin_demo/gradle.properties b/code_samples/kotlin_demo/gradle.properties deleted file mode 100644 index 00c662096..000000000 --- a/code_samples/kotlin_demo/gradle.properties +++ /dev/null @@ -1,10 +0,0 @@ -# Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. - -# 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 diff --git a/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.jar b/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.jar deleted file mode 100644 index a4b76b953..000000000 Binary files a/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.jar and /dev/null differ diff --git a/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.properties b/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index df97d72b8..000000000 --- a/code_samples/kotlin_demo/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,7 +0,0 @@ -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip -networkTimeout=10000 -validateDistributionUrl=true -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists diff --git a/code_samples/kotlin_demo/gradlew b/code_samples/kotlin_demo/gradlew deleted file mode 100755 index f5feea6d6..000000000 --- a/code_samples/kotlin_demo/gradlew +++ /dev/null @@ -1,252 +0,0 @@ -#!/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. -# -# SPDX-License-Identifier: Apache-2.0 -# - -############################################################################## -# -# 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/platforms/jvm/plugins-application/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 -P "${APP_HOME:-./}" > /dev/null && printf '%s -' "$PWD" ) || 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/code_samples/kotlin_demo/gradlew.bat b/code_samples/kotlin_demo/gradlew.bat deleted file mode 100644 index 9d21a2183..000000000 --- a/code_samples/kotlin_demo/gradlew.bat +++ /dev/null @@ -1,94 +0,0 @@ -@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 -@rem SPDX-License-Identifier: Apache-2.0 -@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. 1>&2 -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -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/code_samples/kotlin_demo/settings.gradle.kts b/code_samples/kotlin_demo/settings.gradle.kts deleted file mode 100644 index c7b5d303d..000000000 --- a/code_samples/kotlin_demo/settings.gradle.kts +++ /dev/null @@ -1,9 +0,0 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -pluginManagement { - repositories { - mavenCentral() - gradlePluginPortal() - } -} - -rootProject.name = "kotlin_demo" diff --git a/code_samples/kotlin_demo/src/main/kotlin/org/intellij/sdk/kotlin/HelloAction.kt b/code_samples/kotlin_demo/src/main/kotlin/org/intellij/sdk/kotlin/HelloAction.kt deleted file mode 100644 index 417c0c529..000000000 --- a/code_samples/kotlin_demo/src/main/kotlin/org/intellij/sdk/kotlin/HelloAction.kt +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. - -package org.intellij.sdk.kotlin - -import com.intellij.openapi.actionSystem.AnActionEvent -import com.intellij.openapi.actionSystem.PlatformDataKeys -import com.intellij.openapi.project.DumbAwareAction -import com.intellij.openapi.ui.Messages - -class HelloAction : DumbAwareAction() { - - override fun actionPerformed(event: AnActionEvent) { - val project = event.getData(PlatformDataKeys.PROJECT) - Messages.showMessageDialog(project, "Hello from Kotlin!", "Greeting", Messages.getInformationIcon()) - } - -} diff --git a/code_samples/kotlin_demo/src/main/resources/META-INF/plugin.xml b/code_samples/kotlin_demo/src/main/resources/META-INF/plugin.xml deleted file mode 100644 index 6dd71b1a2..000000000 --- a/code_samples/kotlin_demo/src/main/resources/META-INF/plugin.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - org.intellij.sdk.kotlin - - - SDK: Kotlin Demo - - - com.intellij.modules.platform - - - - Greeting menu group anchored last in the Main Menu - ]]> - - - -
  • 2.0.0 Converted to Gradle project.
    • -
  • 1.0 Release 2019.1 and earlier.
    • - - ]]> -     - - - IntelliJ Platform SDK - - - - - - - - -     diff --git a/code_samples/kotlin_demo/src/main/resources/META-INF/pluginIcon.svg b/code_samples/kotlin_demo/src/main/resources/META-INF/pluginIcon.svg deleted file mode 100644 index 613290897..000000000 --- a/code_samples/kotlin_demo/src/main/resources/META-INF/pluginIcon.svg +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/topics/tutorials/using_kotlin.md b/topics/tutorials/using_kotlin.md index 201fce020..c71f1625e 100644 --- a/topics/tutorials/using_kotlin.md +++ b/topics/tutorials/using_kotlin.md @@ -40,11 +40,9 @@ Likewise, it is possible to customize the behavior of internal classes in the In For example, it is common practice to [guard logging statements](https://www.slf4j.org/faq.html#logging_performance) to avoid the cost of parameter construction, leading to the following ceremony when using the log: ```java -if(logger.isDebugEnabled()){ - logger. - -debug("..."+expensiveComputation()); - } +if (logger.isDebugEnabled()) { + logger.debug("..."+expensiveComputation()); +} ``` We can achieve the same result more succinctly in Kotlin, by declaring the following extension method: @@ -82,19 +80,12 @@ The IntelliJ Platform provides a [type safe DSL](kotlin_ui_dsl_version_2.md) to > The [](plugin_github_template.md) provides a preconfigured project using Kotlin. -IntelliJ IDEA bundles the necessary Kotlin plugin, requiring no further configuration. -For detailed instructions, please refer to the [Kotlin documentation](https://kotlinlang.org/docs/getting-started.html). +IntelliJ IDEA bundles the necessary Kotlin IDE plugin, requiring no further configuration. +For detailed instructions, refer to the [Kotlin documentation](https://kotlinlang.org/docs/getting-started.html). ### Kotlin Gradle Plugin -Adding Kotlin source files compilation support to the Gradle-based project requires adding and configuring the [Kotlin JVM Gradle plugin](https://kotlinlang.org/docs/gradle.html#targeting-the-jvm). - -See the build.gradle.kts from [kotlin_demo](%gh-sdk-samples-master%/kotlin_demo) sample plugin using [](tools_gradle_intellij_plugin.md): - -```kotlin -``` - -{src="kotlin_demo/build.gradle.kts" include-lines="2-" default-state="collapsed" collapsible="true" collapsed-title="build.gradle.kts"} +Adding Kotlin source files compilation support to a Gradle-based project requires adding and configuring the [Kotlin JVM Gradle plugin](https://kotlinlang.org/docs/gradle.html#targeting-the-jvm). ### Kotlin Standard Library (stdlib)