lint(track_config): check key_features

src/lint/track_config.nim

@@ -89,6 +89,29 @@ proc hasValidOnlineEditor(data: JsonNode, path: string): bool =
     else:
       result = false
 
+proc isValidKeyFeature(data: JsonNode, context: string, path: string): bool =
+  const icons = [
+    "todo",
+  ].toHashSet()
+
+  if isObject(data, context, path):
+    result = true
+
+    if checkString(data, "icon", path):
+      let s = data["icon"].getStr()
+      if false and s notin icons: # TODO
+        let msg = "The value of `key_features.icon` is `" & s &
+                  "` which is not one of the valid values"
+        result.setFalseAndPrint(msg, path)
+    else:
+      result = false
+
+    if not checkString(data, "title", path, maxLen = 25):
+      result = false
+
+    if not checkString(data, "content", path, maxLen = 100):
+      result = false
+
 proc isValidTrackConfig(data: JsonNode, path: string): bool =
   if isObject(data, "", path):
     result = true
@@ -116,6 +139,17 @@ proc isValidTrackConfig(data: JsonNode, path: string): bool =
     if not hasValidOnlineEditor(data, path):
       result = false
 
+    if data.hasKey("key_features"):
+      let d = data["key_features"]
+      if isArrayOf(d, "key_features", path, isValidKeyFeature, isRequired = false):
+        let arrayLen = d.len
+        if arrayLen != 0 and arrayLen != 6:
+          let msg = "The `key_features` array has length " & $arrayLen &
+                    " but must have length 6"
+          result.setFalseAndPrint(msg, path)
+      else:
+        result = false
+
     if not hasArrayOf(data, "tags", path, isValidTag):
       result = false
 

src/lint/validators.nim

@@ -20,14 +20,24 @@ proc hasObject*(data: JsonNode; key, path: string; isRequired = true): bool =
   elif isRequired:
     result.setFalseAndPrint("Missing key: " & q(key), path)
 
-proc checkString*(data: JsonNode; key, path: string; isRequired = true): bool =
+proc checkString*(data: JsonNode; key, path: string; isRequired = true,
+                  maxLen = int.high): bool =
   result = true
   if data.hasKey(key):
     case data[key].kind
     of JString:
       let s = data[key].getStr()
-      if s.len > 0:
-        if s.strip().len == 0:
+      let sLen = s.len
+      if sLen > 0:
+        if s.strip().len > 0:
+          if sLen > maxLen:
+            const truncLen = 25
+            let sTrunc = if sLen > truncLen: s[0..truncLen] else: s
+            let msg = "The value of `" & key & "` that starts with `" & sTrunc &
+                      "...` is " & $sLen & " characters, but must not exceed " &
+                      $maxLen & " characters"
+            result.setFalseAndPrint(msg, path)
+        else:
           result.setFalseAndPrint("String is whitespace-only: " & q(key), path)
       else:
         result.setFalseAndPrint("String is zero-length: " & q(key), path)