lint, sync, fmt: support the files.invalidator field (#577)

This new field allows a track to specify additional files that,
when changed, cause a solution to become outdated.

Upstream:
- exercism/docs@322d63ecdbf6
- exercism/website@695307892fd4

Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>

Author: ErikSchierboom

README.md

@@ -318,6 +318,7 @@ The canonical key order for an exercise `.meta/config.json` file is:
   - exemplar           (Concept Exercises only)
   - example            (Practice Exercises only)
   - [editor]
+  - [invalidator]
 - [language_versions]
 - [forked_from]        (Concept Exercises only)
 - [icon]               (Concept Exercises only)

src/lint/concept_exercises.nim

@@ -11,6 +11,7 @@ proc hasValidFiles(data: JsonNode; path, exerciseDir: Path): bool =
       hasArrayOfFiles(d, "test", path, k, exerciseDir),
       hasArrayOfFiles(d, "exemplar", path, k, exerciseDir),
       hasArrayOfFiles(d, "editor", path, k, exerciseDir, isRequired = false),
+      hasArrayOfFiles(d, "invalidator", path, k, exerciseDir, isRequired = false),
     ]
     result = allTrue(checks)
 

src/lint/practice_exercises.nim

@@ -11,6 +11,7 @@ proc hasValidFiles(data: JsonNode; path, exerciseDir: Path): bool =
       hasArrayOfFiles(d, "test", path, k, exerciseDir),
       hasArrayOfFiles(d, "example", path, k, exerciseDir),
       hasArrayOfFiles(d, "editor", path, k, exerciseDir, isRequired = false),
+      hasArrayOfFiles(d, "invalidator", path, k, exerciseDir, isRequired = false),
     ]
     result = allTrue(checks)
 

src/lint/track_config.nim

@@ -47,6 +47,9 @@ proc hasValidFiles(data: JsonNode; path: Path): bool =
         hasArrayOfStrings(data[f], "editor", path, context = f,
                           uniqueValues = true, isRequired = false,
                           checkIsFilesPattern = true),
+        hasArrayOfStrings(data[f], "invalidator", path, context = f,
+                          uniqueValues = true, isRequired = false,
+                          checkIsFilesPattern = true),
       ]
       result = allTrue(checks)
   else:
@@ -340,6 +343,7 @@ type
     example*: seq[string]
     exemplar*: seq[string]
     editor*: seq[string]
+    invalidator*: seq[string]
 
   TrackConfig* = object
     slug*: string
@@ -713,11 +717,16 @@ proc checkFilePatternsOverlap(filePatterns: FilePatterns; trackSlug: string,
     ("solution", "example"),
     ("solution", "exemplar"),
     ("solution", "editor"),
+    ("solution", "invalidator"),
     ("test", "example"),
     ("test", "exemplar"),
     ("test", "editor"),
+    ("test", "invalidator"),
     ("editor", "example"),
     ("editor", "exemplar"),
+    ("editor", "invalidator"),
+    ("invalidator", "example"),
+    ("invalidator", "exemplar"),
   ]
 
   var seenFilePatterns = initTable[string, HashSet[string]](250)

src/sync/sync_common.nim

@@ -34,6 +34,7 @@ type
     exemplar*: seq[string]
     example*: seq[string]
     editor*: seq[string]
+    invalidator*: seq[string]
 
   TrackConfig* = object
     exercises*: Exercises
@@ -128,6 +129,7 @@ type
   #     solution*: seq[string]
   #     test*: seq[string]
   #     editor*: seq[string]
+  #     invalidator*: seq[string]
   #     case kind*: ExerciseKind
   #     of ekConcept:
   #       exemplar*: seq[string]
@@ -160,20 +162,23 @@ type
     fkExemplar = "exemplar"
     fkExample = "example"
     fkEditor = "editor"
+    fkInvalidator = "invalidator"
 
   ConceptExerciseFiles* = object
     originalKeyOrder: seq[FilesKey]
     solution*: seq[string]
     test*: seq[string]
     exemplar*: seq[string]
     editor*: seq[string]
+    invalidator*: seq[string]
 
   PracticeExerciseFiles* = object
     originalKeyOrder: seq[FilesKey]
     solution*: seq[string]
     test*: seq[string]
     example*: seq[string]
     editor*: seq[string]
+    invalidator*: seq[string]
 
   ConceptExerciseConfig* = object
     originalKeyOrder: seq[ExerciseConfigKey]
@@ -345,6 +350,8 @@ func filesKeyOrder(val: ConceptExerciseFiles | PracticeExerciseFiles;
     result = @[fkSolution, fkTest, fkEx]
     if prettyMode == pmFmt and val.editor.len > 0:
       result.add fkEditor
+    if prettyMode == pmFmt and val.invalidator.len > 0:
+      result.add fkInvalidator
   else:
     result = val.originalKeyOrder
     # If `solution` is missing, write it first.
@@ -366,6 +373,10 @@ func filesKeyOrder(val: ConceptExerciseFiles | PracticeExerciseFiles;
       let insertionIndex = result.find(fkEx) + 1
       result.insert(fkEditor, insertionIndex)
 
+    # If `invalidator` is missing and not empty, write it at the end.
+    if fkInvalidator notin result and val.invalidator.len > 0:
+      result.add fkInvalidator
+
 func addFiles(s: var string; val: ConceptExerciseFiles | PracticeExerciseFiles;
               prettyMode: PrettyMode; indentLevel = 1) =
   ## Appends the pretty-printed JSON for a `files` key with value `val` to `s`.
@@ -389,6 +400,8 @@ func addFiles(s: var string; val: ConceptExerciseFiles | PracticeExerciseFiles;
         s.addArray("example", val.example, indentLevel = inner)
     of fkEditor:
       s.addArray("editor", val.editor, indentLevel = inner)
+    of fkInvalidator:
+      s.addArray("invalidator", val.invalidator, indentLevel = inner)
 
   s.removeComma()
   s.addNewlineAndIndent(indentLevel)

src/sync/sync_filepaths.nim

@@ -44,6 +44,7 @@ func update(f: var (ConceptExerciseFiles | PracticeExerciseFiles),
   update(f.solution, patterns.solution, slug)
   update(f.test, patterns.test, slug)
   update(f.editor, patterns.editor, slug)
+  update(f.invalidator, patterns.invalidator, slug)
   when f is ConceptExerciseFiles:
     update(f.exemplar, patterns.exemplar, slug)
   when f is PracticeExerciseFiles:
@@ -61,7 +62,7 @@ func isSynced(f: ConceptExerciseFiles | PracticeExerciseFiles,
       genCond(exemplar)
     else:
       genCond(example)
-  uniqueCond and genCond(solution) and genCond(test) and genCond(editor)
+  uniqueCond and genCond(solution) and genCond(test) and genCond(editor) and genCond(invalidator)
 
 type
   ExerciseConfig* = object
@@ -161,8 +162,8 @@ proc checkOrUpdateFilepaths*(seenUnsynced: var set[SyncKind];
   ## Prints a message for each track exercise that:
   ## - lacks a `.meta/config.json` file
   ## - or has a `.meta/config.json` file with an missing/empty
-  ##   `files.solution|test|editor|example|exemplar` array, when that value has
-  ##   a pattern defined in the track-level `config.json` file.
+  ##   `files.solution|test|editor|invalidator|example|exemplar` array, when
+  ##   that value has a pattern defined in the track-level `config.json` file.
   ##
   ## Populates those values if `--update` was passed and the user confirms.
   ##

tests/test_fmt.nim

@@ -323,6 +323,8 @@ proc testFmt =
         delete(j["files"], "originalKeyOrder")
         if j["files"]["editor"].len == 0:
           delete(j["files"], "editor")
+        if j["files"]["invalidator"].len == 0:
+          delete(j["files"], "invalidator")
         when e is ConceptExerciseConfig:
           let val = j["forked_from"]
           if val.kind == JNull or (val.kind == JArray and val.len == 0):