feat: [OSM-2902] Parse global.json with a JSONC parser (#93)

Author: nico-incubiq

lib/index.ts

@@ -2,6 +2,7 @@ import 'source-map-support/register';
 import * as fs from 'fs';
 import * as path from 'path';
 import { OpenSourceEcosystems } from '@snyk/error-catalog-nodejs-public';
+import * as jsonc from 'jsonc-parser';
 
 import {
   DepType,
@@ -323,13 +324,9 @@ function extractTargetSdkFromGlobalJson(
   manifestFileContents: string,
 ): string | undefined {
   try {
-    // Remove /* */ comments from the JSON string (if any)
-    // It's allowed: https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#comments-in-globaljson
-    const jsonWithoutComments = manifestFileContents.replace(
-      /\/\*[\s\S]*?\*\/|\/\/.*$/gm,
-      '',
-    );
-    const globalJsonAsObj = JSON.parse(jsonWithoutComments);
+    // Use a JSONC parser as that's the format of global.json, which accepts comments,
+    // see https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#comments-in-globaljson
+    const globalJsonAsObj = jsonc.parse(manifestFileContents);
     return globalJsonAsObj?.sdk?.version;
   } catch (err: any) {
     throw new Error(

package.json

@@ -29,6 +29,7 @@
   "homepage": "https://github.com/snyk/dotnet-deps-parser#readme",
   "dependencies": {
     "@snyk/error-catalog-nodejs-public": "^4.0.1",
+    "jsonc-parser": "^3.3.1",
     "lodash": "^4.17.21",
     "source-map-support": "^0.5.21",
     "xml2js": "0.6.2"

test/fixtures/dotnet-core-global-json/global_with_comments.json

@@ -1,6 +1,7 @@
 {
   // This is a comment.
   "sdk": {
+    "comment": "This is a comment with a URL https://google.com",
     "version": "7.0.100" /* This is comment 2*/
     /* This is a
     multiline comment.*/