@patterkit/core 0.1.5 → 0.2.0

package/dist/index.cjs

@@ -31,11 +31,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   canonicalStringify: () => canonicalStringify,
-  effectiveGameId: () => import_model3.effectiveGameId,
-  gameIdify: () => import_model3.gameIdify,
+  effectiveGameId: () => import_model4.effectiveGameId,
+  gameIdify: () => import_model4.gameIdify,
   hash32: () => hash32,
   hash4: () => hash4,
-  isValidGameId: () => import_model3.isValidGameId,
+  isValidGameId: () => import_model4.isValidGameId,
   newId: () => newId,
   parseSource: () => parseSource,
   slug: () => slug,
@@ -81,7 +81,7 @@ function hash32(input) {
 }
 
 // src/index.ts
-var import_model3 = require("@patterkit/model");
+var import_model4 = require("@patterkit/model");
 
 // src/serialize.ts
 var import_json5 = __toESM(require("json5"), 1);
@@ -120,6 +120,7 @@ ${indent}}`;
 // src/validate.ts
 var import_model = require("@patterkit/model");
 var import_model2 = require("@patterkit/model");
+var import_model3 = require("@patterkit/model");
 function choiceLoopsBack(choice, ...targets) {
   const back = new Set(targets.filter((s) => typeof s === "string" && s.length > 0));
   const hits = (n) => n.type === "snippet" ? !!n.jump && back.has(n.jump.to) : (n.children ?? []).some(hits);
@@ -307,6 +308,18 @@ function validateProject(input) {
 }
 function validateProjectFile(project, issues) {
   checkDecls(project.properties, "project properties", issues);
+  for (const scope of project.scopeRegistry?.scopes ?? []) {
+    const where = `host scope '@${scope.token}'`;
+    for (const decl of scope.declarations ?? []) {
+      const name = decl.name?.toLowerCase();
+      if (!name) {
+        issues.push({ code: "invalid-declaration", message: `${where}: a property declaration has no name` });
+        continue;
+      }
+      const problem = propertyNameProblem(decl.name);
+      if (problem) issues.push({ code: "invalid-declaration", message: `${where}: ${problem}` });
+    }
+  }
   for (const decl of project.properties ?? []) {
     if (decl.temporary) {
       issues.push({
@@ -410,6 +423,23 @@ function checkLadderNames(names, where, issues) {
     seen.add(name);
   }
 }
+function propertyNameProblem(raw) {
+  if ((0, import_model3.isValidPropertyName)(raw)) return void 0;
+  const suggestion = (0, import_model3.propertyNameify)(raw);
+  const tail = suggestion ? ` Try '${suggestion}'.` : "";
+  const q = `property name '${raw}'`;
+  if (import_model3.RESERVED_PROPERTY_NAMES.includes(raw.toLowerCase())) {
+    return `${q} is a keyword in expressions ('${raw.toLowerCase()}'), so a reference to it will not parse.${tail}`;
+  }
+  if (raw.includes("-")) {
+    return `${q} contains a hyphen, which an expression reads as subtraction: a reference would compile to a subtraction, not to this property.${tail}`;
+  }
+  if (/^[0-9]/.test(raw)) return `${q} starts with a digit, which an expression cannot parse as a name.${tail}`;
+  if (raw !== raw.toLowerCase() && (0, import_model3.isValidPropertyName)(raw.toLowerCase())) {
+    return `${q} must be lower case: expressions fold names, so a reference looks for '${raw.toLowerCase()}' and finds nothing.${tail}`;
+  }
+  return `${q} can only hold lower case letters, digits and underscores.${tail}`;
+}
 function checkDecls(decls, where, issues) {
   const seen = /* @__PURE__ */ new Set();
   for (const decl of decls ?? []) {
@@ -422,6 +452,8 @@ function checkDecls(decls, where, issues) {
       issues.push({ code: "invalid-declaration", message: `${where}: duplicate property '${decl.name}'` });
     }
     seen.add(name);
+    const problem = propertyNameProblem(decl.name);
+    if (problem) issues.push({ code: "invalid-declaration", message: `${where}: ${problem}` });
     if ((decl.type === "enum" || decl.type === "flags") && !decl.values?.length) {
       issues.push({
         code: "invalid-declaration",

package/dist/index.js

@@ -75,6 +75,7 @@ ${indent}}`;
 // src/validate.ts
 import { walkNodes, DEFAULT_WRITING_STATUSES, DEFAULT_RECORDING_STATUSES, DEFAULT_DOCUMENTATION_CLASSES } from "@patterkit/model";
 import { isValidGameId, effectiveGameId } from "@patterkit/model";
+import { isValidPropertyName, propertyNameify, RESERVED_PROPERTY_NAMES } from "@patterkit/model";
 function choiceLoopsBack(choice, ...targets) {
   const back = new Set(targets.filter((s) => typeof s === "string" && s.length > 0));
   const hits = (n) => n.type === "snippet" ? !!n.jump && back.has(n.jump.to) : (n.children ?? []).some(hits);
@@ -262,6 +263,18 @@ function validateProject(input) {
 }
 function validateProjectFile(project, issues) {
   checkDecls(project.properties, "project properties", issues);
+  for (const scope of project.scopeRegistry?.scopes ?? []) {
+    const where = `host scope '@${scope.token}'`;
+    for (const decl of scope.declarations ?? []) {
+      const name = decl.name?.toLowerCase();
+      if (!name) {
+        issues.push({ code: "invalid-declaration", message: `${where}: a property declaration has no name` });
+        continue;
+      }
+      const problem = propertyNameProblem(decl.name);
+      if (problem) issues.push({ code: "invalid-declaration", message: `${where}: ${problem}` });
+    }
+  }
   for (const decl of project.properties ?? []) {
     if (decl.temporary) {
       issues.push({
@@ -365,6 +378,23 @@ function checkLadderNames(names, where, issues) {
     seen.add(name);
   }
 }
+function propertyNameProblem(raw) {
+  if (isValidPropertyName(raw)) return void 0;
+  const suggestion = propertyNameify(raw);
+  const tail = suggestion ? ` Try '${suggestion}'.` : "";
+  const q = `property name '${raw}'`;
+  if (RESERVED_PROPERTY_NAMES.includes(raw.toLowerCase())) {
+    return `${q} is a keyword in expressions ('${raw.toLowerCase()}'), so a reference to it will not parse.${tail}`;
+  }
+  if (raw.includes("-")) {
+    return `${q} contains a hyphen, which an expression reads as subtraction: a reference would compile to a subtraction, not to this property.${tail}`;
+  }
+  if (/^[0-9]/.test(raw)) return `${q} starts with a digit, which an expression cannot parse as a name.${tail}`;
+  if (raw !== raw.toLowerCase() && isValidPropertyName(raw.toLowerCase())) {
+    return `${q} must be lower case: expressions fold names, so a reference looks for '${raw.toLowerCase()}' and finds nothing.${tail}`;
+  }
+  return `${q} can only hold lower case letters, digits and underscores.${tail}`;
+}
 function checkDecls(decls, where, issues) {
   const seen = /* @__PURE__ */ new Set();
   for (const decl of decls ?? []) {
@@ -377,6 +407,8 @@ function checkDecls(decls, where, issues) {
       issues.push({ code: "invalid-declaration", message: `${where}: duplicate property '${decl.name}'` });
     }
     seen.add(name);
+    const problem = propertyNameProblem(decl.name);
+    if (problem) issues.push({ code: "invalid-declaration", message: `${where}: ${problem}` });
     if ((decl.type === "enum" || decl.type === "flags") && !decl.values?.length) {
       issues.push({
         code: "invalid-declaration",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/core",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Patter core: stable id generation, readable-handle computation, canonical (de)serialisation, and the structural validator.",
   "type": "module",
   "license": "MIT",
@@ -34,7 +34,7 @@
     "build": "tsup src/index.ts --format esm,cjs --dts --clean"
   },
   "dependencies": {
-    "@patterkit/model": "0.2.1",
+    "@patterkit/model": "0.3.0",
     "json5": "^2.2.3"
   }
 }