├── .gitignore ├── settings.gradle.kts ├── art └── showcase.gif ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── detekt-config.yml ├── .run ├── Run Plugin Tests.run.xml ├── Run IDE with Plugin.run.xml └── Run Plugin Verification.run.xml ├── gradle.properties ├── README.md ├── src └── main │ ├── resources │ └── META-INF │ │ └── plugin.xml │ └── kotlin │ └── com │ └── github │ └── kaustubhpatange │ └── composecolor │ └── DemoLineMarkerProvider.kt ├── gradlew.bat ├── gradlew ├── .github └── workflows │ └── build.yml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | .idea 3 | .run 4 | build 5 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "compose-color" 2 | -------------------------------------------------------------------------------- /art/showcase.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KaustubhPatange/compose-color/HEAD/art/showcase.gif -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KaustubhPatange/compose-color/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /detekt-config.yml: -------------------------------------------------------------------------------- 1 | # Default detekt configuration: 2 | # https://github.com/detekt/detekt/blob/master/detekt-core/src/main/resources/default-detekt-config.yml 3 | 4 | formatting: 5 | Indentation: 6 | continuationIndentSize: 8 7 | ParameterListWrapping: 8 | indentSize: 8 9 | -------------------------------------------------------------------------------- /.run/Run Plugin Tests.run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 18 | true 19 | true 20 | false 21 | 22 | 23 | -------------------------------------------------------------------------------- /.run/Run IDE with Plugin.run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 18 | true 19 | true 20 | false 21 | 22 | 23 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # IntelliJ Platform Artifacts Repositories 2 | # -> https://www.jetbrains.org/intellij/sdk/docs/reference_guide/intellij_artifacts.html 3 | 4 | pluginGroup = com.github.kaustubhpatange.composecolor 5 | pluginName = Highlight Colors for Compose 6 | pluginVersion = 0.0.7 7 | pluginSinceBuild = 213 8 | pluginUntilBuild = 223.* 9 | # Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl 10 | # See https://jb.gg/intellij-platform-builds-list for available build versions 11 | pluginVerifierIdeVersions = 2020.2.4, 2020.3.4, 2021.1.1, 2021.3.3 12 | 13 | platformType = IC 14 | platformVersion = 2021.3.3 15 | platformDownloadSources = true 16 | # Plugin Dependencies -> https://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_dependencies.html 17 | # Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22 18 | platformPlugins = com.intellij.java 19 | 20 | gradleVersion = 7.6 21 | 22 | # Opt-out flag for bundling Kotlin standard library. 23 | # See https://kotlinlang.org/docs/reference/using-gradle.html#dependency-on-the-standard-library for details. 24 | kotlin.stdlib.default.dependency = false 25 | -------------------------------------------------------------------------------- /.run/Run Plugin Verification.run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 18 | true 19 | true 20 | false 21 | 22 | 24 | 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Highlight Colors for Compose 2 | 3 | ![Build](https://github.com/KaustubhPatange/compose-color-plugin/workflows/Build/badge.svg) 4 | [![Version](https://img.shields.io/jetbrains/plugin/v/com.github.kaustubhpatange.composecolor.svg)](https://plugins.jetbrains.com/plugin/15439-highlight-colors-for-compose) 5 | 6 | **Android Studio Arctic Fox Canary 7 has this functionality built-in!** 7 | 8 | A plugin for **Intellij** based IDEs to draw rectangle on the editor's gutter denoting the color represented by `androidx.compose.ui.graphics.Color` 9 | 10 | Clicking on the color icon from the gutter will open a color picker dialog to modify the color. 11 | 12 | Only the properties satisfying the following pattern will be highlighted: 13 | 14 | ```kotlin 15 | $modifier $name = Color($int) 16 | ``` 17 | 18 | ```diff 19 | - Color(0XFF000000) // Not supported 20 | + val black = Color(0XFF000000) 21 | ``` 22 | 23 | <> 24 | 25 | 26 | 27 | <> 28 | 29 | ## Installation 30 | 31 | - Using IDE built-in plugin system: 32 | 33 | Preferences > Plugins > Marketplace > Search for "Highlight Colors for Compose" > 34 | Install Plugin 35 | 36 | - Manually: 37 | 38 | Download the [latest release](https://github.com/KaustubhPatange/compose-color/releases/latest) and install it manually using 39 | Preferences > Plugins > ⚙️ > Install plugin from disk... 40 | 41 | ## License 42 | 43 | - [The Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) 44 | 45 | ``` 46 | Copyright 2020 Kaustubh Patange 47 | 48 | Licensed under the Apache License, Version 2.0 (the "License"); 49 | you may not use this file except in compliance with the License. 50 | You may obtain a copy of the License at 51 | 52 | https://www.apache.org/licenses/LICENSE-2.0 53 | 54 | Unless required by applicable law or agreed to in writing, software 55 | distributed under the License is distributed on an "AS IS" BASIS, 56 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 57 | See the License for the specific language governing permissions and 58 | limitations under the License. 59 | ``` 60 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | com.github.kaustubhpatange.composecolor 3 | Highlight Colors for Compose 4 | 0.0.7 5 | Kaustubh Patange 6 | 7 | androidx.compose.ui.graphics.Color
9 | Clicking on the color icon from the gutter will open a color picker dialog to modify the color. 10 |

11 | GitHub | Issues 12 | ]]>
13 | 14 | 0.0.7 16 | 19 |

0.0.6

20 | 24 |

0.0.5

25 | 29 |

0.0.4

30 | 33 |

0.0.3

34 | 37 |

0.0.2

38 | 41 |

0.0.1

42 | 46 | ]]> 47 |
48 | 49 | 50 | 51 | com.intellij.modules.platform 52 | 53 | 54 | 57 | 58 |
59 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/kotlin/com/github/kaustubhpatange/composecolor/DemoLineMarkerProvider.kt: -------------------------------------------------------------------------------- 1 | package com.github.kaustubhpatange.composecolor 2 | 3 | import com.intellij.codeHighlighting.Pass 4 | import com.intellij.codeInsight.daemon.GutterIconNavigationHandler 5 | import com.intellij.codeInsight.daemon.RelatedItemLineMarkerInfo 6 | import com.intellij.codeInsight.daemon.RelatedItemLineMarkerProvider 7 | import com.intellij.json.JsonElementTypes 8 | import com.intellij.openapi.application.runWriteAction 9 | import com.intellij.openapi.editor.markup.GutterIconRenderer 10 | import com.intellij.psi.PsiElement 11 | import com.intellij.psi.PsiFileFactory 12 | import com.intellij.psi.codeStyle.CodeStyleManager 13 | import com.intellij.ui.ColorPicker 14 | import com.intellij.util.ui.UIUtil 15 | import java.awt.Color 16 | import java.awt.image.BufferedImage 17 | import javax.swing.Icon 18 | import javax.swing.ImageIcon 19 | 20 | class DemoLineMarkerProvider : RelatedItemLineMarkerProvider() { 21 | companion object { 22 | const val REFERENCE_EXPRESSION = "val(.*?)=\\s+?Color\\((\\s+)?(.*?)(\\s+)?\\)" 23 | const val RGBA_EXPRESSION = "(\\d+)f?(\\s+)?,(\\s+)?(\\d+)f?(\\s+)?,(\\s+)?(\\d+)f?(,(\\s+)?(\\d+)f?)?" 24 | } 25 | 26 | override fun collectNavigationMarkers(element: PsiElement, result: MutableCollection>) { 27 | if (element.node.elementType.toString() != JsonElementTypes::PROPERTY.name) return 28 | 29 | if (REFERENCE_EXPRESSION.toRegex().containsMatchIn(element.text)) { 30 | val colorHex: String = REFERENCE_EXPRESSION.toRegex().find(element.text)?.groups?.get(3)?.value ?: return 31 | 32 | // Support for Color(0xFFFFFFFF) 33 | if (colorHex.length == 10 && colorHex.startsWith("0XFF", true)) { 34 | val color = Color.decode("#" + colorHex.substring(4)) 35 | result.add(getLineMarker(element, color, true)) 36 | } 37 | // Support for Color(red,blue,green,alpha,...) 38 | else if (colorHex.matches(RGBA_EXPRESSION.toRegex())) { 39 | val matches = RGBA_EXPRESSION.toRegex().find(colorHex)?.groups!! 40 | val red = matches[1]?.value?.toInt() ?: 0 41 | val green = matches[4]?.value?.toInt() ?: 0 42 | val blue = matches[7]?.value?.toInt() ?: 0 43 | val alpha = matches[10]?.value?.toInt() ?: 255 44 | 45 | val color = Color(red, green, blue, alpha) 46 | result.add(getLineMarker(element, color)) 47 | } 48 | } 49 | } 50 | 51 | private fun getColorIcon(color: Color): Icon { 52 | val image = UIUtil.createImage(7, 7, BufferedImage.TYPE_INT_RGB) 53 | image.graphics.apply { 54 | setColor(color) 55 | fillRect(0, 0, 7, 7) 56 | } 57 | return ImageIcon(image) 58 | } 59 | 60 | private fun getLineMarker(element: PsiElement, color: Color, runAction: Boolean = false): RelatedItemLineMarkerInfo { 61 | val navHandler = if (runAction) GutterIconNavigationHandler { _, elt: PsiElement -> 62 | if (elt.containingFile.isWritable) { 63 | ColorPicker.showColorPickerPopup(elt.project, color) { c: Color, _ -> 64 | if (c.rgb == color.rgb) return@showColorPickerPopup 65 | runWriteAction { 66 | val original = "Color(0x${Integer.toHexString(color.rgb).toUpperCase()})" 67 | val new = "Color(0x${Integer.toHexString(c.rgb).toUpperCase()})" 68 | val psiFile = PsiFileFactory.getInstance(element.project).createFileFromText(element.language, new) 69 | val rElement = element.children.find { it.text.equals(original, ignoreCase = true) } 70 | rElement?.replace(psiFile.children[2]) 71 | CodeStyleManager.getInstance(element.project).reformat(element) 72 | } 73 | } 74 | } 75 | } else null 76 | 77 | return object : RelatedItemLineMarkerInfo( 78 | element, 79 | element.textRange, 80 | getColorIcon(color), 81 | Pass.UPDATE_ALL, 82 | null, 83 | navHandler, 84 | GutterIconRenderer.Alignment.CENTER, 85 | emptyList() 86 | ) { } 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: 3 | push: 4 | paths: 5 | - ".github/**" 6 | - "src/**" 7 | - "build.gradle.kts" 8 | - "settings.gradle.kts" 9 | pull_request: 10 | jobs: 11 | # Run Gradle Wrapper Validation Action to verify the wrapper's checksum 12 | gradleValidation: 13 | name: Gradle Wrapper 14 | runs-on: ubuntu-latest 15 | steps: 16 | # Check out current repository 17 | - name: Fetch Sources 18 | uses: actions/checkout@v2 19 | 20 | # Validate wrapper 21 | - name: Gradle Wrapper Validation 22 | uses: gradle/wrapper-validation-action@v1.0.3 23 | 24 | build: 25 | name: Build 26 | runs-on: ubuntu-latest 27 | outputs: 28 | name: ${{ steps.properties.outputs.name }} 29 | version: ${{ steps.properties.outputs.version }} 30 | changelog: ${{ steps.properties.outputs.changelog }} 31 | artifact: ${{ steps.properties.outputs.artifact }} 32 | steps: 33 | # Setup Java 1.8 environment for the next steps 34 | - name: Setup Java 35 | uses: actions/setup-java@v1 36 | with: 37 | java-version: 11 38 | 39 | # Check out current repository 40 | - name: Fetch Sources 41 | uses: actions/checkout@v2 42 | 43 | # Cache Gradle Dependencies 44 | - name: Setup Gradle Dependencies Cache 45 | uses: actions/cache@v2 46 | with: 47 | path: ~/.gradle/caches 48 | key: ${{ runner.os }}-gradle-caches-${{ hashFiles('**/*.gradle', '**/*.gradle.kts', 'gradle.properties') }} 49 | 50 | # Cache Gradle Wrapper 51 | - name: Setup Gradle Wrapper Cache 52 | uses: actions/cache@v2 53 | with: 54 | path: ~/.gradle/wrapper 55 | key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }} 56 | 57 | # Set environment variables 58 | - name: Export Properties 59 | id: properties 60 | shell: bash 61 | run: | 62 | PROPERTIES="$(./gradlew properties --console=plain -q)" 63 | VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')" 64 | NAME="$(echo "$PROPERTIES" | grep "^pluginName:" | cut -f2- -d ' ')" 65 | CHANGELOG="This is a test changelog, update it from plugin.xml" 66 | CHANGELOG="${CHANGELOG//'%'/'%25'}" 67 | CHANGELOG="${CHANGELOG//$'\n'/'%0A'}" 68 | CHANGELOG="${CHANGELOG//$'\r'/'%0D'}" 69 | ARTIFACT="${NAME}-${VERSION}.zip" 70 | 71 | echo "::set-output name=version::$VERSION" 72 | echo "::set-output name=name::$NAME" 73 | echo "::set-output name=changelog::$CHANGELOG" 74 | echo "::set-output name=artifact::$ARTIFACT" 75 | 76 | # Build artifact using buildPlugin Gradle task 77 | - name: Build Plugin 78 | run: ./gradlew buildPlugin 79 | 80 | # Upload plugin artifact to make it available in the next jobs 81 | - name: Upload artifact 82 | uses: actions/upload-artifact@v1 83 | with: 84 | name: plugin-artifact 85 | path: ./build/distributions/${{ needs.build.outputs.artifact }} 86 | 87 | # Verify built plugin using IntelliJ Plugin Verifier tool 88 | # Requires build job to be passed 89 | verify: 90 | name: Verify 91 | needs: build 92 | runs-on: ubuntu-latest 93 | steps: 94 | # Setup Java 1.8 environment for the next steps 95 | - name: Setup Java 96 | uses: actions/setup-java@v1 97 | with: 98 | java-version: 11 99 | 100 | # Check out current repository 101 | - name: Fetch Sources 102 | uses: actions/checkout@v2 103 | 104 | # Cache Gradle Dependencies 105 | - name: Setup Gradle Dependencies Cache 106 | uses: actions/cache@v2 107 | with: 108 | path: ~/.gradle/caches 109 | key: ${{ runner.os }}-gradle-caches-${{ hashFiles('**/*.gradle', '**/*.gradle.kts', 'gradle.properties') }} 110 | 111 | # Cache Gradle Wrapper 112 | - name: Setup Gradle Wrapper Cache 113 | uses: actions/cache@v2 114 | with: 115 | path: ~/.gradle/wrapper 116 | key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }} 117 | 118 | # Set environment variables 119 | - name: Export Properties 120 | id: properties 121 | shell: bash 122 | run: | 123 | PROPERTIES="$(./gradlew properties --console=plain -q)" 124 | IDE_VERSIONS="$(echo "$PROPERTIES" | grep "^pluginVerifierIdeVersions:" | base64)" 125 | 126 | echo "::set-output name=ideVersions::$IDE_VERSIONS" 127 | echo "::set-output name=pluginVerifierHomeDir::~/.pluginVerifier" 128 | 129 | # Cache Plugin Verifier IDEs 130 | - name: Setup Plugin Verifier IDEs Cache 131 | uses: actions/cache@v2 132 | with: 133 | path: ${{ steps.properties.outputs.pluginVerifierHomeDir }}/ides 134 | key: ${{ runner.os }}-plugin-verifier-${{ steps.properties.outputs.ideVersions }} 135 | 136 | # Run IntelliJ Plugin Verifier action using GitHub Action 137 | - name: Verify Plugin 138 | run: ./gradlew verifyPlugin 139 | 140 | # Prepare a draft release for GitHub Releases page for the manual verification 141 | # If accepted and published, release workflow would be triggered 142 | releaseDraft: 143 | name: Release Draft 144 | if: github.event_name != 'pull_request' 145 | needs: [build, verify] 146 | runs-on: ubuntu-latest 147 | steps: 148 | # Check out current repository 149 | - name: Fetch Sources 150 | uses: actions/checkout@v2 151 | 152 | # Remove old release drafts by using the curl request for the available releases with draft flag 153 | - name: Remove Old Release Drafts 154 | env: 155 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 156 | run: | 157 | curl -H "Authorization: Bearer $GITHUB_TOKEN" https://api.github.com/repos/$GITHUB_REPOSITORY/releases \ 158 | | tr '\r\n' ' ' \ 159 | | jq '.[] | select(.draft == true) | .id' \ 160 | | xargs -I '{}' \ 161 | curl -X DELETE -H "Authorization: Bearer $GITHUB_TOKEN" https://api.github.com/repos/$GITHUB_REPOSITORY/releases/{} 162 | 163 | # Create new release draft - which is not publicly visible and requires manual acceptance 164 | - name: Create Release Draft 165 | id: createDraft 166 | uses: actions/create-release@v1 167 | env: 168 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 169 | with: 170 | tag_name: v${{ needs.build.outputs.version }} 171 | release_name: v${{ needs.build.outputs.version }} 172 | body: ${{ needs.build.outputs.changelog }} 173 | draft: true 174 | 175 | # Download plugin artifact provided by the previous job 176 | - name: Download Artifact 177 | uses: actions/download-artifact@v2 178 | with: 179 | name: plugin-artifact 180 | 181 | # Upload artifact as a release asset 182 | - name: Upload Release Asset 183 | id: upload-release-asset 184 | uses: actions/upload-release-asset@v1 185 | env: 186 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 187 | with: 188 | upload_url: ${{ steps.createDraft.outputs.upload_url }} 189 | asset_path: ./${{ needs.build.outputs.artifact }} 190 | asset_name: ${{ needs.build.outputs.artifact }} 191 | asset_content_type: application/zip -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. --------------------------------------------------------------------------------