json5 insert text, prefer defaults (#48)

this allows us to:

- automatically complete the json5 string based on the type of quotes or
lack thereof that the user is using
- prefers the schema.default over other guesses
- fixes an apparent bug where guessed solutions are overwritten

I tested this with `packageJson.types`, which is the only value in the
schema that has a default

Author: acao

.changeset/fast-steaks-thank.md

@@ -0,0 +1,9 @@
+---
+"codemirror-json-schema": patch
+---
+
+fix nested json4 completion bug (#55)
+
+- fix #54, expand properties inside nested objects as expected in json4
+- always advance cursor after property completions
+- add more test coverage

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
-  "files.insertFinalNewline": true
+  "files.insertFinalNewline": true,
+  "coverage-gutters.coverageBaseDir": "**",
+  "coverage-gutters.coverageFileNames": ["clover.xml"]
 }

README.md

@@ -153,10 +153,10 @@ This approach allows you to configure the json5 mode and parse linter, as well a
 import { EditorState } from "@codemirror/state";
 import { linter } from "@codemirror/lint";
 import { json5, json5ParseLinter, json5Language } from "codemirror-json5";
-import { jsonCompletion } from "codemirror-json-schema";
 import {
   json5SchemaLinter,
   json5SchemaHover,
+  json5Completion,
 } from "codemirror-json-schema/json5";
 
 const schema = {
@@ -182,7 +182,7 @@ const json5State = EditorState.create({
     linter(json5SchemaLinter(schema)),
     hoverTooltip(json5SchemaHover(schema)),
     json5Language.data.of({
-      autocomplete: jsonCompletion(schema),
+      autocomplete: json5Completion(schema),
     }),
   ],
 });

package.json

@@ -86,7 +86,7 @@
     "dev": "vite ./dev --port 3000",
     "build": "pnpm tsc && vite build ./dev --outDir ../public --emptyOutDir",
     "test": "vitest --dom",
-    "test:coverage": "vitest run --dom --coverage",
+    "test:coverage": "vitest run --dom --coverage ",
     "tsc": "tsc && pnpm replace:env",
     "version-packages": "changeset version && pnpm typedoc && pnpm prettier:write CHANGELOG.md && git add package.json pnpm-lock.yaml CHANGELOG.md",
     "release": "pnpm build && changeset publish",

src/__tests__/__fixtures__/schemas.ts

@@ -41,6 +41,21 @@ export const testSchema2 = {
         { $ref: "#/definitions/fancyObject2" },
       ],
     },
+    arrayOfObjects: {
+      type: "array",
+      items: {
+        $ref: "#/definitions/fancyObject",
+      },
+    },
+    arrayOfOneOf: {
+      type: "array",
+      items: {
+        oneOf: [
+          { $ref: "#/definitions/fancyObject" },
+          { $ref: "#/definitions/fancyObject2" },
+        ],
+      },
+    },
     enum1: {
       description: "an example enum with default bar",
       enum: ["foo", "bar"],

src/__tests__/__helpers__/completion.ts

@@ -1,6 +1,8 @@
 import { describe, it, expect, vitest, Mock } from "vitest";
 
 import { json, jsonLanguage } from "@codemirror/lang-json";
+import { json5, json5Language } from "codemirror-json5";
+
 import { EditorState } from "@codemirror/state";
 import {
   Completion,
@@ -38,19 +40,26 @@ type MockedCompletionResult = CompletionResult["options"][0] & {
 export async function expectCompletion(
   doc: string,
   results: MockedCompletionResult[],
-  schema?: JSONSchema7,
-  conf: { explicit?: boolean } = {}
+
+  conf: {
+    explicit?: boolean;
+    schema?: JSONSchema7;
+    mode?: "json" | "json5";
+  } = {}
 ) {
   let cur = doc.indexOf("|"),
-    currentSchema = schema || testSchema2;
+    currentSchema = conf?.schema || testSchema2;
   doc = doc.slice(0, cur) + doc.slice(cur + 1);
+  const jsonMode = conf?.mode === "json5" ? json5 : json;
+  const jsonLang = conf?.mode === "json5" ? json5Language : jsonLanguage;
+
   let state = EditorState.create({
     doc,
     selection: { anchor: cur },
     extensions: [
-      json(),
-      jsonLanguage.data.of({
-        autocomplete: jsonCompletion(currentSchema),
+      jsonMode(),
+      jsonLang.data.of({
+        autocomplete: jsonCompletion(currentSchema, { mode: conf.mode }),
       }),
     ],
   });