├── .gitignore
├── .run
    └── Run IDE with Plugin.run.xml
├── LICENSE
├── README.md
├── build.gradle.kts
├── deploy.sh
├── gradlew
├── gradlew.bat
├── images
    ├── image01.png
    ├── image02.png
    ├── image03.png
    └── image04.png
├── settings.gradle.kts
└── src
    ├── main
        ├── java
        │   └── com
        │   │   └── dwilden
        │   │       └── crondescriptor
        │   │           ├── BaseCronExpressionAnnotator.java
        │   │           ├── JavaCronExpressionAnnotator.java
        │   │           ├── KotlinCronExpressionAnnotator.java
        │   │           ├── PropertiesCronExpressionAnnotator.java
        │   │           └── YamlCronExpressionAnnotator.java
        └── resources
        │   └── META-INF
        │       ├── java-features.xml
        │       ├── kotlin-features.xml
        │       ├── plugin.xml
        │       ├── pluginIcon.svg
        │       ├── properties-features.xml
        │       └── yaml-features.xml
    └── test
        └── java
            └── com
                └── dwilden
                    └── crondescriptor
                        └── BaseCronExpressionAnnotatorTest.java


/.gitignore:
--------------------------------------------------------------------------------
 1 | .credentials
 2 | .gradle
 3 | build/
 4 | gradle
 5 | !**/src/main/**/build/
 6 | !**/src/test/**/build/
 7 | 
 8 | ### IntelliJ IDEA ###
 9 | .idea
10 | *.iws
11 | *.iml
12 | *.ipr
13 | out/
14 | !**/src/main/**/out/
15 | !**/src/test/**/out/
16 | 
17 | ### Eclipse ###
18 | .apt_generated
19 | .classpath
20 | .factorypath
21 | .project
22 | .settings
23 | .springBeans
24 | .sts4-cache
25 | bin/
26 | !**/src/main/**/bin/
27 | !**/src/test/**/bin/
28 | 
29 | ### NetBeans ###
30 | /nbproject/private/
31 | /nbbuild/
32 | /dist/
33 | /nbdist/
34 | /.nb-gradle/
35 | 
36 | ### VS Code ###
37 | .vscode/
38 | 
39 | ### Mac OS ###
40 | .DS_Store


--------------------------------------------------------------------------------
/.run/Run IDE with Plugin.run.xml:
--------------------------------------------------------------------------------
 1 | <component name="ProjectRunConfigurationManager">
 2 |   <configuration default="false" name="Run Plugin" type="GradleRunConfiguration" factoryName="Gradle">
 3 |     <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
 4 |     <ExternalSystemSettings>
 5 |       <option name="executionName" />
 6 |       <option name="externalProjectPath" value="$PROJECT_DIR$" />
 7 |       <option name="externalSystemIdString" value="GRADLE" />
 8 |       <option name="scriptParameters" value="--stacktrace" />
 9 |       <option name="taskDescriptions">
10 |         <list />
11 |       </option>
12 |       <option name="taskNames">
13 |         <list>
14 |           <option value="runIde" />
15 |         </list>
16 |       </option>
17 |       <option name="vmOptions" value="" />
18 |     </ExternalSystemSettings>
19 |     <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
20 |     <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
21 |     <DebugAllEnabled>false</DebugAllEnabled>
22 |     <method v="2" />
23 |   </configuration>
24 | </component>


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 random-dwi
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # cron-descriptor
 2 | IntelliJ IDEA Plugin to display a human readable description for cron expressions as tooltip.
 3 | 
 4 | After installing the plugin open a file in the editor,
 5 | detected Cron expressions are now underlined and by hovering over the expression with the mouse a tooltip with the description will be displayed.
 6 | 
 7 | **Supports:** Java, Kotlin, Properties, Yaml
 8 | 
 9 | | ![Example Java](images/image01.png)           |
10 | | --------------------------------------------- |
11 | | 01. Example Tooltip, Java with IntelliJ Theme |
12 | 
13 | | ![Example Yaml](images/image02.png)           |
14 | | --------------------------------------------- |
15 | | 02. Example Tooltip, Yaml with IntelliJ Theme |
16 | 
17 | | ![Example Properties](images/image03.png)          |
18 | | -------------------------------------------------- |
19 | | 03. Example Tooltip, Properties with Dracula Theme |
20 | 
21 | | ![Example Kotlin](images/image04.png)          |
22 | | ---------------------------------------------- |
23 | | 04. Example Tooltip, Kotlin with Dracula Theme |


--------------------------------------------------------------------------------
/build.gradle.kts:
--------------------------------------------------------------------------------
 1 | plugins {
 2 | 	id("java")
 3 | 	id("org.jetbrains.intellij") version "1.8.0"
 4 | }
 5 | 
 6 | group = "com.dwilden"
 7 | version = "1.5"
 8 | 
 9 | repositories {
10 | 	mavenCentral()
11 | }
12 | 
13 | dependencies {
14 | 	implementation("net.redhogs.cronparser", "cron-parser-core", "3.5") {
15 | 		exclude("org.slf4j", "slf4j-api")
16 | 	}
17 | 	testImplementation("junit", "junit", "4.12")
18 | 	testImplementation("org.assertj", "assertj-core", "3.23.1")
19 | }
20 | 
21 | // Configure Gradle IntelliJ Plugin
22 | // Read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
23 | intellij {
24 | 	version.set("2022.1.4")
25 | 	type.set("IC") // Target IDE Platform
26 | 
27 | 	plugins.set(listOf("org.jetbrains.kotlin:221-1.7.10-release-333-IJ5591.52", "java", "java-i18n", "properties", "yaml"))
28 | }
29 | 
30 | tasks {
31 | 	// Set the JVM compatibility versions
32 | 	withType<JavaCompile> {
33 | 		sourceCompatibility = "11"
34 | 		targetCompatibility = "11"
35 | 	}
36 | 
37 | 	patchPluginXml {
38 | 		sinceBuild.set("213")
39 | 		untilBuild.set("")
40 | 		changeNotes.set("""
41 |       <B>1.0</B> Initial Release of plugin<br>
42 |       <B>1.1</B> localization, 24h time format<br>
43 |       <B>1.2</B> Improved support for intellij builds, fix for dayOfWeek<br>
44 | 	  <B>1.3</B> Support for more versions<br>
45 | 	  <B>1.4</B> Remove deprecated API calls<br>
46 | 	  <B>1.5</B> Fix exception handling<br>
47 |       """)
48 | 	}
49 | 
50 | 	signPlugin {
51 | 		certificateChain.set(System.getenv("CERTIFICATE_CHAIN"))
52 | 		privateKey.set(System.getenv("PRIVATE_KEY"))
53 | 		password.set(System.getenv("PRIVATE_KEY_PASSWORD"))
54 | 	}
55 | 
56 | 	publishPlugin {
57 | 		token.set(System.getenv("PUBLISH_TOKEN"))
58 | 	}
59 | }
60 | 


--------------------------------------------------------------------------------
/deploy.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | 
3 | export CERTIFICATE_CHAIN=$(cat .credentials/chain.crt)
4 | export PRIVATE_KEY=$(cat .credentials/private.pem)
5 | export PRIVATE_KEY_PASSWORD=$(cat .credentials/privatekey.pw)
6 | export PUBLISH_TOKEN=$(cat .credentials/token)
7 | 
8 | ./gradlew publishPlugin


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015-2021 the original 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 POSIX generated by Gradle.
 22 | #
 23 | #   Important for running:
 24 | #
 25 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 26 | #       noncompliant, but you have some other compliant shell such as ksh or
 27 | #       bash, then to run this script, type that shell name before the whole
 28 | #       command line, like:
 29 | #
 30 | #           ksh Gradle
 31 | #
 32 | #       Busybox and similar reduced shells will NOT work, because this script
 33 | #       requires all of these POSIX shell features:
 34 | #         * functions;
 35 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 36 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 37 | #         * compound commands having a testable exit status, especially «case»;
 38 | #         * various built-in commands including «command», «set», and «ulimit».
 39 | #
 40 | #   Important for patching:
 41 | #
 42 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 43 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 44 | #
 45 | #       The "traditional" practice of packing multiple parameters into a
 46 | #       space-separated string is a well documented source of bugs and security
 47 | #       problems, so this is (mostly) avoided, by progressively accumulating
 48 | #       options in "$@", and eventually passing that to Java.
 49 | #
 50 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 51 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 52 | #       see the in-line comments for details.
 53 | #
 54 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 55 | #       Darwin, MinGW, and NonStop.
 56 | #
 57 | #   (3) This script is generated from the Groovy template
 58 | #       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 59 | #       within the Gradle project.
 60 | #
 61 | #       You can find Gradle at https://github.com/gradle/gradle/.
 62 | #
 63 | ##############################################################################
 64 | 
 65 | # Attempt to set APP_HOME
 66 | 
 67 | # Resolve links: $0 may be a link
 68 | app_path=$0
 69 | 
 70 | # Need this for daisy-chained symlinks.
 71 | while
 72 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 73 |     [ -h "$app_path" ]
 74 | do
 75 |     ls=$( ls -ld "$app_path" )
 76 |     link=${ls#*' -> '}
 77 |     case $link in             #(
 78 |       /*)   app_path=$link ;; #(
 79 |       *)    app_path=$APP_HOME$link ;;
 80 |     esac
 81 | done
 82 | 
 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 84 | 
 85 | APP_NAME="Gradle"
 86 | APP_BASE_NAME=${0##*/}
 87 | 
 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 90 | 
 91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 92 | MAX_FD=maximum
 93 | 
 94 | warn () {
 95 |     echo "$*"
 96 | } >&2
 97 | 
 98 | die () {
 99 |     echo
100 |     echo "$*"
101 |     echo
102 |     exit 1
103 | } >&2
104 | 
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in                #(
111 |   CYGWIN* )         cygwin=true  ;; #(
112 |   Darwin* )         darwin=true  ;; #(
113 |   MSYS* | MINGW* )  msys=true    ;; #(
114 |   NONSTOP* )        nonstop=true ;;
115 | esac
116 | 
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 | 
119 | 
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 |         # IBM's JDK on AIX uses strange locations for the executables
124 |         JAVACMD=$JAVA_HOME/jre/sh/java
125 |     else
126 |         JAVACMD=$JAVA_HOME/bin/java
127 |     fi
128 |     if [ ! -x "$JAVACMD" ] ; then
129 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 | 
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 |     fi
134 | else
135 |     JAVACMD=java
136 |     which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 | 
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 | 
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 |     case $MAX_FD in #(
145 |       max*)
146 |         MAX_FD=$( ulimit -H -n ) ||
147 |             warn "Could not query maximum file descriptor limit"
148 |     esac
149 |     case $MAX_FD in  #(
150 |       '' | soft) :;; #(
151 |       *)
152 |         ulimit -n "$MAX_FD" ||
153 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
154 |     esac
155 | fi
156 | 
157 | # Collect all arguments for the java command, stacking in reverse order:
158 | #   * args from the command line
159 | #   * the main class name
160 | #   * -classpath
161 | #   * -D...appname settings
162 | #   * --module-path (only if needed)
163 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164 | 
165 | # For Cygwin or MSYS, switch paths to Windows format before running java
166 | if "$cygwin" || "$msys" ; then
167 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168 |     CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169 | 
170 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
171 | 
172 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
173 |     for arg do
174 |         if
175 |             case $arg in                                #(
176 |               -*)   false ;;                            # don't mess with options #(
177 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
178 |                     [ -e "$t" ] ;;                      #(
179 |               *)    false ;;
180 |             esac
181 |         then
182 |             arg=$( cygpath --path --ignore --mixed "$arg" )
183 |         fi
184 |         # Roll the args list around exactly as many times as the number of
185 |         # args, so each arg winds up back in the position where it started, but
186 |         # possibly modified.
187 |         #
188 |         # NB: a `for` loop captures its iteration list before it begins, so
189 |         # changing the positional parameters here affects neither the number of
190 |         # iterations, nor the values presented in `arg`.
191 |         shift                   # remove old arg
192 |         set -- "$@" "$arg"      # push replacement arg
193 |     done
194 | fi
195 | 
196 | # Collect all arguments for the java command;
197 | #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198 | #     shell script including quotes and variable substitutions, so put them in
199 | #     double quotes to make sure that they get re-expanded; and
200 | #   * put everything else in single quotes, so that it's not re-expanded.
201 | 
202 | set -- \
203 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
204 |         -classpath "$CLASSPATH" \
205 |         org.gradle.wrapper.GradleWrapperMain \
206 |         "$@"
207 | 
208 | # Use "xargs" to parse quoted args.
209 | #
210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211 | #
212 | # In Bash we could simply go:
213 | #
214 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215 | #   set -- "${ARGS[@]}" "$@"
216 | #
217 | # but POSIX shell has neither arrays nor command substitution, so instead we
218 | # post-process each arg (as a line of input to sed) to backslash-escape any
219 | # character that might be a shell metacharacter, then use eval to reverse
220 | # that process (while maintaining the separation between arguments), and wrap
221 | # the whole thing up as a single "set" statement.
222 | #
223 | # This will of course break if any of these variables contains a newline or
224 | # an unmatched quote.
225 | #
226 | 
227 | eval "set -- $(
228 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229 |         xargs -n1 |
230 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231 |         tr '\n' ' '
232 |     )" '"$@"'
233 | 
234 | exec "$JAVACMD" "$@"
235 | 


--------------------------------------------------------------------------------
/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 | 


--------------------------------------------------------------------------------
/images/image01.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/d-rk/cron-descriptor/20030f717b161428d19cea93755e049b17245e51/images/image01.png


--------------------------------------------------------------------------------
/images/image02.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/d-rk/cron-descriptor/20030f717b161428d19cea93755e049b17245e51/images/image02.png


--------------------------------------------------------------------------------
/images/image03.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/d-rk/cron-descriptor/20030f717b161428d19cea93755e049b17245e51/images/image03.png


--------------------------------------------------------------------------------
/images/image04.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/d-rk/cron-descriptor/20030f717b161428d19cea93755e049b17245e51/images/image04.png


--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | rootProject.name = "cron-descriptor"


--------------------------------------------------------------------------------
/src/main/java/com/dwilden/crondescriptor/BaseCronExpressionAnnotator.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import static com.intellij.lang.annotation.HighlightSeverity.INFORMATION;
 4 | 
 5 | import com.intellij.lang.annotation.AnnotationHolder;
 6 | import com.intellij.lang.annotation.Annotator;
 7 | import com.intellij.openapi.editor.DefaultLanguageHighlighterColors;
 8 | import com.intellij.openapi.util.TextRange;
 9 | import com.intellij.psi.PsiElement;
10 | import net.redhogs.cronparser.CronExpressionDescriptor;
11 | import net.redhogs.cronparser.Options;
12 | import org.apache.commons.lang3.StringUtils;
13 | import org.jetbrains.annotations.NotNull;
14 | 
15 | import java.util.Locale;
16 | import java.util.regex.Pattern;
17 | 
18 | public abstract class BaseCronExpressionAnnotator<T> implements Annotator {
19 | 
20 | 	protected static final Pattern INVALID_CHARS_REGEX = Pattern.compile("[^\\d|A-Z|? \\-,\\/*#]");
21 | 
22 | 	protected static final String DOUBLE_QUOTES = "\"";
23 | 	protected static final String QUOTES = "'";
24 | 	protected static final String WHITESPACE = " ";
25 | 	protected static final String DOUBLE_WHITESPACE = "  ";
26 | 
27 | 	private final Class<T> valueClass;
28 | 
29 | 	private final Options parserOptions;
30 | 
31 | 	public BaseCronExpressionAnnotator(Class<T> valueClass) {
32 | 		this.valueClass = valueClass;
33 | 		this.parserOptions = Options.twentyFourHour();
34 | 		this.parserOptions.setZeroBasedDayOfWeek(false);
35 | 		this.parserOptions.setThrowExceptionOnParseError(false);
36 | 	}
37 | 
38 | 	@Override
39 | 	public void annotate(@NotNull PsiElement element, @NotNull AnnotationHolder holder) {
40 | 
41 | 		if (!canHandleType(element)) {
42 | 			return;
43 | 		}
44 | 
45 | 		String cronExpression = extractText(valueClass.cast(element));
46 | 
47 | 		if (!isCronExpression(cronExpression)) {
48 | 			return;
49 | 		}
50 | 
51 | 		TextRange range = new TextRange(element.getTextRange().getStartOffset(), element.getTextRange().getEndOffset());
52 | 
53 | 		try {
54 | 			String description = CronExpressionDescriptor.getDescription(cronExpression, parserOptions, Locale.getDefault());
55 | 			holder.newAnnotation(INFORMATION, description)
56 | 					.range(range)
57 | 					.textAttributes(DefaultLanguageHighlighterColors.HIGHLIGHTED_REFERENCE)
58 | 					.create();
59 | 		} catch (Throwable e) {
60 | //			throw new RuntimeException(e);
61 | 		}
62 | 	}
63 | 
64 | 	static boolean isCronExpression(String expression) {
65 | 
66 | 		if (StringUtils.isBlank(expression)) {
67 | 			return false;
68 | 		}
69 | 
70 | 		if (expression.startsWith(WHITESPACE) || expression.endsWith(WHITESPACE)) {
71 | 			return false;
72 | 		}
73 | 
74 | 		if (expression.contains(DOUBLE_WHITESPACE)) {
75 | 			return false;
76 | 		}
77 | 
78 | 		int expressionParts = expression.split(WHITESPACE, 8).length;
79 | 
80 | 		if (expressionParts < 5 || expressionParts > 7) {
81 | 			return false;
82 | 		}
83 | 
84 | 		return !INVALID_CHARS_REGEX.matcher(expression).find();
85 | 	}
86 | 
87 | 	protected boolean canHandleType(@NotNull PsiElement element) {
88 | 		return valueClass.isAssignableFrom(element.getClass());
89 | 	}
90 | 
91 | 	protected abstract String extractText(T element);
92 | }
93 | 


--------------------------------------------------------------------------------
/src/main/java/com/dwilden/crondescriptor/JavaCronExpressionAnnotator.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import com.intellij.psi.PsiLiteralExpression;
 4 | 
 5 | public class JavaCronExpressionAnnotator extends BaseCronExpressionAnnotator<PsiLiteralExpression> {
 6 | 
 7 | 	public JavaCronExpressionAnnotator() {
 8 | 		super(PsiLiteralExpression.class);
 9 | 	}
10 | 
11 | 	@Override
12 | 	protected String extractText(PsiLiteralExpression element) {
13 | 		String rawText = element.getText();
14 | 		if (rawText.contains(DOUBLE_QUOTES)) {
15 | 			return element.getText().replace(DOUBLE_QUOTES, "");
16 | 		} else {
17 | 			return null;
18 | 		}
19 | 	}
20 | }
21 | 


--------------------------------------------------------------------------------
/src/main/java/com/dwilden/crondescriptor/KotlinCronExpressionAnnotator.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import com.intellij.psi.PsiElement;
 4 | import com.intellij.psi.impl.source.tree.LeafPsiElement;
 5 | import org.jetbrains.annotations.NotNull;
 6 | import org.jetbrains.kotlin.lexer.KtTokens;
 7 | 
 8 | public class KotlinCronExpressionAnnotator extends BaseCronExpressionAnnotator<LeafPsiElement> {
 9 | 
10 | 	public KotlinCronExpressionAnnotator() {
11 | 		super(LeafPsiElement.class);
12 | 	}
13 | 
14 | 	@Override
15 | 	protected boolean canHandleType(@NotNull PsiElement element) {
16 | 
17 | 		if (!super.canHandleType(element)) {
18 | 			return false;
19 | 		}
20 | 
21 | 		return KtTokens.REGULAR_STRING_PART.equals(((LeafPsiElement) element).getElementType());
22 | 	}
23 | 
24 | 	@Override
25 | 	protected String extractText(LeafPsiElement element) {
26 | 		return element.getText();
27 | 	}
28 | }
29 | 


--------------------------------------------------------------------------------
/src/main/java/com/dwilden/crondescriptor/PropertiesCronExpressionAnnotator.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import com.intellij.lang.properties.psi.impl.PropertyValueImpl;
 4 | 
 5 | public class PropertiesCronExpressionAnnotator extends BaseCronExpressionAnnotator<PropertyValueImpl> {
 6 | 
 7 | 	public PropertiesCronExpressionAnnotator() {
 8 | 		super(PropertyValueImpl.class);
 9 | 	}
10 | 
11 | 	@Override
12 | 	protected String extractText(PropertyValueImpl element) {
13 | 		return element.getText();
14 | 	}
15 | }
16 | 


--------------------------------------------------------------------------------
/src/main/java/com/dwilden/crondescriptor/YamlCronExpressionAnnotator.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import org.jetbrains.yaml.psi.impl.YAMLQuotedTextImpl;
 4 | 
 5 | public class YamlCronExpressionAnnotator extends BaseCronExpressionAnnotator<YAMLQuotedTextImpl> {
 6 | 
 7 | 	public YamlCronExpressionAnnotator() {
 8 | 		super(YAMLQuotedTextImpl.class);
 9 | 	}
10 | 
11 | 	@Override
12 | 	protected String extractText(YAMLQuotedTextImpl element) {
13 | 		return element.getText().replaceAll(QUOTES, "").replaceAll(DOUBLE_QUOTES, "");
14 | 	}
15 | }
16 | 


--------------------------------------------------------------------------------
/src/main/resources/META-INF/java-features.xml:
--------------------------------------------------------------------------------
1 | <idea-plugin>
2 | 	<extensions defaultExtensionNs="com.intellij">
3 | 		<annotator language="JAVA" implementationClass="com.dwilden.crondescriptor.JavaCronExpressionAnnotator" />
4 | 	</extensions>
5 | </idea-plugin>


--------------------------------------------------------------------------------
/src/main/resources/META-INF/kotlin-features.xml:
--------------------------------------------------------------------------------
1 | <idea-plugin>
2 | 	<extensions defaultExtensionNs="com.intellij">
3 | 		<annotator language="kotlin" implementationClass="com.dwilden.crondescriptor.KotlinCronExpressionAnnotator" />
4 | 	</extensions>
5 | </idea-plugin>


--------------------------------------------------------------------------------
/src/main/resources/META-INF/plugin.xml:
--------------------------------------------------------------------------------
 1 | <idea-plugin>
 2 | 	<id>com.dwilden.crondescriptor</id>
 3 | 	<name>Cron Descriptor</name>
 4 | 	<vendor email="dirk.wilden@device-insight.com" url="http://www.device-insight.com">Dirk Wilden</vendor>
 5 | 
 6 | 	<description><![CDATA[
 7 |     Plugin to display a human-readable description for cron expressions as tooltip<br><br>
 8 |     Supports: <em>Java, Kotlin, Properties, Yaml</em>
 9 |     ]]></description>
10 | 
11 | 	<depends optional="true" config-file="java-features.xml">com.intellij.modules.java</depends>
12 | 	<depends optional="true" config-file="kotlin-features.xml">org.jetbrains.kotlin</depends>
13 | 	<depends optional="true" config-file="properties-features.xml">com.intellij.properties</depends>
14 | 	<depends optional="true" config-file="yaml-features.xml">org.jetbrains.plugins.yaml</depends>
15 | </idea-plugin>


--------------------------------------------------------------------------------
/src/main/resources/META-INF/pluginIcon.svg:
--------------------------------------------------------------------------------
1 | <svg fill="#000000" xmlns="http://www.w3.org/2000/svg"  viewBox="0 0 48 48" width="48px" height="48px"><path d="M 24 4 C 12.972066 4 4 12.972074 4 24 C 4 35.027926 12.972066 44 24 44 C 35.027934 44 44 35.027926 44 24 C 44 12.972074 35.027934 4 24 4 z M 24 7 C 33.406615 7 41 14.593391 41 24 C 41 33.406609 33.406615 41 24 41 C 14.593385 41 7 33.406609 7 24 C 7 14.593391 14.593385 7 24 7 z M 23.476562 11.978516 A 1.50015 1.50015 0 0 0 22 13.5 L 22 25.5 A 1.50015 1.50015 0 0 0 23.5 27 L 31.5 27 A 1.50015 1.50015 0 1 0 31.5 24 L 25 24 L 25 13.5 A 1.50015 1.50015 0 0 0 23.476562 11.978516 z"/></svg>


--------------------------------------------------------------------------------
/src/main/resources/META-INF/properties-features.xml:
--------------------------------------------------------------------------------
1 | <idea-plugin>
2 | 	<extensions defaultExtensionNs="com.intellij">
3 | 		<annotator language="Properties" implementationClass="com.dwilden.crondescriptor.PropertiesCronExpressionAnnotator" />
4 | 	</extensions>
5 | </idea-plugin>


--------------------------------------------------------------------------------
/src/main/resources/META-INF/yaml-features.xml:
--------------------------------------------------------------------------------
1 | <idea-plugin>
2 | 	<extensions defaultExtensionNs="com.intellij">
3 | 		<annotator language="yaml" implementationClass="com.dwilden.crondescriptor.YamlCronExpressionAnnotator" />
4 | 	</extensions>
5 | </idea-plugin>


--------------------------------------------------------------------------------
/src/test/java/com/dwilden/crondescriptor/BaseCronExpressionAnnotatorTest.java:
--------------------------------------------------------------------------------
 1 | package com.dwilden.crondescriptor;
 2 | 
 3 | import static org.assertj.core.api.Assertions.assertThat;
 4 | 
 5 | import org.junit.Test;
 6 | 
 7 | public class BaseCronExpressionAnnotatorTest {
 8 | 
 9 | 	@Test
10 | 	public void testStartsWithWhitespace() {
11 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression(" 0 0 12 * * ?")).isFalse();
12 | 	}
13 | 
14 | 	@Test
15 | 	public void cronWithTooMuchWhitespaceFails() {
16 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 1  * * ?")).isFalse();
17 | 	}
18 | 
19 | 	@Test
20 | 	public void testEndsWithWhitespace() {
21 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 0 12 * * ? ")).isFalse();
22 | 	}
23 | 
24 | 	@Test
25 | 	public void testValidCronExpression() {
26 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 0 12 * * ?")).isTrue();
27 | 	}
28 | 
29 | 	@Test
30 | 	public void testInvalidCharacterInCron() {
31 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 0 % * * ?")).isFalse();
32 | 	}
33 | 
34 | 	@Test
35 | 	public void testCronExpressionTooShort() {
36 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 0 12 *")).isFalse();
37 | 	}
38 | 
39 | 	@Test
40 | 	public void testCronExpressionTooLong() {
41 | 		assertThat(BaseCronExpressionAnnotator.isCronExpression("0 0 12 * * * * *")).isFalse();
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------