feat: switch to jju for automatic file generation

Author: kevinwang5658

codify.json5

@@ -6,14 +6,17 @@
     }
   },
   {
-    "type": "macports"
+    type: "macports"
   },
   // This is a test comment
   {
-    "type": "pnpm",
-    "globalEnvNodeVersion": null
+    type: "pnpm",
+    globalEnvNodeVersion: null,
   },
+  /*
+  This is my multi-line comment
+  */
   {
-    "type": "homebrew"
+    type: "homebrew"
   }
 ]

package-lock.json

@@ -33,7 +33,8 @@
     "semver": "^7.5.4",
     "supports-color": "^9.4.0",
     "json5": "^2.2.3",
-    "@mischnic/json-sourcemap": "^0.1.1"
+    "@mischnic/json-sourcemap": "^0.1.1",
+    "jju": "^1.4.0"
   },
   "description": "Codify allows users to configure settings, install new packages, and automate their systems using code instead of the GUI. Get set up on a new laptop in one click, maintain a Codify file within your project so anyone can get started and never lose your cool apps or favourite settings again.",
   "devDependencies": {
@@ -48,6 +49,7 @@
     "@types/react": "^18.3.1",
     "@types/semver": "^7.5.4",
     "@types/strip-ansi": "^5.2.1",
+    "@types/jju": "^1.4.5",
     "@typescript-eslint/eslint-plugin": "^8.16.0",
     "@types/json5": "^2.2.0",
     "codify-plugin-lib": "^1.0.151",

package.json

@@ -54,7 +54,7 @@ describe('File modification calculator tests', () => {
       resource: modifiedResource,
     }], match)
 
-    console.log(result)
+    console.log(result.newFile)
     console.log(result.diff)
   })
 
@@ -230,9 +230,9 @@ describe('File modification calculator tests', () => {
       '      "default": "latest"\n' +
       '    }\n' +
       '  },\n' +
-      '  {\n' +
+      '  { \n' +
       '    "type": "resource1",\n' +
-      '    "param2": ["a","b","c","d"]\n' +
+      '    "param2": ["a", "b", "c", "d"]\n' +
       '  }\n' +
       ']',)
     console.log(result)
@@ -311,7 +311,7 @@ describe('File modification calculator tests', () => {
       '    "type": "resource1",\n' +
       '    "param2": ["a", "b", "c"]\n' +
       '  },\n' +
-      '  {\n' +
+      '  { \n' +
       '    "type": "resource2",\n' +
       '    "param1": false,\n' +
       '    "param3": "this is another string"\n' +
@@ -367,12 +367,7 @@ describe('File modification calculator tests', () => {
       '  },\n' +
       '  {\n' +
       '    "type": "resource1",\n' +
-      '    "param2": [\n' +
-      '      "a",\n' +
-      '      "b",\n' +
-      '      "c",\n' +
-      '      "d"\n' +
-      '    ]\n' +
+      '    "param2": ["a", "b", "c", "d"],\n' +
       '  }\n' +
       ']')
     console.log(result)
@@ -426,21 +421,11 @@ describe('File modification calculator tests', () => {
       '  },\n' +
       '  {\n' +
       '    "type": "resource1",\n' +
-      '    "param2": [\n' +
-      '      "a",\n' +
-      '      "b",\n' +
-      '      "c",\n' +
-      '      "d"\n' +
-      '    ]\n' +
+      '    "param2": ["a", "b", "c", "d"],\n' +
       '  },\n' +
       '  {\n' +
       '    "type": "resource2",\n' +
-      '    "param2": [\n' +
-      '      "a",\n' +
-      '      "b",\n' +
-      '      "c",\n' +
-      '      "d"\n' +
-      '    ]\n' +
+      '    "param2": ["a", "b", "c", "d"],\n' +
       '  }\n' +
       ']',)
     console.log(result)
@@ -517,6 +502,60 @@ describe('File modification calculator tests', () => {
     )
   })
 
+  it('Can handle comments inside a .json5 file', async () => {
+    const existingFile =
+      `[
+  // I am a comment
+  /*
+  I am a multi-line comment
+  */
+  {
+    "type": "jenv",
+    "add": [
+      "system",
+      "11",
+      "17", // Line comment
+      "17.0.12", // Line comment
+      "openjdk64-11.0.24",
+      "openjdk64-17.0.12"
+    ],
+    "global": "17"
+  }
+]
+`
+    generateTestFile(existingFile, '/codify.json5');
+
+    const project = await CodifyParser.parse('/codify.json5')
+    project.resourceConfigs.forEach((r) => {
+      r.attachResourceInfo(generateResourceInfo(r.type, []))
+    });
+
+    const modifiedResource = new ResourceConfig({
+      "type": "jenv",
+      "add": [
+        "system",
+        "11",
+        "11.0",
+        "11.0.24",
+        "17",
+        "17.0.12",
+        "openjdk64-11.0.24",
+        "openjdk64-17.0.12"
+      ],
+      "global": "17"
+    })
+    modifiedResource.attachResourceInfo(generateResourceInfo('jenv'))
+
+    const calculator = new FileModificationCalculator(project);
+    const result = await calculator.calculate([{
+      modification: ModificationType.INSERT_OR_UPDATE,
+      resource: modifiedResource,
+    }], match)
+
+    console.log(result.newFile);
+    console.log(result.diff)
+  })
+
   afterEach(() => {
     vi.resetAllMocks();
   })

src/utils/file-modification-calculator.test.ts

@@ -1,6 +1,7 @@
 import { ResourceConfig } from '../entities/resource-config.js';
 
 import * as jsonSourceMap from 'json-source-map';
+import jju from 'jju'
 
 import { FileType, InMemoryFile } from '../parser/entities.js';
 import { SourceMap, SourceMapCache } from '../parser/source-maps.js';
@@ -80,8 +81,7 @@ export class FileModificationCalculator {
       }
 
       // Update an existing resource
-      newFile = this.remove(newFile, this.sourceMap, sourceIndex, isOnly);
-      newFile = this.update(newFile, modified.resource, existing, this.sourceMap, sourceIndex, isOnly);
+      newFile = this.update(newFile, modified.resource, existing, sourceIndex);
     }
 
     // Insert new resources
@@ -143,9 +143,11 @@ export class FileModificationCalculator {
   ): string {
     let result = file;
 
+    const fileStyle = jju.analyze(file);
+
     for (const newResource of resources.reverse()) {
       const sortedResource = { ...newResource.core(true), ...this.sortKeys(newResource.parameters) }
-      let content = JSON.stringify(sortedResource, null, 2);
+      let content = jju.stringify(sortedResource, fileStyle as any);
 
       content = content.split(/\n/).map((l) => `${this.indentString}${l}`).join('\n')
       content = `,\n${content}`;
@@ -162,11 +164,6 @@ export class FileModificationCalculator {
     sourceIndex: number,
     isOnly: boolean,
   ): string {
-    // The element being removed is the only element left,
-    if (isOnly) {
-      return '[]';
-    }
-
     const isLast = sourceIndex === this.totalConfigLength - 1;
     const isFirst = sourceIndex === 0;
 
@@ -192,32 +189,15 @@ export class FileModificationCalculator {
     file: string,
     resource: ResourceConfig,
     existing: ResourceConfig,
-    sourceMap: SourceMap,
     sourceIndex: number,
-    isOnly: boolean,
   ): string {
     // Updates: for now let's remove and re-add the entire object. Only two formatting availalbe either same line or multi-line
     const { value, valueEnd } = this.sourceMap.lookup(`/${sourceIndex}`)!;
-    const isSameLine = value.line === valueEnd.line;
     const isFirst = sourceIndex === 0;
-
-    // We try to start deleting from the previous element to the next element if possible. This covers any spaces as well.
-    const start = !isFirst ? this.sourceMap.lookup(`/${sourceIndex - 1}`)?.valueEnd : this.sourceMap.lookup(`/${sourceIndex}`)?.value;
-
     const sortedResource = this.sortKeys(resource.raw, existing.raw);
 
-    let content = isSameLine
-      ? JSON.stringify(sortedResource, null, 1).replaceAll('\n', '').replaceAll(/}$/g, ' }')
-      : JSON.stringify(sortedResource, null, this.indentString);
-    content = this.updateParamsToOnelineIfNeeded(content, sourceMap, sourceIndex);
-
-    content = content.split(/\n/).map((l) => `${this.indentString}${l}`).join('\n');
-    if (isOnly) {
-      return `[\n${content}\n]`;
-    }
-    content = isFirst ? `\n${content},` : `,\n${content}`
-
-    return this.splice(file, start?.position!, 0, content);
+    let content = jju.update(file.slice(value.position, valueEnd.position), sortedResource)
+    return this.splice(file, value?.position!, valueEnd.position - value.position, content);
   }
 
   /** Attempt to make arrays and objects oneliners if they were before. It does this by creating a new source map */