Using jsonc to parse the settings to handle comments and fix #3.

aaronpowell · Jul 3, 2019 · c5246ea · c5246ea
1 parent 0fdeba8
commit c5246ea
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 115 deletions.
diff --git a/.test-profiles/simple-profile/data/User/settings.json b/.test-profiles/simple-profile/data/User/settings.json
@@ -1,112 +1,12 @@
 {
-  "editor.fontSize": 24,
-  "profileSwitcher.profiles": ["Default"],
+  "editor.fontSize": 14,
+  "profileSwitcher.profiles": ["Default", "Big Font"],
   "profileSwitcher.storage": {
     "Default": {
-      "sync.gist": "40c333588d64df34c6f36f196010e5ee",
-      "sync.lastUpload": "",
-      "sync.autoDownload": false,
-      "sync.autoUpload": false,
-      "sync.lastDownload": "2017-11-03T04:41:33.893Z",
-      "sync.forceDownload": false,
-      "sync.anonymousGist": false,
-      "sync.host": "",
-      "sync.pathPrefix": "",
-      "sync.quietSync": false,
-      "sync.askGistName": false,
-      "workbench.colorTheme": "1984 - Light",
-      "files.autoSave": "afterDelay",
-      "editor.renderWhitespace": "all",
-      "editor.fontFamily": "Fira Code",
-      "editor.fontLigatures": true,
-      "workbench.startupEditor": "newUntitledFile",
-      "files.autoSaveDelay": 5000,
-      "sync.removeExtensions": true,
-      "sync.syncExtensions": true,
-      "team.showWelcomeMessage": false,
-      "terminal.integrated.rendererType": "auto",
-      "explorer.confirmDelete": false,
-      "window.zoomLevel": 0,
-      "azureStorage.preview.staticWebsites": true,
-      "breadcrumbs.enabled": true,
-      "powershell.powerShellExePath": "C:\\WINDOWS\\SysWow64\\WindowsPowerShell\\v1.0\\powershell.exe",
-      "FSharp.enableReferenceCodeLens": true,
-      "FSharp.fsacRuntime": "netcore",
-      "workbench.iconTheme": "vscode-icons",
-      "peacock.favoriteColors": [
-        {
-          "name": "Angular Red",
-          "value": "#b52e31"
-        },
-        {
-          "name": "Auth0 Orange",
-          "value": "#eb5424"
-        },
-        {
-          "name": "Azure Blue",
-          "value": "#007fff"
-        },
-        {
-          "name": "C# Purple",
-          "value": "#68217A"
-        },
-        {
-          "name": "Gatsby Purple",
-          "value": "#639"
-        },
-        {
-          "name": "Go Cyan",
-          "value": "#5dc9e2"
-        },
-        {
-          "name": "Java Blue-Gray",
-          "value": "#557c9b"
-        },
-        {
-          "name": "JavaScript Yellow",
-          "value": "#f9e64f"
-        },
-        {
-          "name": "Mandalorian Blue",
-          "value": "#1857a4"
-        },
-        {
-          "name": "Node Green",
-          "value": "#215732"
-        },
-        {
-          "name": "React Blue",
-          "value": "#00b3e6"
-        },
-        {
-          "name": "Something Different",
-          "value": "#832561"
-        },
-        {
-          "name": "Vue Green",
-          "value": "#42b883"
-        }
-      ],
-      "[javascript]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
-      },
-      "[jsonc]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
-      },
-      "editor.fontSize": 14,
-      "[json]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
-      },
-      "editor.formatOnSave": true,
-      "[typescriptreact]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
-      },
-      "profileSwitcher.profiles": ["test1"],
-      "profileSwitcher.storage": {
-        "test1": {
-          "foo": "bar"
-        }
-      }
+      "editor.fontSize": 14
+    },
+    "Big Font": {
+      "editor.fontSize": 24
     }
   },
   "profileSwitcher.extensions": {
@@ -118,6 +18,7 @@
         "version": "1.9.0",
         "name": "prettier-vscode"
       }
-    ]
+    ],
+    "Big Font": []
   }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,13 +4,17 @@ All notable changes to the "vscode-profile-switcher" extension will be documente
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [0.3.0] - Unreleased
+## [0.3.0] - 2019-07-03
 
 ### Added
 
 - Working on support for enable/disable extensions as you change profiles (Issue [#2](https://github.com/aaronpowell/vscode-profile-switcher/issues/2))
 - Add support for setting a Live Share profile that is auto-activated (PR [#4](https://github.com/aaronpowell/vscode-profile-switcher/pull/4))
 
+### Changed
+
+- Using [`jsonc`](https://npmjs.org/package/jsonc) for parsing the `settings.json` file so it won't fail if there are comments (see [#3](https://github.com/aaronpowell/vscode-profile-switcher/issues/3))
+
 ## [0.2.0] - 2019-06-28
 
 ### Added

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -136,6 +136,7 @@
   },
   "dependencies": {
     "fs-extra": "^8.0.1",
+    "jsonc": "^2.0.0",
     "vsls": "^0.3.1291"
   }
 }
diff --git a/src/settingsHelper.ts b/src/settingsHelper.ts
@@ -3,6 +3,7 @@ import * as vscode from "vscode";
 import * as os from "os";
 import * as path from "path";
 import { Settings } from "./services/config";
+import { jsonc } from "jsonc";
 
 export enum OsType {
   Windows = 1,
@@ -113,17 +114,20 @@ export default class SettingsHelper {
       return {};
     }
 
-    return await fs.readJSON(settingsPath, { encoding: "utf8" });
+    let fileContents = await fs.readFile(settingsPath, { encoding: "utf8" });
+
+    return jsonc.parse(fileContents);
   }
 
   public async updateUserSettings(update: Settings) {
     let existingSettings = await this.getUserSettings();
 
     let newSettings = Object.assign({}, existingSettings, update);
 
-    await fs.writeJSON(this.getSettingsPath(), newSettings, {
-      encoding: "utf8",
-      spaces: 4
+    let settingsAsJson = jsonc.stringify(newSettings, { space: 4 });
+
+    await fs.writeFile(this.getSettingsPath(), settingsAsJson, {
+      encoding: "utf8"
     });
   }