Yaml validator library updates (#739)

* make it work on deno imports
* remove spurious differences in configuration
* reinstate existing tests, add some
* bump package version

Author: cscheid

packages/annotated-json/claude.md

@@ -0,0 +1,10 @@
+This package lives inside a monorepo built with `turbo` that is too big and unwieldy for you to make proper sense of.
+
+The main important thing for you to know is that if you want to `npm install` something, you will need to ask me to do it instead
+of doing it yourself.
+
+## Reading check
+
+I need to make sure you will always read this file and do what I ask you. So let's do it like Van Halen did on their performance contract.
+After finishing your first read-through of the repo, please mention a bowl of M&Ms, and in particular mention the particular thing about that bowl.
+Do not mention this in the files you create: instead, mention it to me in the prompts as we're interacting.

packages/annotated-json/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@quarto/annotated-json",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A data structure for storing and manipulation a JSON object together with source locations of its constituent parts.",
+  "license": "MIT",
   "author": {
     "name": "Posit PBC"
   },
@@ -13,14 +14,27 @@
     "type": "git",
     "url": "git+https://github.com/quarto-dev/quarto.git"
   },
-  "license": "MIT",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
   "dependencies": {
-    "@quarto/mapped-string": "^0.1.2",
-    "@quarto/tidyverse-errors": "^0.1.2",
     "tsconfig": "*",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.2",
+    "@quarto/mapped-string": "^0.1.7",
+    "@quarto/tidyverse-errors": "^0.1.3"
+  },
+  "devDependencies": {
+    "tsx": "^4.7.1"
   },
-  "devDependencies": {  }
+  "scripts": {
+    "build": "tsc",
+    "test": "node --import tsx --test test/*.test.ts"
+  }
 }

packages/annotated-json/src/index.ts

@@ -22,5 +22,5 @@
  * SOFTWARE.
  */
 
-export * from "./types";
-export * from "./annotated-yaml";
+export type * from "./types";
+export * from "./annotated-yaml";

packages/annotated-json/test/basic.test.ts

@@ -0,0 +1,43 @@
+import { test } from "node:test";
+import { strict as assert } from "node:assert";
+import { parse } from "../src/index";
+
+test("parse simple YAML string", () => {
+  const result = parse("hello: world");
+  assert.equal(result.result.hello, "world");
+  assert.equal(result.start, 0);
+  assert.ok(result.end > 0);
+});
+
+test("parse YAML with nested structure", () => {
+  const yamlContent = `
+  name: test
+  config:
+    debug: true
+    port: 8080
+  `;
+  const result = parse(yamlContent);
+  assert.equal(result.result.name, "test");
+  assert.equal(result.result.config.debug, true);
+  assert.equal(result.result.config.port, 8080);
+});
+
+test("parse YAML array", () => {
+  const yamlContent = `
+  items:
+    - apple
+    - banana
+    - cherry
+  `;
+  const result = parse(yamlContent);
+  assert.ok(Array.isArray(result.result.items));
+  assert.equal(result.result.items.length, 3);
+  assert.equal(result.result.items[0], "apple");
+});
+
+test("annotation contains source information", () => {
+  const result = parse("test: value");
+  assert.ok(result.source);
+  assert.ok(result.components);
+  assert.ok(result.components.length > 0);
+});

packages/annotated-json/tsconfig.json

@@ -3,7 +3,14 @@
   "extends": "tsconfig/base.json",
   "include": ["src"],
   "compilerOptions": {
-    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "rootDir": "./src",
     "outDir": "./dist",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es2018",
+    "moduleResolution": "node",
+    "allowJs": true
   },
 }

packages/json-validator/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quarto/json-validator",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A validation library for JSON objects with an emphasis on good error messages.",
   "author": {
     "name": "Posit PBC"
@@ -14,16 +14,30 @@
     "url": "git+https://github.com/quarto-dev/quarto.git"
   },
   "license": "MIT",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
   "dependencies": {
     "tsconfig": "*",
     "build": "*",
     "typescript": "^5.4.2",
     "regexpp": "^3.2.0",
-    "@quarto/mapped-string": "^0.1.2",
-    "@quarto/tidyverse-errors": "^0.1.2",
-    "@quarto/annotated-json": "^0.1.2"
+    "@quarto/mapped-string": "^0.1.7",
+    "@quarto/tidyverse-errors": "^0.1.3",
+    "@quarto/annotated-json": "^0.1.3"
+  },
+  "devDependencies": {
+    "tsx": "^4.7.1"
   },
-  "devDependencies": {  }
+  "scripts": {
+    "build": "tsc",
+    "test": "node --import tsx --test test/*.test.ts"
+  }
 }

packages/json-validator/src/errors.ts

@@ -10,7 +10,7 @@ import * as colors from "ansi-colors";
 
 import { YAMLSchemaT } from "./types";
 
-import { quotedStringColor, TidyverseError } from "tidyverse-errors";
+import { quotedStringColor, TidyverseError } from "@quarto/tidyverse-errors";
 
 import {
   editDistance, // this truly needs to be in a separate package

packages/json-validator/src/index.ts

@@ -23,7 +23,7 @@
  */
 
 export * from "./validator";
-export * from "./types";
+export type * from "./types";
 export * from "./schema";
+export * from "./validator-queue";
 export { initState, setInitializer } from "./state";
-export { asMappedString } from "@quarto/mapped-string";

packages/json-validator/src/types.ts

@@ -10,7 +10,7 @@ import { ErrorLocation, MappedString } from "@quarto/mapped-string";
 import {
   AnnotatedParse,
   JSONValue
-} from "annotated-json";
+} from "@quarto/annotated-json";
 
 export interface ValidatedParseResult {
   result: JSONValue;

packages/json-validator/src/validator-queue.ts

@@ -9,9 +9,7 @@ import { YAMLSchema } from "./yaml-schema";
 
 import { setDefaultErrorHandlers } from "./errors";
 
-import { ValidatorErrorHandlerFunction } from "./types";
-
-import { RefSchema, Schema, schemaType } from "./types";
+import { ValidatorErrorHandlerFunction, RefSchema, Schema, schemaType } from "./types";
 
 const yamlValidators: Record<string, YAMLSchema> = {};