Merge pull request #9 from zowe/feature/GH-4

GH-4 Copybooks local paths resolve mechanism added

.gitignore

@@ -15,6 +15,7 @@ build/
 out/
 !**/src/main/**/out/
 !**/src/test/**/out/
+.intellijPlatform
 
 ### Eclipse ###
 .apt_generated
@@ -39,4 +40,4 @@ bin/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store

README.md

@@ -4,6 +4,43 @@ Provides:
 - syntax highlighting support using TextMate bundle from [eclipse-che4z/che-che4z-lsp-for-cobol](https://github.com/eclipse-che4z/che-che4z-lsp-for-cobol)
 - code actions using LSP technology with client from [redhat-developer/lsp4ij](https://github.com/redhat-developer/lsp4ij) and server from [eclipse-che4z/che-che4z-lsp-for-cobol](https://github.com/eclipse-che4z/che-che4z-lsp-for-cobol)
 
+## Supported features
+
+### Syntax Highlighting and Coloring
+
+The feature allows to inspect COBOL sources with highlighted instructions, recognized as COBOL language elements, colored respective to their type.
+
+### Syntax and Semantic Code Check
+
+The plug-in walks through the content of COBOL source files and checks it for mistakes and errors, highlighting it respectively with suggestions on how to fix them. 
+
+### Code Autocompletion
+
+The feature provides a functionality to autocomplete instructions, suggesting the possible options to complete the words being typed (works for .cob/.cbl files, not for copybooks).
+
+### Copybooks Recognition
+
+The plug-in recognizes local copybooks, used in COBOL sources. The .cpy/.copy files content is highlighted as COBOL source code.
+To use local copybooks:
+1. Create **.vscode** folder in your opened workspace
+2. Create **settings.json** in the **.vscode** folder
+3. Enter relative or absolute paths of the folders, where copybooks are placed
+
+Example of the **settings.json** content:
+```json5
+{
+  //...
+  "cobol-lsp.cpy-manager.paths-local": [
+    ".copybooks/zowe-profile-1/DATA.SET.PATH1",
+    ".copybooks/some-path",
+    "/some/absolute/path"
+  ],
+  //...
+}
+```
+
+The plug-in will search through the paths to find related copybook files. Using "Go To Definition" functionality will open the found copybook.
+
 ## Prerequisites
 
 - Java v17

build.gradle.kts

@@ -12,71 +12,89 @@
  *   Zowe Community
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.jetbrains.intellij.platform.gradle.TestFrameworkType
+
+//!IMPORTANT!: to refer "libs", use ./gradle/libs.versions.toml
 
 fun properties(key: String) = providers.gradleProperty(key)
 
 plugins {
-  id("java")
-  id("org.jetbrains.kotlin.jvm") version "1.9.21"
-  id("org.jetbrains.intellij") version "1.16.1"
-  id("org.jetbrains.kotlinx.kover") version "0.8.1"
+  alias(libs.plugins.gradle) // IntelliJ Platform Gradle Plugin
+  alias(libs.plugins.kotlinJvm)
+  alias(libs.plugins.kover)
+  java
 }
 
 group = properties("pluginGroup").get()
 version = properties("pluginVersion").get()
-val kotestVersion = "5.9.1"
-val mockkVersion = "1.13.12"
-val junitVersion = "1.10.3"
+val lsp4ijVersion = "0.7.0"
 
 repositories {
   mavenCentral()
+  intellijPlatform {
+    defaultRepositories()
+    jetbrainsRuntime()
+  }
+}
+
+java {
+  sourceCompatibility = JavaVersion.VERSION_17
+  targetCompatibility = JavaVersion.VERSION_17
+}
+
+kotlin {
+  jvmToolchain {
+    languageVersion.set(JavaLanguageVersion.of(JavaVersion.VERSION_17.toString()))
+  }
 }
 
 // Configure Gradle IntelliJ Plugin
-// Read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
-intellij {
-  version.set(properties("platformVersion").get())
-//  pluginsRepositories {
-//    custom("https://plugins.jetbrains.com/plugins/nightly/23257")
-//  }
-  plugins.set(listOf("org.jetbrains.plugins.textmate", "com.redhat.devtools.lsp4ij:0.4.0"))
+// Read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html
+intellijPlatform {
+  pluginConfiguration {
+    version = properties("platformVersion").get()
+    ideaVersion {
+      sinceBuild = properties("pluginSinceBuild").get()
+      untilBuild = provider { null }
+    }
+  }
 }
 
 dependencies {
+  // ===== Runtime env setup ===
+  // IntelliJ
+  intellijPlatform {
+    intellijIdeaCommunity(properties("platformVersion").get(), useInstaller = false)
+    jetbrainsRuntime()
+    instrumentationTools()
+    bundledPlugin("org.jetbrains.plugins.textmate")
+////  pluginsRepositories {
+////    custom("https://plugins.jetbrains.com/plugins/nightly/23257")
+////  }
+    plugin("com.redhat.devtools.lsp4ij:$lsp4ijVersion")
+    testFramework(TestFrameworkType.Plugin.Java)
+  }
+  // Gson
+  implementation(libs.gson)
   // ===== Test env setup =====
   // Kotest
-  testImplementation("io.kotest:kotest-runner-junit5:$kotestVersion")
-  testImplementation("io.kotest:kotest-assertions-core:$kotestVersion")
+  testImplementation(libs.kotest.runner.junit5)
+  testImplementation(libs.kotest.assertions.core)
   // MockK
-  testImplementation("io.mockk:mockk:$mockkVersion")
+  testImplementation(libs.mockk)
   // JUnit Platform (needed for Kotest)
-  testImplementation("org.junit.platform:junit-platform-launcher:$junitVersion")
+  testImplementation(libs.junit.platform.launcher)
   // ==========================
 
 }
 
 tasks {
-  // Set the JVM compatibility versions
-  withType<JavaCompile> {
-    sourceCompatibility = JavaVersion.VERSION_17.toString()
-    targetCompatibility = JavaVersion.VERSION_17.toString()
-  }
-  withType<KotlinCompile> {
-    kotlinOptions.jvmTarget = JavaVersion.VERSION_17.toString()
-  }
-
-  patchPluginXml {
-    version.set(properties("pluginVersion").get())
-    sinceBuild.set(properties("pluginSinceBuild").get())
-    untilBuild.set(properties("pluginUntilBuild").get())
-  }
-
   test {
     useJUnitPlatform()
     testLogging {
       events("passed", "skipped", "failed")
     }
     finalizedBy("koverHtmlReport")
+//    testLogging.showStandardStreams = true
   }
 }

gradle.properties

@@ -17,3 +17,4 @@ pluginGroup = org.zowe
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 232
 pluginUntilBuild =
+

gradle/libs.versions.toml

@@ -0,0 +1,26 @@
+[versions]
+# libraries
+gson = "2.11.0"
+kotest = "5.9.1"
+mockk = "1.13.13"
+junit = "1.11.3"
+
+# plugins
+gradle = "2.1.0"
+kotlinJvm = "1.9.22"
+kover = "0.8.3"
+
+[libraries]
+# build deps
+gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }
+
+# test deps
+kotest-runner-junit5 = { group = "io.kotest", name = "kotest-runner-junit5", version.ref = "kotest" }
+kotest-assertions-core = { group = "io.kotest", name = "kotest-assertions-core", version.ref = "kotest" }
+mockk = { group = "io.mockk", name = "mockk", version.ref = "mockk" }
+junit-platform-launcher = { group = "org.junit.platform", name = "junit-platform-launcher", version = "junit" }
+
+[plugins]
+gradle = { id = "org.jetbrains.intellij.platform", version.ref = "gradle" }
+kotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlinJvm" }
+kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# 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"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    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
@@ -193,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +41,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+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!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+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

src/main/kotlin/org/zowe/cobol/CobolProjectManagerListener.kt

@@ -31,7 +31,7 @@ class CobolProjectManagerListener : ProjectManagerListener {
    */
   @OptIn(InitializationOnly::class)
   override fun projectClosing(project: Project) {
-    val lsStateService = LanguageSupportStateService.instance
+    val lsStateService = LanguageSupportStateService.getService()
     val pluginState = lsStateService.getPluginState(project) { CobolPluginState(project) }
 
     if (isLastProjectClosing() && (pluginState.isLSPClientReady() || pluginState.isLSPServerConnectionReady())) {