@wildwinter/toolkit 0.2.6 → 0.2.7

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @wildwinter/toolkit
 
+## 0.2.7
+
+### Added
+
+- **Value help on a pick** (`./extensions`): a pick's `valueHelp` describes its fixed `words`, a sentence each; the
+  manifest check holds each key to one of them, since the project's lists and nodes are the project's to describe.
+
 ## 0.2.6
 
 ### Added

package/conformance/extensions/manifest.json

@@ -571,6 +571,81 @@
         }
       ]
     },
+    {
+      "name": "a pick's value help describes its fixed words, never its lists or nodes",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "project": {
+              "fields": [
+                {
+                  "name": "types",
+                  "type": "list",
+                  "of": {
+                    "type": "text"
+                  }
+                }
+              ]
+            },
+            "scene": {
+              "fields": [
+                {
+                  "name": "type",
+                  "type": "pick",
+                  "from": [
+                    {
+                      "words": [
+                        "ambient",
+                        "cinematic"
+                      ]
+                    },
+                    {
+                      "list": "types"
+                    },
+                    {
+                      "words": [
+                        "bark"
+                      ]
+                    }
+                  ],
+                  "valueHelp": {
+                    "ambient": "Voices from sources.",
+                    "bark": "A one-off line.",
+                    "duel": "One of the project's types: not the manifest's to describe."
+                  }
+                },
+                {
+                  "name": "to",
+                  "type": "pick",
+                  "from": [
+                    {
+                      "to": "cast"
+                    }
+                  ],
+                  "valueHelp": {
+                    "WREN": "A cast member."
+                  }
+                }
+              ]
+            }
+          }
+        }
+      },
+      "problems": [
+        {
+          "path": "targets.patter.scene.fields[0].valueHelp.duel",
+          "code": "value-help"
+        },
+        {
+          "path": "targets.patter.scene.fields[1].valueHelp.WREN",
+          "code": "value-help"
+        }
+      ]
+    },
     {
       "name": "a reference names a kind its host can point at",
       "manifest": {

package/dist/extensions.cjs

@@ -424,6 +424,10 @@ function manifestProblems(manifest) {
   }
   return out;
 }
+function pickWords(from) {
+  if (!Array.isArray(from)) return [];
+  return from.flatMap((s) => isObject(s) && Array.isArray(s["words"]) ? s["words"].filter((w) => typeof w === "string") : []);
+}
 function pickSourcesSound(host, from, path, out) {
   if (!Array.isArray(from) || from.length === 0) {
     out.push(err2("pick-from", path, 'a pick lists its sources in "from": { "words": [...] }, { "to": a node kind }, or { "list": a project list }'));
@@ -771,12 +775,14 @@ function typeProblems(host, decl, path, named, out, claim = false) {
       out.push(err2("value-help", at("valueHelp"), "value help describes the values of an enum or flags field, or a quality's stages"));
     }
   } else if (decl.valueHelp !== void 0) {
-    const vocabulary = decl.type === "quality" ? decl.stages : decl.type === "enum" || decl.type === "flags" ? decl.values : void 0;
+    const vocabulary = decl.type === "quality" ? decl.stages : decl.type === "enum" || decl.type === "flags" ? decl.values : decl.type === "pick" ? pickWords(decl.from) : void 0;
     if (vocabulary === void 0 || !isObject(decl.valueHelp)) {
-      out.push(err2("value-help", at("valueHelp"), "value help describes the values of an enum or flags field, or a quality's stages"));
+      out.push(err2("value-help", at("valueHelp"), "value help describes the values of an enum or flags field, a quality's stages, or a pick's words"));
     } else {
       for (const k of Object.keys(decl.valueHelp)) {
-        if (!vocabulary.includes(k)) out.push(err2("value-help", atKey(at("valueHelp"), k), `"${k}" is not one of its values`));
+        if (!vocabulary.includes(k)) {
+          out.push(err2("value-help", atKey(at("valueHelp"), k), decl.type === "pick" ? `"${k}" is not one of its words: value help describes a pick's fixed words, never the project's lists or nodes` : `"${k}" is not one of its values`));
+        }
       }
     }
   }