Strip JSON comments before parsing JSON

chrisreddington · Nov 8, 2024 · c73f024 · c73f024
1 parent 5fcb847
commit c73f024
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/badges/coverage.svg b/badges/coverage.svg
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/main.ts b/src/main.ts
@@ -77,6 +77,12 @@ function isDevcontainerContent(obj: unknown): obj is DevcontainerContent {
   return true
 }
 
+// Add this helper function to strip comments
+function stripJsonComments(jsonString: string): string {
+  // Remove single line comments (// ...)
+  return jsonString.replace(/\/\/.*$/gm, '')
+}
+
 export async function run(): Promise<void> {
   try {
     const extensionsList = core.getInput('extensions-list', { required: true })
@@ -95,7 +101,9 @@ export async function run(): Promise<void> {
     const fileContent = await fs.promises.readFile(devcontainerPath, 'utf8')
     let parsedContent: unknown
     try {
-      parsedContent = JSON.parse(fileContent) as unknown
+      // Strip comments before parsing
+      const cleanJson = stripJsonComments(fileContent)
+      parsedContent = JSON.parse(cleanJson) as unknown
     } catch (error) {
       throw new Error(
         `Invalid JSON in devcontainer.json: ${error instanceof Error ? error.message : String(error)}`