Merge pull request #35 from andrewbranch/json5-and-loglevel

Support json5 and don’t log warnings by default

Author: andrewbranch

README.md

@@ -70,6 +70,7 @@ Add to your `gatsby-config.js` (all options are optional; defaults shown here):
           }) => '',
           extensionDataDirectory: // Absolute path to the directory where extensions will be downloaded. Defaults to inside node_modules.
             path.resolve('extensions'),
+          logLevel: 'error'       // Set to 'warn' to debug if something looks wrong
         }
       }]
     }

lib/vscode/colorThemeData.js

@@ -7,14 +7,14 @@
 
 const path = require('path');
 const fs = require('fs');
-const json = require('comment-json');
+const JSON5 = require('json5');
 const plist = require('plist');
 
 function loadColorTheme(themeLocation, resultRules = [], resultColors = {}) {
 	let name = path.basename(themeLocation).split('.')[0];
 	if (path.extname(themeLocation) === '.json') {
 		const content = fs.readFileSync(themeLocation, 'utf8');
-		let contentValue = json.parse(content);
+		let contentValue = JSON5.parse(content);
 		name = contentValue.name || name;
 		if (contentValue.include) {
 			loadColorTheme(path.join(path.dirname(themeLocation), contentValue.include), resultRules, resultColors);

package-lock.json

@@ -30,10 +30,10 @@
   },
   "homepage": "https://github.com/andrewbranch/gatsby-remark-vscode#readme",
   "devDependencies": {
-    "@types/comment-json": "^1.1.1",
     "@types/decompress": "^4.2.3",
     "@types/glob": "^7.1.1",
     "@types/jest": "^24.0.11",
+    "@types/json5": "0.0.30",
     "@types/lodash.escape": "^4.0.6",
     "@types/lodash.uniq": "^4.5.6",
     "@types/node": "^12.0.0",
@@ -45,10 +45,11 @@
     "typescript": "^3.4.5"
   },
   "dependencies": {
-    "comment-json": "^1.1.3",
     "decompress": "^4.2.0",
+    "json5": "^2.1.0",
     "lodash.escape": "^4.0.1",
     "lodash.uniq": "^4.5.0",
+    "loglevel": "^1.6.3",
     "oniguruma": "^7.2.0",
     "plist": "^3.0.1",
     "unist-util-visit": "^1.4.0",

package.json

@@ -1,6 +1,7 @@
 // @ts-check
 const fs = require('fs');
 const path = require('path');
+const logger = require('loglevel');
 const visit = require('unist-util-visit');
 const escapeHTML = require('lodash.escape');
 const lineHighlighting = require('./lineHighlighting');
@@ -20,14 +21,14 @@ const styles = fs.readFileSync(path.resolve(__dirname, '../styles.css'), 'utf8')
  * @param {string} rootScopeName
  */
 function warnMissingLanguageFile(missingScopeName, rootScopeName) {
-  console.warn(`No language file was loaded for scope '${missingScopeName}' (requested by '${rootScopeName}').`);
+  logger.warn(`No language file was loaded for scope '${missingScopeName}' (requested by '${rootScopeName}').`);
 }
 
 /**
  * @param {string} lang
  */
 function warnUnknownLanguage(lang) {
-  console.warn(
+  logger.warn(
     `Encountered unknown language '${lang}'. If '${lang}' is an alias for a supported language, ` +
       `use the 'languageAliases' plugin option to map it to the canonical language name.`
   );
@@ -120,6 +121,7 @@ function getStylesFromSettings(settings) {
  * @property {boolean=} injectStyles
  * @property {(colorValue: string, theme: string) => string=} replaceColor
  * @property {string=} extensionDataDirectory
+ * @property {'trace' | 'debug' | 'info' | 'warn' | 'error'=} logLevel
  */
 
 function createPlugin() {
@@ -140,9 +142,11 @@ function createPlugin() {
       getLineClassName = () => '',
       injectStyles = true,
       replaceColor = x => x,
-      extensionDataDirectory = path.resolve(__dirname, '../lib/extensions')
+      extensionDataDirectory = path.resolve(__dirname, '../lib/extensions'),
+      logLevel = 'error'
     } = {}
   ) {
+    logger.setLevel(logLevel);
     /** @type {Record<string, string>} */
     const stylesheets = {};
     const nodes = [];

src/index.js

@@ -2,7 +2,7 @@
 const fs = require('fs');
 const util = require('util');
 const path = require('path');
-const json = require('comment-json');
+const JSON5 = require('json5');
 const plist = require('plist');
 const uniq = require('lodash.uniq');
 
@@ -71,7 +71,7 @@ function sanitizeForClassName(str) {
 }
 
 const readFile = util.promisify(fs.readFile);
-const requireJson = /** @param {string} pathName */ pathName => json.parse(fs.readFileSync(pathName, 'utf8'));
+const requireJson = /** @param {string} pathName */ pathName => JSON5.parse(fs.readFileSync(pathName, 'utf8'));
 const requireGrammar = /** @param {string} pathName */ async pathName =>
   path.extname(pathName) === '.json' ? requireJson(pathName) : plist.parse(await readFile(pathName, 'utf8'));
 

src/utils.js

@@ -245,3 +245,11 @@ describe('prefers-color-scheme', () => {
     }, markdownAST);
   });
 });
+
+describe('utils', () => {
+  describe('requireJson', () => {
+    it('works with json5', () => {
+      expect(() => realUtils.requireJson(path.resolve(__dirname, 'json5.tmTheme.json'))).not.toThrow();
+    });
+  });
+});

test/gatsby-remark-vscode.test.js

@@ -0,0 +1,15 @@
+{
+	"$schema": "vscode://schemas/color-theme",
+	"name": "json5",
+	"tokenColors": [
+		{
+			scope: [
+				"meta.embedded",
+				"source.groovy.embedded",
+			],
+			"settings": {
+				"foreground": "#D4D4D4" // a nice gray
+      }
+    },
+  ],
+}