allow comments in config.json (#1470)

* ✨ comments in config.json

* ✨ file association for .jsonc

core/config/load.ts

@@ -1,3 +1,4 @@
+import * as JSONC from "comment-json";
 import * as fs from "fs";
 import path from "path";
 import {
@@ -57,7 +58,7 @@ const { execSync } = require("child_process");
 
 function resolveSerializedConfig(filepath: string): SerializedContinueConfig {
   let content = fs.readFileSync(filepath, "utf8");
-  const config = JSON.parse(content) as SerializedContinueConfig;
+  const config = JSONC.parse(content) as unknown as SerializedContinueConfig;
   if (config.env && Array.isArray(config.env)) {
     const env = {
       ...process.env,
@@ -74,7 +75,7 @@ function resolveSerializedConfig(filepath: string): SerializedContinueConfig {
     });
   }
 
-  return JSON.parse(content);
+  return JSONC.parse(content) as unknown as SerializedContinueConfig;
 }
 
 const configMergeKeys = {

core/config/util.ts

@@ -1,6 +1,5 @@
-import { readFileSync, writeFileSync } from "fs";
 import { ModelDescription } from "../index.js";
-import { editConfigJson, getConfigJsonPath } from "../util/paths.js";
+import { editConfigJson } from "../util/paths.js";
 
 function stringify(obj: any, indentation?: number): string {
   return JSON.stringify(
@@ -13,21 +12,17 @@ function stringify(obj: any, indentation?: number): string {
 }
 
 export function addModel(model: ModelDescription) {
-  const config = readFileSync(getConfigJsonPath(), "utf8");
-  const configJson = JSON.parse(config);
+  editConfigJson((config) => {
+    if (config.models?.some((m: any) => stringify(m) === stringify(model))) {
+      return config;
+    }
+    if (config.models?.some((m: any) => m?.title === model.title)) {
+      model.title = `${model.title} (1)`;
+    }
 
-  // De-duplicate
-  if (configJson.models?.some((m: any) => stringify(m) === stringify(model))) {
+    config.models.push(model);
     return config;
-  }
-  if (configJson.models?.some((m: any) => m?.title === model.title)) {
-    model.title = `${model.title} (1)`;
-  }
-
-  configJson.models.push(model);
-  const newConfigString = stringify(configJson, 2);
-  writeFileSync(getConfigJsonPath(), newConfigString);
-  return newConfigString;
+  });
 }
 
 export function addOpenAIKey(key: string) {

core/core.ts

@@ -27,7 +27,7 @@ import { DevDataSqliteDb } from "./util/devdataSqlite.js";
 import { fetchwithRequestOptions } from "./util/fetchWithOptions.js";
 import historyManager from "./util/history.js";
 import type { IMessenger, Message } from "./util/messenger";
-import { editConfigJson, getConfigJsonPath } from "./util/paths.js";
+import { editConfigJson } from "./util/paths.js";
 import { Telemetry } from "./util/posthog.js";
 import { streamDiffLines } from "./util/verticalEdit.js";
 
@@ -179,37 +179,8 @@ export class Core {
     // Edit config
     on("config/addModel", (msg) => {
       const model = msg.data.model;
-      const newConfigString = addModel(model);
+      addModel(model);
       this.configHandler.reloadConfig();
-      this.ide.openFile(getConfigJsonPath());
-
-      // Find the range where it was added and highlight
-      const lines = newConfigString.split("\n");
-      let startLine: number | undefined;
-      let endLine: number | undefined;
-      for (let i = 0; i < lines.length; i++) {
-        const line = lines[i];
-
-        if (!startLine) {
-          if (line.trim() === `"title": "${model.title}",`) {
-            startLine = i - 1;
-          }
-        } else {
-          if (line.startsWith("    }")) {
-            endLine = i;
-            break;
-          }
-        }
-      }
-
-      if (startLine && endLine) {
-        this.ide.showLines(
-          getConfigJsonPath(),
-          startLine,
-          endLine,
-          // "#fff1"
-        );
-      }
     });
     on("config/addOpenAiKey", (msg) => {
       addOpenAIKey(msg.data);

core/package.json

@@ -42,6 +42,7 @@
     "axios": "^1.6.7",
     "cheerio": "^1.0.0-rc.12",
     "commander": "^12.0.0",
+    "comment-json": "^4.2.3",
     "dbinfoz": "^0.1.4",
     "dotenv": "^16.3.1",
     "fastest-levenshtein": "^1.0.16",

core/util/paths.ts

@@ -1,3 +1,4 @@
+import * as JSONC from "comment-json";
 import dotenv from "dotenv";
 import * as fs from "fs";
 import * as os from "os";
@@ -152,12 +153,16 @@ export function getDevDataFilePath(fileName: string): string {
 
 export function editConfigJson(
   callback: (config: SerializedContinueConfig) => SerializedContinueConfig,
-) {
+): void {
   const config = fs.readFileSync(getConfigJsonPath(), "utf8");
-  let configJson = JSON.parse(config);
-  configJson = callback(configJson);
-  fs.writeFileSync(getConfigJsonPath(), JSON.stringify(configJson, null, 2));
-  return configJson;
+  let configJson = JSONC.parse(config);
+  // Check if it's an object
+  if (typeof configJson === "object" && configJson !== null) {
+    configJson = callback(configJson as any) as any;
+    fs.writeFileSync(getConfigJsonPath(), JSONC.stringify(configJson, null, 2));
+  } else {
+    console.warn("config.json is not a valid object");
+  }
 }
 
 function getMigrationsFolderPath(): string {

extensions/vscode/package.json

@@ -53,6 +53,15 @@
   "main": "./out/extension.js",
   "browser": "./out/extension.js",
   "contributes": {
+    "languages": [
+      {
+        "filenames": [
+          "config.json",
+          ".continuerc.json"
+        ],
+        "id": "jsonc"
+      }
+    ],
     "configuration": {
       "title": "Continue",
       "properties": {