diff --git a/.github/workflows/code-samples.yml b/.github/workflows/code-samples.yml index 5003010b6a4..e274dddfa95 100644 --- a/.github/workflows/code-samples.yml +++ b/.github/workflows/code-samples.yml @@ -24,6 +24,7 @@ jobs: matrix: plugin: - action_basics + - code_inspection_qodana/code_inspection - comparing_string_references_inspection - conditional_operator_intention - editor_basics @@ -60,6 +61,7 @@ jobs: shell: bash run: | echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT + echo "sanitizedPluginName=$(echo '${{ matrix.plugin }}' | tr '/' '-')" >> $GITHUB_OUTPUT - name: Run Plugin Verifier run: | @@ -77,7 +79,7 @@ jobs: if: ${{ always() }} uses: actions/upload-artifact@v5 with: - name: ${{ matrix.plugin }}-pluginVerifier-result + name: ${{ steps.properties.outputs.sanitizedPluginName }}-pluginVerifier-result path: ${{ github.workspace }}/code_samples/${{ matrix.plugin }}/build/reports/pluginVerifier mirror: diff --git a/.idea/compiler.xml b/.idea/compiler.xml index 55bc0a8b995..426ffbd418f 100644 --- a/.idea/compiler.xml +++ b/.idea/compiler.xml @@ -10,6 +10,8 @@ + + - \ No newline at end of file + diff --git a/.idea/gradle.xml b/.idea/gradle.xml index 96e6db21eaf..2a7a1d070cb 100644 --- a/.idea/gradle.xml +++ b/.idea/gradle.xml @@ -12,6 +12,21 @@ + + + + + + + + + + + + + + + @@ -106,6 +121,9 @@ - + \ No newline at end of file diff --git a/.idea/modules/qodana-playground.main.iml b/.idea/modules/qodana-playground.main.iml new file mode 100644 index 00000000000..5fa2b624e6c --- /dev/null +++ b/.idea/modules/qodana-playground.main.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/code_samples/README.md b/code_samples/README.md index 48ed220fc30..0f9c0a78e9e 100644 --- a/code_samples/README.md +++ b/code_samples/README.md @@ -37,6 +37,7 @@ In the following table, you may find all available samples provided in the separ | Code Sample | Description | |-----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Action Basics](./action_basics) | Action and Action Group patterns implementation, adds entries to the Tools menu. | +| [Kotlin Class Name Convention Inspection](./code_inspection_qodana) | Local Inspection Tool, checks Kotlin class name convention. Allows to be run in Qodana | | [Comparing References Inspection](./comparing_string_references_inspection) | Local Inspection Tool, adds entries to **Settings | Editor | Inspections | Java | Probable Bugs**. | | [Conditional Operator Intention](./conditional_operator_intention) | Intention action, suggests converting a ternary operator into an `if` block and adds entry to **Settings | Editor | Intentions | SDK Intentions**. | | [Editor Basics](./editor_basics) | Basic Editor APIs example with editor popup menu with extra actions. | diff --git a/code_samples/_gradleCompositeBuild/gradle.properties b/code_samples/_gradleCompositeBuild/gradle.properties new file mode 100644 index 00000000000..6904edb490e --- /dev/null +++ b/code_samples/_gradleCompositeBuild/gradle.properties @@ -0,0 +1,2 @@ +# Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +org.gradle.jvmargs=-Xmx1024m diff --git a/code_samples/_gradleCompositeBuild/settings.gradle.kts b/code_samples/_gradleCompositeBuild/settings.gradle.kts index 3006e85ab54..e193b9a5f11 100644 --- a/code_samples/_gradleCompositeBuild/settings.gradle.kts +++ b/code_samples/_gradleCompositeBuild/settings.gradle.kts @@ -5,6 +5,7 @@ rootProject.name = "SDK Code Samples" includeBuild("../action_basics") +includeBuild("../code_inspection_qodana") includeBuild("../comparing_string_references_inspection") includeBuild("../conditional_operator_intention") includeBuild("../editor_basics") diff --git a/code_samples/code_inspection_qodana/.gitattributes b/code_samples/code_inspection_qodana/.gitattributes new file mode 100644 index 00000000000..097f9f98d9e --- /dev/null +++ b/code_samples/code_inspection_qodana/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/code_samples/code_inspection_qodana/.gitignore b/code_samples/code_inspection_qodana/.gitignore new file mode 100644 index 00000000000..1b6985c0094 --- /dev/null +++ b/code_samples/code_inspection_qodana/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/code_samples/code_inspection_qodana/README.md b/code_samples/code_inspection_qodana/README.md new file mode 100644 index 00000000000..414f9364288 --- /dev/null +++ b/code_samples/code_inspection_qodana/README.md @@ -0,0 +1,44 @@ +# IntelliJ SDK Code Inspection Sample for Qodana + +**IntelliJ SDK Code Inspection Sample for Qodana** contains a code inspection sample for IntelliJ Platform plugins. + +A single rule is established: every class in the `service` packages must have a `Service` suffix. + +## Subprojects + +- `code_inspection` - a standalone IntelliJ Platform plugin with this inspection +- `qodana_playground` - a sample project which is validated by Qodana and the custom plugin + +## Building and Running + +1. Build the IntelliJ Platform plugin and copy it into the custom plugin directory in the Qodana playground project: + + ``` + ./gradlew stagePluginForQodana + ``` + + This will build a plugin JAR and copy it into the `qodana_playground/.qodana` directory. + +2. Run Qodana from the `qodana_playground` directory with the custom plugin installed. + + > This step requires installing [Qodana](https://www.jetbrains.com/help/qodana/quick-start.html#quickstart-run-using-cli) and [Docker](https://www.docker.com/get-started/) before running. + + ``` + cd qodana_playground + qodana scan --clear-cache -v $(echo $PWD/.qodana/*.jar):/opt/idea/custom-plugins/codeinspection.jar + ``` + +3. See the Qodana report in the browser. + +## Building and Running in the IDE + +1. Build the IntelliJ Platform plugin. + + ``` + ./gradlew buildPlugin + ``` + +2. Install the `build/code_inspection-.zip` plugin into JetBrains IDE manually. +3. Make sure that the Qodana plugin is installed and enabled in the JetBrains IDE. +4. Run the **Tools | Qodana | Try Code Analysis** action. +5. See the Qodana reports in the **Qodana** tool window in the IDE. diff --git a/code_samples/code_inspection_qodana/build.gradle.kts b/code_samples/code_inspection_qodana/build.gradle.kts new file mode 100644 index 00000000000..4588e27fb98 --- /dev/null +++ b/code_samples/code_inspection_qodana/build.gradle.kts @@ -0,0 +1,26 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +val codeInspectionPlugin = "code_inspection" + +tasks.register("stagePluginForQodana") { + val qodanaDir = gradle.includedBuild("qodana_playground").projectDir.resolve(".qodana") + dependsOn(gradle.includedBuild(codeInspectionPlugin).task(":buildPlugin")) + from(gradle.includedBuild(codeInspectionPlugin) + .projectDir.resolve("build/libs")) + include("$codeInspectionPlugin-*.jar") + exclude("$codeInspectionPlugin-*-base.jar") + exclude("$codeInspectionPlugin-*-instrumented.jar") + exclude("$codeInspectionPlugin-*-searchableOptions.jar") + into(qodanaDir) +} + +tasks.register("buildPlugin") { + group = "build" + description = "Builds the Code Inspection plugin" + + val plugin = gradle.includedBuild(codeInspectionPlugin) + dependsOn(plugin.task(":buildPlugin")) + from(plugin.projectDir.resolve("build/distributions")) + include("$codeInspectionPlugin-*.zip") + into("build") +} diff --git a/code_samples/code_inspection_qodana/code_inspection/.gitignore b/code_samples/code_inspection_qodana/code_inspection/.gitignore new file mode 100644 index 00000000000..df6966a18f6 --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/.gitignore @@ -0,0 +1,7 @@ +.DS_Store +.gradle +.idea +.intellijPlatform +.kotlin +.qodana +build diff --git a/code_samples/code_inspection_qodana/code_inspection/.run/Run Plugin.run.xml b/code_samples/code_inspection_qodana/code_inspection/.run/Run Plugin.run.xml new file mode 100644 index 00000000000..9db62fb5e9a --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/.run/Run Plugin.run.xml @@ -0,0 +1,25 @@ + + + + + + + + false + true + false + false + + + \ No newline at end of file diff --git a/code_samples/code_inspection_qodana/code_inspection/CHANGELOG.md b/code_samples/code_inspection_qodana/code_inspection/CHANGELOG.md new file mode 100644 index 00000000000..6a3422c089e --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/CHANGELOG.md @@ -0,0 +1,9 @@ + + +# SDK: Comparing References Inspection Sample + +## [Unreleased] + +### Added + +- Initial release diff --git a/code_samples/code_inspection_qodana/code_inspection/build.gradle.kts b/code_samples/code_inspection_qodana/code_inspection/build.gradle.kts new file mode 100644 index 00000000000..a4ff3c9419d --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/build.gradle.kts @@ -0,0 +1,53 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +import org.jetbrains.intellij.platform.gradle.IntelliJPlatformType.IntellijIdea +import org.jetbrains.intellij.platform.gradle.IntelliJPlatformType.IntellijIdeaCommunity +import org.jetbrains.intellij.platform.gradle.models.ProductRelease.Channel.RELEASE + +plugins { + id("java") + id("org.jetbrains.kotlin.jvm") version "2.0.21" + id("org.jetbrains.intellij.platform") version "2.10.2" + id("org.jetbrains.qodana") version "2025.1.1" +} + +group = "org.intellij.sdk" +version = "2.0.0" + +repositories { + mavenCentral() + + intellijPlatform { + defaultRepositories() + } +} + +dependencies { + intellijPlatform { + intellijIdeaCommunity("2024.3.6") + bundledPlugin("org.jetbrains.kotlin") + } +} + +intellijPlatform { + buildSearchableOptions = false + + pluginConfiguration { + ideaVersion { + sinceBuild = "243" + } + } + pluginVerification { + ides { + // since 253, IntelliJ IDEA Community and Ultimate have been merged into IntelliJ IDEA + select { + types = listOf(IntellijIdeaCommunity) + untilBuild = "252.*" + } + select { + types = listOf(IntellijIdea) + sinceBuild = "253" + channels = listOf(RELEASE) + } + } + } +} diff --git a/code_samples/code_inspection_qodana/code_inspection/gradle.properties b/code_samples/code_inspection_qodana/code_inspection/gradle.properties new file mode 100644 index 00000000000..90ae95e8696 --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/gradle.properties @@ -0,0 +1,12 @@ +# Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +# IntelliJ Platform Artifacts Repositories -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html + +# 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/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.jar b/code_samples/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..8bdaf60c75a Binary files /dev/null and b/code_samples/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.jar differ diff --git a/code_samples/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.properties b/code_samples/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..2a84e188b85 --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/code_samples/code_inspection_qodana/code_inspection/gradlew b/code_samples/code_inspection_qodana/code_inspection/gradlew new file mode 100755 index 00000000000..ef07e0162b1 --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015 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\n' "$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="\\\"\\\"" + + +# 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, 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" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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/code_inspection_qodana/code_inspection/gradlew.bat b/code_samples/code_inspection_qodana/code_inspection/gradlew.bat new file mode 100644 index 00000000000..db3a6ac207e --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/gradlew.bat @@ -0,0 +1,94 @@ +@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= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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/code_inspection_qodana/code_inspection/qodana.yml b/code_samples/code_inspection_qodana/code_inspection/qodana.yml new file mode 100644 index 00000000000..81f13b9006e --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/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:2024.3 +projectJDK: "21" +profile: + name: qodana.recommended +exclude: + - name: All + paths: + - .qodana diff --git a/code_samples/code_inspection_qodana/code_inspection/settings.gradle.kts b/code_samples/code_inspection_qodana/code_inspection/settings.gradle.kts new file mode 100644 index 00000000000..f4457a7c10a --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/settings.gradle.kts @@ -0,0 +1,5 @@ +rootProject.name = "code_inspection" + +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" +} diff --git a/code_samples/code_inspection_qodana/code_inspection/src/main/kotlin/org/intellij/sdk/codeInspection/ServicePackageClassNameInspection.kt b/code_samples/code_inspection_qodana/code_inspection/src/main/kotlin/org/intellij/sdk/codeInspection/ServicePackageClassNameInspection.kt new file mode 100644 index 00000000000..24f603b196d --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/src/main/kotlin/org/intellij/sdk/codeInspection/ServicePackageClassNameInspection.kt @@ -0,0 +1,35 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +package org.intellij.sdk.codeInspection + +import com.intellij.codeInspection.ProblemHighlightType +import com.intellij.codeInspection.ProblemsHolder +import com.intellij.psi.PsiElementVisitor +import org.jetbrains.kotlin.idea.codeinsight.api.classic.inspections.AbstractKotlinInspection +import org.jetbrains.kotlin.psi.KtClass +import org.jetbrains.kotlin.psi.KtVisitorVoid + +class ServicePackageClassNameInspection : AbstractKotlinInspection() { + override fun buildVisitor( + holder: ProblemsHolder, + isOnTheFly: Boolean + ): PsiElementVisitor { + return object : KtVisitorVoid() { + override fun visitClass(klass: KtClass) { + val classNamePsi = klass.nameIdentifier ?: return + val classFqn = klass.fqName ?: return + if (klass.packageLastComponent == "service" && !classFqn.asString().endsWith("Service")) { + holder.registerProblem( + classNamePsi, + "Class name in the 'service' package must have a 'Service' suffix", + ProblemHighlightType.GENERIC_ERROR_OR_WARNING + ) + } + } + } + } + + private val KtClass.packageLastComponent: String + get() = containingKtFile.packageFqName.shortName().asString() + +} diff --git a/code_samples/code_inspection_qodana/code_inspection/src/main/resources/META-INF/plugin.xml b/code_samples/code_inspection_qodana/code_inspection/src/main/resources/META-INF/plugin.xml new file mode 100644 index 00000000000..9bbaa0b850e --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/src/main/resources/META-INF/plugin.xml @@ -0,0 +1,64 @@ + + + + + + org.intellij.sdk.classNameConventionCodeInspection + + + SDK: Class Name Convention Inspection + + + + IntelliJ SDK Code Inspection Sample for Qodana contains a code inspection sample + for IntelliJ Platform plugins.

+

A single rule is established: every class in the `service` packages must have a `Service` suffix.

+ ]]> + + + + IntelliJ Platform SDK + + + com.intellij.modules.platform + org.jetbrains.kotlin + + + + + + + + + + + diff --git a/code_samples/code_inspection_qodana/code_inspection/src/main/resources/inspectionDescriptions/ServicePackageClassName.html b/code_samples/code_inspection_qodana/code_inspection/src/main/resources/inspectionDescriptions/ServicePackageClassName.html new file mode 100644 index 00000000000..3824624c564 --- /dev/null +++ b/code_samples/code_inspection_qodana/code_inspection/src/main/resources/inspectionDescriptions/ServicePackageClassName.html @@ -0,0 +1,12 @@ + + +Reports class names in the service packages that lack the Service suffix. +

Example:

+

+  package com.example.foo.service
+  class SomeComponent {
+    /* class members */
+  }
+
+ + diff --git a/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.jar b/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..8bdaf60c75a Binary files /dev/null and b/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.jar differ diff --git a/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.properties b/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..2e1113280ef --- /dev/null +++ b/code_samples/code_inspection_qodana/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/code_samples/code_inspection_qodana/gradlew b/code_samples/code_inspection_qodana/gradlew new file mode 100755 index 00000000000..adff685a034 --- /dev/null +++ b/code_samples/code_inspection_qodana/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 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\n' "$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 + + + +# 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" ) + + 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, 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" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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/code_inspection_qodana/gradlew.bat b/code_samples/code_inspection_qodana/gradlew.bat new file mode 100644 index 00000000000..c4bdd3ab8e3 --- /dev/null +++ b/code_samples/code_inspection_qodana/gradlew.bat @@ -0,0 +1,93 @@ +@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 + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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/code_inspection_qodana/qodana_playground/.gitignore b/code_samples/code_inspection_qodana/qodana_playground/.gitignore new file mode 100644 index 00000000000..8b029849af7 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/.gitignore @@ -0,0 +1,5 @@ +.DS_Store +.gradle +.idea +.qodana +build diff --git a/code_samples/code_inspection_qodana/qodana_playground/build.gradle.kts b/code_samples/code_inspection_qodana/qodana_playground/build.gradle.kts new file mode 100644 index 00000000000..6526e92c4c3 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/build.gradle.kts @@ -0,0 +1,24 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +plugins { + kotlin("jvm") version "2.2.0" +} + +group = "org.intellij.sdk" +version = "1.0-SNAPSHOT" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation(kotlin("test")) +} + +tasks.test { + useJUnitPlatform() +} + +kotlin { + jvmToolchain(17) +} diff --git a/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.jar b/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..1b33c55baab Binary files /dev/null and b/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.jar differ diff --git a/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.properties b/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..838c72605aa --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +# Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/code_samples/code_inspection_qodana/qodana_playground/gradlew b/code_samples/code_inspection_qodana/qodana_playground/gradlew new file mode 100755 index 00000000000..23d15a93670 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/gradlew @@ -0,0 +1,251 @@ +#!/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\n' "$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="\\\"\\\"" + + +# 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, 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" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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/code_inspection_qodana/qodana_playground/gradlew.bat b/code_samples/code_inspection_qodana/qodana_playground/gradlew.bat new file mode 100644 index 00000000000..db3a6ac207e --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/gradlew.bat @@ -0,0 +1,94 @@ +@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= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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/code_inspection_qodana/qodana_playground/qodana.yaml b/code_samples/code_inspection_qodana/qodana_playground/qodana.yaml new file mode 100644 index 00000000000..518bef86d93 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/qodana.yaml @@ -0,0 +1,7 @@ +version: "1.0" +linter: qodana-jvm-community +projectJDK: "21" +profile: + name: qodana.recommended +include: + - name: org.intellij.sdk.codeInspection.ServicePackageClassNameInspection diff --git a/code_samples/code_inspection_qodana/qodana_playground/settings.gradle.kts b/code_samples/code_inspection_qodana/qodana_playground/settings.gradle.kts new file mode 100644 index 00000000000..bfb140d0d56 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/settings.gradle.kts @@ -0,0 +1,7 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +rootProject.name = "qodana_playground" + +plugins { + id("org.gradle.toolchains.foojay-resolver-convention").version("1.0.0") +} diff --git a/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/Runner.kt b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/Runner.kt new file mode 100644 index 00000000000..c1de69b87aa --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/Runner.kt @@ -0,0 +1,12 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +package org.intellij.sdk.qodana + +import org.intellij.sdk.qodana.service.AnotherComponent +import org.intellij.sdk.qodana.service.Component +import kotlin.collections.forEach + +fun main() { + val components = listOf(Component(), AnotherComponent()) + components.forEach { println(it) } +} diff --git a/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/AnotherComponent.kt b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/AnotherComponent.kt new file mode 100644 index 00000000000..7b96dbce84f --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/AnotherComponent.kt @@ -0,0 +1,7 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +package org.intellij.sdk.qodana.service + +class AnotherComponent { + override fun toString() = "AnotherComponent" +} diff --git a/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/Component.kt b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/Component.kt new file mode 100644 index 00000000000..ae63e585f17 --- /dev/null +++ b/code_samples/code_inspection_qodana/qodana_playground/src/main/kotlin/org/intellij/sdk/qodana/service/Component.kt @@ -0,0 +1,7 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +package org.intellij.sdk.qodana.service + +class Component { + override fun toString() = "Component" +} diff --git a/code_samples/code_inspection_qodana/settings.gradle.kts b/code_samples/code_inspection_qodana/settings.gradle.kts new file mode 100644 index 00000000000..d0dba7544b9 --- /dev/null +++ b/code_samples/code_inspection_qodana/settings.gradle.kts @@ -0,0 +1,6 @@ +// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. + +rootProject.name = "code_inspection_qodana" + +includeBuild("../code_inspection_qodana/code_inspection") +includeBuild("../code_inspection_qodana/qodana_playground")