JCV Assistant

Related issues: #4 #5 #6

Author: leomillon

.editorconfig

@@ -1,5 +1,3 @@
-[*]
-indent_size = 2
-
-[*.{kt, kts}]
+[*.{kt,kts}]
 disabled_rules = import-ordering
+indent_size = 2

README.md

@@ -8,13 +8,35 @@ IntelliJ IDEA plugin for an enhanced coding experience on JCV based projects.
 
 ## Table of contents
 
-* [JCV autocomplete](#jcv-autocomplete)
-    * [Validators covered](#validators-covered)
-    * [How it works](#how-it-works)
-        * [Live templates](#live-templates)
-        * [Macros](#macros)
-    
-## JCV autocomplete
+* [Syntax Highlighting](#syntax-highlighting)
+* [Validator auto-completion](#validator-auto-completion)
+* [Replacement suggestions](#replacement-suggestions)
+
+## Syntax Highlighting
+
+It provides template colors and information about known JCV validators:
+
+![](./screenshots/jcv-syntax_highlighting.png)
+
+It will also detect invalid usages and give quick-fixes when possible:
+
+![](./screenshots/jcv-validation-unexpected_whitespaces.png)
+
+![](./screenshots/jcv-validation-unexpected_param.png)
+
+![](./screenshots/jcv-validation-empty_param.png)
+
+## Validator auto-completion
+
+It provides autocompletion for jcv validators in json files.
+
+Just start typing "{#" or any jcv validator id and press ctrl+space to see all the suggested validators:
+
+![](./screenshots/jcv-autocomplete_all.png)
+
+It also works for templated validators with suggested values:
+
+![](./screenshots/jcv-autocomplete_param.png)
 
 ### Validators covered
 [JCV](https://github.com/ekino/jcv) is a library allowing you to compare JSON contents with embedded validation.
@@ -26,20 +48,8 @@ designed to cover the most common needs when validating data with non-predictabl
 
 This plugin offers autocompletion on all the validators of these two projects to date.
 
-### How it works
-
-#### Live templates
-The plugin uses [live templates](https://www.jetbrains.com/help/idea/using-live-templates.html) to offer autocompletion 
-on validators (including the ones with parameters).
-
-It will generate two sets of live templates in your IDEA configuration:
-![](./screenshots/live_templates.png)
+## Replacement suggestions
 
-#### Macros
-JCV plugin will generate two macros that are used in the JCV live templates (macros are functions that can be used in 
-[live template variables](https://www.jetbrains.com/help/idea/template-variables.html)). They are common to all the live templates,
-so you can use these new ones for other purposes too.
+It will suggest smart replacements of json value to matching validators:
 
-These macros are:
-* `dateFormats()`: it returns a list of date-time formats, with `iso_instant` as its default value
-* `languages()`: it returns a list of available languages (based on `java.util.Locale`), with `fr` as its default value
+![](./screenshots/jcv-suggestion-date_time_format.png)

build.gradle.kts

@@ -1,14 +1,14 @@
-import com.ekino.oss.jcv.idea_plugin.autocomplete.template_generator.TemplateGeneratorTask
 import org.jetbrains.intellij.tasks.PublishTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-  kotlin("jvm") version "1.3.72"
-  id("org.jetbrains.intellij") version "0.4.21"
+  kotlin("jvm") version "1.4.20"
+  id("org.jetbrains.intellij") version "0.6.4"
 }
 
 intellij {
-  version = "IC-2020.1" //IntelliJ IDEA 2020.1 dependency; for a full list of IntelliJ IDEA releases please see https://www.jetbrains.com/intellij-repository/releases
+  version =
+    "IC-2020.1" //IntelliJ IDEA 2020.1 dependency; for a full list of IntelliJ IDEA releases please see https://www.jetbrains.com/intellij-repository/releases
   pluginName = "JCV"
   updateSinceUntilBuild = false //Disables updating since-build attribute in plugin.xml
 }
@@ -18,17 +18,31 @@ repositories {
 }
 
 dependencies {
+  implementation("org.apache.commons:commons-text:1.9")
+
   testImplementation("com.willowtreeapps.assertk:assertk-jvm:${property("assertk-jvm.version")}")
   testImplementation("org.junit.jupiter:junit-jupiter:${property("junit.version")}")
+  testImplementation("junit:junit:4.13")
+  testRuntimeOnly("org.junit.vintage:junit-vintage-engine:${property("junit.version")}")
 }
 
 tasks {
   withType<KotlinCompile> {
     kotlinOptions.jvmTarget = JavaVersion.VERSION_11.toString()
+    kotlinOptions.apiVersion = "1.3"
   }
 
   withType<Test> {
-    useJUnitPlatform()
+    useJUnitPlatform {
+      includeEngines = setOf("junit-jupiter", "junit-vintage")
+    }
+    jvmArgs(
+      "-Djunit.jupiter.testinstance.lifecycle.default=per_class",
+      "-Duser.language=en"
+    )
+    testLogging {
+      events("passed", "skipped", "failed")
+    }
   }
 
   withType<PublishTask> {
@@ -61,15 +75,6 @@ tasks {
       println(version)
     }
   }
-
-  create(name = "generateTemplates", type = TemplateGeneratorTask::class) {
-    resourceFiles = setOf("jcv", "jcv-db")
-      .associateWith { file("$buildDir/resources/main/$it.xml") }
-  }
-
-  named("jar").configure {
-    dependsOn("generateTemplates")
-  }
 }
 
 fun prop(name: String): String? =