feat: added ability to parse json5

Author: kevinwang5658

README.md

@@ -18,7 +18,7 @@ $ npm install -g codify
 $ codify COMMAND
 running command...
 $ codify (--version)
-codify/0.7.1 darwin-arm64 node-v20.15.1
+codify/0.7.2 darwin-arm64 node-v20.15.1
 $ codify --help [COMMAND]
 USAGE
   $ codify COMMAND
@@ -74,7 +74,7 @@ EXAMPLES
   $ codify apply -S <sudo password>
 ```
 
-_See code: [src/commands/apply.ts](https://github.com/kevinwang5658/codify/blob/v0.7.1/src/commands/apply.ts)_
+_See code: [src/commands/apply.ts](https://github.com/kevinwang5658/codify/blob/v0.7.2/src/commands/apply.ts)_
 
 ## `codify destroy`
 
@@ -113,7 +113,7 @@ EXAMPLES
   $ codify destroy
 ```
 
-_See code: [src/commands/destroy.ts](https://github.com/kevinwang5658/codify/blob/v0.7.1/src/commands/destroy.ts)_
+_See code: [src/commands/destroy.ts](https://github.com/kevinwang5658/codify/blob/v0.7.2/src/commands/destroy.ts)_
 
 ## `codify help [COMMAND]`
 
@@ -189,7 +189,7 @@ EXAMPLES
   $ codify import \*
 ```
 
-_See code: [src/commands/import.ts](https://github.com/kevinwang5658/codify/blob/v0.7.1/src/commands/import.ts)_
+_See code: [src/commands/import.ts](https://github.com/kevinwang5658/codify/blob/v0.7.2/src/commands/import.ts)_
 
 ## `codify init`
 
@@ -217,7 +217,7 @@ EXAMPLES
   $ codify init
 ```
 
-_See code: [src/commands/init.ts](https://github.com/kevinwang5658/codify/blob/v0.7.1/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/kevinwang5658/codify/blob/v0.7.2/src/commands/init.ts)_
 
 ## `codify plan`
 
@@ -254,7 +254,7 @@ EXAMPLES
   $ codify plan -p ../
 ```
 
-_See code: [src/commands/plan.ts](https://github.com/kevinwang5658/codify/blob/v0.7.1/src/commands/plan.ts)_
+_See code: [src/commands/plan.ts](https://github.com/kevinwang5658/codify/blob/v0.7.2/src/commands/plan.ts)_
 
 ## `codify update [CHANNEL]`
 

codify.json

@@ -0,0 +1,19 @@
+[
+  {
+    "type": "project",
+    "plugins": {
+      "default": "../codify-homebrew-plugin/src/index.ts"
+    }
+  },
+  {
+    "type": "macports"
+  },
+  // This is a test comment
+  {
+    "type": "pnpm",
+    "globalEnvNodeVersion": null
+  },
+  {
+    "type": "homebrew"
+  }
+]

codify.json5

@@ -31,7 +31,9 @@
     "parse-json": "^8.1.0",
     "react": "^18.3.1",
     "semver": "^7.5.4",
-    "supports-color": "^9.4.0"
+    "supports-color": "^9.4.0",
+    "json5": "^2.2.3",
+    "@mischnic/json-sourcemap": "^0.1.1"
   },
   "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": {
@@ -47,6 +49,7 @@
     "@types/semver": "^7.5.4",
     "@types/strip-ansi": "^5.2.1",
     "@typescript-eslint/eslint-plugin": "^8.16.0",
+    "@types/json5": "^2.2.0",
     "codify-plugin-lib": "^1.0.151",
     "esbuild": "^0.24.0",
     "esbuild-plugin-copy": "^2.1.1",

package-lock.json

@@ -138,7 +138,7 @@ export class SyntaxError extends CodifyError {
   }
 
   formattedMessage(): string {
-    return `Syntax error: found in codify.json: ${this.message}`
+    return `Syntax error: found in ${this.fileName}: ${this.message}`
   }
 }
 

package.json

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

src/common/errors.ts

@@ -7,16 +7,18 @@ import { Project } from '../entities/project.js';
 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 { 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)$/;
+export const CODIFY_FILE_REGEX = /^(.*)?codify(.json|.yaml|.json5)$/;
 
 class Parser {
   private readonly languageSpecificParsers= {
     [FileType.JSON]: new JsonParser(),
     [FileType.YAML]: new YamlParser(),
+    [FileType.JSON5]: new Json5Parser()
   }
 
   async parse(dirOrFile: string): Promise<Project> {

src/parser/entities.ts

@@ -1,5 +1,6 @@
 declare module 'json-source-map' {
   export interface JsonSourceMap {
+    data: any;
     pointers: JsonPointerObject;
   }
 

src/parser/index.ts

@@ -0,0 +1,85 @@
+import { JsonSourceMap } from 'json-source-map';
+
+import { SourceMap, SourceMapPointer } from '../source-maps.js';
+
+export class JsonSourceMapAdapter implements SourceMap {
+
+  /**
+   * {
+   *   "data": [
+   *     {
+   *       "type": "type1"
+   *     },
+   *     {
+   *       "type": "type2",
+   *       "propA": "a",
+   *       "propB": "b"
+   *     }
+   *   ],
+   *   "pointers": {
+   *     "": {
+   *       "value": { "line": 1, "column": 0, "pos": 1 },
+   *       "valueEnd": { "line": 10, "column": 1, "pos": 97 }
+   *     },
+   *     "/0": {
+   *       "value": { "line": 2, "column": 2, "pos": 5 },
+   *       "valueEnd": { "line": 4, "column": 3, "pos": 30 }
+   *     },
+   *     "/0/type": {
+   *       "key": { "line": 3, "column": 4, "pos": 11 },
+   *       "keyEnd": { "line": 3, "column": 10, "pos": 17 },
+   *       "value": { "line": 3, "column": 12, "pos": 19 },
+   *       "valueEnd": { "line": 3, "column": 19, "pos": 26 }
+   *     },
+   *     "/1": {
+   *       "value": { "line": 5, "column": 2, "pos": 34 },
+   *       "valueEnd": { "line": 9, "column": 3, "pos": 95 }
+   *     },
+   *     "/1/type": {
+   *       "key": { "line": 6, "column": 4, "pos": 40 },
+   *       "keyEnd": { "line": 6, "column": 10, "pos": 46 },
+   *       "value": { "line": 6, "column": 12, "pos": 48 },
+   *       "valueEnd": { "line": 6, "column": 19, "pos": 55 }
+   *     },
+   *     "/1/propA": {
+   *       "key": { "line": 7, "column": 4, "pos": 61 },
+   *       "keyEnd": { "line": 7, "column": 11, "pos": 68 },
+   *       "value": { "line": 7, "column": 13, "pos": 70 },
+   *       "valueEnd": { "line": 7, "column": 16, "pos": 73 }
+   *     },
+   *     "/1/propB": {
+   *       "key": { "line": 8, "column": 4, "pos": 79 },
+   *       "keyEnd": { "line": 8, "column": 11, "pos": 86 },
+   *       "value": { "line": 8, "column": 13, "pos": 88 },
+   *       "valueEnd": { "line": 8, "column": 16, "pos": 91 }
+   *     }
+   *   }
+   * }
+   */
+  private jsonSourceMap: JsonSourceMap;
+
+  constructor(jsonSourceMap: JsonSourceMap) {
+    this.jsonSourceMap = jsonSourceMap;
+  }
+
+  lookup(jsonKey: string): SourceMapPointer | null {
+    const pointer = this.jsonSourceMap.pointers[jsonKey];
+    if (!pointer) {
+      return null;
+    }
+
+    return {
+      value: {
+        line: pointer.value.line,
+        column: pointer.value.column,
+        position: pointer.value.pos,
+      },
+      valueEnd: {
+        line: pointer.valueEnd.line,
+        column: pointer.valueEnd.column,
+        position: pointer.valueEnd.pos,
+      }
+    }
+  }
+}
+