feat: add jsonc support

Author: kevinwang5658

codify.json5

@@ -347,15 +347,15 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     const folderPath = path.join(cwd, 'codify-imports')
     await FileUtils.createFolder(folderPath)
 
-    let fileName = path.join(folderPath, 'import.codify.json')
+    let fileName = path.join(folderPath, 'import.codify.jsonc')
     let counter = 1;
 
     while(true) {
       if (!(await FileUtils.fileExists(fileName))) {
         return fileName;
       }
 
-      fileName = path.join(folderPath, `import-${counter}.codify.json`);
+      fileName = path.join(folderPath, `import-${counter}.codify.jsonc`);
       counter++;
     }
   }

src/orchestrators/import.ts

@@ -19,5 +19,6 @@ export interface LanguageSpecificParser {
 export enum FileType {
   JSON = 'json',
   YAML = 'yaml',
-  JSON5 = 'json5'
+  JSON5 = 'json5',
+  JSONC = 'jsonc',
 }

src/parser/entities.ts

@@ -8,17 +8,19 @@ import { ConfigFactory } from './config-factory.js';
 import { FileType, InMemoryFile, ParsedConfig } from './entities.js';
 import { JsonParser } from './json/json-parser.js';
 import { Json5Parser } from './json5/json-parser.js';
+import { JsoncParser } from './jsonc/json-parser.js';
 import { FileReader } from './reader.js';
 import { SourceMapCache } from './source-maps.js';
 import { YamlParser } from './yaml/yaml-parser.js';
 
-export const CODIFY_FILE_REGEX = /^(.*)?codify(.json|.yaml|.json5)$/;
+export const CODIFY_FILE_REGEX = /^(.*)?codify(.json|.yaml|.json5|.jsonc)$/;
 
 class Parser {
   private readonly languageSpecificParsers= {
     [FileType.JSON]: new JsonParser(),
     [FileType.YAML]: new YamlParser(),
-    [FileType.JSON5]: new Json5Parser()
+    [FileType.JSON5]: new Json5Parser(),
+    [FileType.JSONC]: new JsoncParser()
   }
 
   async parse(dirOrFile: string): Promise<Project> {

src/parser/index.ts

@@ -0,0 +1,41 @@
+import JsonSourceMap from '@mischnic/json-sourcemap';
+import { Config, ConfigFileSchema } from 'codify-schemas';
+import jju from 'jju'
+
+import { AjvValidationError, SyntaxError } from '../../common/errors.js';
+import { ajv } from '../../utils/ajv.js';
+import { InMemoryFile, LanguageSpecificParser, ParsedConfig } from '../entities.js';
+import { SourceMapCache } from '../source-maps.js';
+
+const validator = ajv.compile(ConfigFileSchema);
+
+export class JsoncParser implements LanguageSpecificParser {
+  parse(file: InMemoryFile, sourceMaps?: SourceMapCache): ParsedConfig[] {
+    let content;
+    try {
+      content = jju.parse(file.contents);
+
+      if (sourceMaps) {
+        sourceMaps.addSourceMap(file, JsonSourceMap.parse(file.contents, undefined, { dialect: 'JSON5' }));
+      }
+    } catch (error) {
+      throw new SyntaxError({
+        fileName: file.filePath,
+        message: (error as Error).message,
+      });
+    }
+
+    if (!this.validate(content)) {
+      throw new AjvValidationError('invalid config file', validator.errors!, file.filePath, sourceMaps);
+    }
+
+    return content.map((contents, idx) => ({
+        contents,
+        sourceMapKey: SourceMapCache.constructKey(file.filePath, `/${idx}`)
+      }))
+  }
+
+  private validate(content: unknown): content is Config[] {
+    return validator(content);
+  }
+}

src/parser/jsonc/json-parser.ts

@@ -26,6 +26,10 @@ export class FileReader {
     if (filePath.endsWith('.json5')) {
       return FileType.JSON5
     }
+
+    if (filePath.endsWith('.jsonc')) {
+      return FileType.JSONC
+    }
 
     throw new InternalError(`Unsupported file type passed to FileReader. File path: ${filePath}`);
   }

src/parser/reader.ts

@@ -44,17 +44,12 @@ export class SourceMapCache {
   }
 
   addSourceMap(file: InMemoryFile, sourceMap: JsonSourceMap | YamlSourceMap) {
-    if (file.fileType === FileType.JSON) {
-      this.sourceMaps.set(file.filePath, {
-        file,
-        sourceMap: new JsonSourceMapAdapter(sourceMap as JsonSourceMap),
-      })
-    } else if (file.fileType === FileType.YAML) {
+    if (file.fileType === FileType.YAML) {
       this.sourceMaps.set(file.filePath, {
         file,
         sourceMap: new YamlSourceMapAdapter(sourceMap as YamlSourceMap, file),
       })
-    } else if (file.fileType === FileType.JSON5) {
+    } else {
       this.sourceMaps.set(file.filePath, {
         file,
         sourceMap: new JsonSourceMapAdapter(sourceMap as JsonSourceMap),

src/parser/source-maps.ts

@@ -90,7 +90,7 @@ export class FileModificationCalculator {
       .map((r) => r.resource)
     const insertionIndex = newFile.length - 2; // Last element is guarenteed to be the closing bracket. We insert 1 before that
 
-    newFile = this.insert(newFile, newResourcesToInsert, insertionIndex);
+    newFile = this.insert(newFile, this.existingFile.fileType, newResourcesToInsert, insertionIndex);
 
     const lastCharacterIndex = this.existingFile.contents.lastIndexOf(']')
     if (lastCharacterIndex < this.existingFile.contents.length - 1) {
@@ -110,8 +110,8 @@ export class FileModificationCalculator {
       return;
     }
 
-    if (this.existingFile?.fileType !== FileType.JSON && this.existingFile?.fileType !== FileType.JSON5) {
-      throw new Error(`Only updating .json and .json5 files are currently supported. Found ${this.existingFile?.filePath}`);
+    if (this.existingFile?.fileType !== FileType.JSON && this.existingFile?.fileType !== FileType.JSON5 && this.existingFile?.fileType !== FileType.JSONC) {
+      throw new Error(`Only updating .json, .json5, and .jsonc files are currently supported. Found ${this.existingFile?.filePath}`);
     }
 
     if (this.existingConfigs.some((r) => !r.resourceInfo)) {
@@ -138,6 +138,7 @@ export class FileModificationCalculator {
   // Insert always works at the end
   private insert(
     file: string,
+    fileType: FileType,
     resources: ResourceConfig[],
     position: number,
   ): string {
@@ -147,7 +148,13 @@ export class FileModificationCalculator {
 
     for (const newResource of resources.reverse()) {
       const sortedResource = { ...newResource.core(true), ...this.sortKeys(newResource.parameters) }
-      let content = jju.stringify(sortedResource, fileStyle as any);
+      let content = jju.stringify(sortedResource, {
+        indent: fileStyle.indent,
+        no_trailing_comma: true,
+        quote: '"',
+        quote_keys: fileStyle.quote_keys,
+        mode: this.fileTypeString(fileType),
+      });
 
       content = content.split(/\n/).map((l) => `${this.indentString}${l}`).join('\n')
       content = `,\n${content}`;
@@ -254,4 +261,20 @@ export class FileModificationCalculator {
         })
     )
   }
+
+  private fileTypeString(fileType: FileType): 'json' | 'json5' | 'cjson' {
+    if (fileType === FileType.JSON) {
+      return 'json'
+    }
+
+    if (fileType === FileType.JSON5) {
+      return 'json5'
+    }
+
+    if (fileType === FileType.JSONC) {
+      return 'cjson'
+    }
+
+    throw new Error(`Unsupported file type ${fileType} when trying to generate new configs`);
+  }
 }