Don't show Cypher autocompletion in comments (#4) (#23)

Disable Cypher autocompletion in comments inside a Cypher query.
Also, some work was done to refactor the Cypher BNF grammar and the lexer.

Author: albertoventurini

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Don't show Cypher autocompletion in comments (#4)
+
 ## [0.2.2]
 
 ### Fixed

README.md

@@ -50,6 +50,41 @@ Simply add the following comment right before a Cypher String:
 // language=Cypher
 ```
 
+## Building the plugin
+
+### Dependencies
+
+The plugin depends on JDK17 and the latest release of IntelliJ. Please make sure
+you have those installed on your machine.
+
+Moreover, if you plan on making changes to a grammar or lexer files, you also need
+to install the [Grammar-Kit](https://github.com/JetBrains/Grammar-Kit) IntelliJ plugin.
+
+### Build instructions
+
+If you changed a grammar or lexer files, you need to regenerate the lexer and parser classes.
+Please follow the instructions at [Grammar-Kit](https://github.com/JetBrains/Grammar-Kit)
+in order to do that.
+
+After that, the plugin can be built with the following Gradle command:
+
+```shell
+./gradlew :graph-database-plugin:buildPlugin
+```
+
+Before a release, the plugin should also be tested and verified with the following commands:
+
+```shell
+./gradlew test
+./gradlew :graph-database-plugin:runPluginVerifier
+```
+
+The plugin can also be manually tested on a sandboxed instance of IntelliJ with the command:
+
+```shell
+./gradlew :graph-database-plugin:runIde
+```
+
 ## Getting help
 
 Please feel free to report any bugs by creating a
@@ -66,6 +101,3 @@ Alternatively, if you find this plugin useful, please feel free to
 
 Any other comments or words of encouragement? Please get in touch
 via email at aventurini AT gmail DOT com.
-
-
-

build.gradle

@@ -26,19 +26,8 @@ ext.checkstyleConfigDir = "$configDir/checkstyle"
 
 allprojects {
 
-    buildscript {
-        repositories {
-            mavenCentral()
-            mavenLocal()
-            jcenter()
-        }
-    }
-
     repositories {
         mavenCentral()
-//        mavenLocal()
-//        jcenter()
-//        maven { url 'https://dl.bintray.com/jetbrains/intellij-plugin-service' }
     }
 
     apply plugin: 'java'
@@ -47,18 +36,16 @@ allprojects {
     sourceCompatibility = 17
     targetCompatibility = 17
 
-    intellij {
-        version = intellijSdkVersion
-        //instrumentCode = true
-        type = "IC"
-        plugins = ['java']
-    }
-
     checkstyle {
         toolVersion = "7.0"
         configFile = new File(checkstyleConfigDir, "checkstyle.xml")
         configProperties.checkstyleConfigDir = checkstyleConfigDir
     }
+
+    intellij {
+        version = intellijSdkVersion
+        plugins = ['java']
+    }
 }
 
 test {

language/cypher/build.gradle

@@ -5,7 +5,6 @@ apply plugin: "org.jetbrains.intellij"
 
 intellij {
     version = intellijSdkVersion
-    instrumentCode = true
     plugins = ['java']
 }
 
@@ -24,4 +23,3 @@ dependencies {
     testImplementation "org.mockito:mockito-core:$versionMockito"
     testImplementation "org.assertj:assertj-core:$versionAssertj"
 }
-