Write options validator

Author: andrewbranch

scripts/scrapeBuiltinExtensions.js

@@ -3,7 +3,7 @@ const fs = require('fs');
 const util = require('util');
 const glob = require('glob');
 const path = require('path');
-const processExtension = require('../src/processExtension');
+const { processExtension } = require('../src/processExtension');
 const { requirePlistOrJson } = require('../src/utils');
 
 const copyFile = util.promisify(fs.copyFile);

src/host.js

@@ -1,28 +1,8 @@
 // @ts-check
-const request = require('request');
 const decompress = require('decompress');
-const { gunzip } = require('./utils');
 
 /** @type {Host} */
 const host = {
-  fetch: (url, options) =>
-    new Promise((resolve, reject) => {
-      request.get(url, options, async (error, res, body) => {
-        if (error) {
-          return reject(error);
-        }
-        if (res.statusCode !== 200) {
-          return resolve({ body, statusCode: res.statusCode });
-        }
-        if (res.headers['content-encoding'] === 'gzip') {
-          const unzipped = await gunzip(body);
-          return resolve({ body: unzipped, statusCode: res.statusCode });
-        }
-
-        resolve({ body, statusCode: res.statusCode });
-      });
-    }),
-
   decompress
 };
 

src/index.js

@@ -5,6 +5,7 @@ const logger = require('loglevel');
 const defaultHost = require('./host');
 const visit = require('unist-util-visit');
 const escapeHTML = require('lodash.escape');
+const validateOptions = require('./validateOptions');
 const createGetRegistry = require('./createGetRegistry');
 const tokenizeWithTheme = require('./tokenizeWithTheme');
 const getPossibleThemes = require('./getPossibleThemes');
@@ -16,19 +17,19 @@ const { getGrammar, getScope } = require('./storeUtils');
 const { renderHTML, span, code, pre, style, mergeAttributes, TriviaRenderFlags } = require('./renderers/html');
 const { joinClassNames, ruleset, media, declaration } = require('./renderers/css');
 const {
-  once,
-  deprecationNotice,
   getThemeClassName,
   getThemeClassNames,
   getStylesFromThemeSettings,
   flatMap,
   groupConditions,
-  convertLegacyThemeOption
+  convertLegacyThemeOption,
+  createOnce
 } = require('./utils');
 const styles = fs.readFileSync(path.resolve(__dirname, '../styles.css'), 'utf8');
 
 function createPlugin() {
   const getRegistry = createGetRegistry();
+  const once = createOnce();
 
   /**
    * @param {{ markdownAST: MDASTNode, markdownNode: MarkdownNode, cache: any }} _
@@ -54,15 +55,24 @@ function createPlugin() {
     await once(async () => {
       logger.setLevel(logLevel);
       if (legacyTheme) {
-        deprecationNotice(
-          `The 'colorTheme' option has been replaced by 'theme' and will be removed in a future version. ` +
-            `See https://github.com/andrewbranch/gatsby-remark-vscode/blob/master/MIGRATING.md for details.`,
-          'colorThemeWarning'
-        );
         theme = convertLegacyThemeOption(legacyTheme);
       }
 
-      await processExtensions(extensions, markdownNode.fileAbsolutePath, host, cache);
+      validateOptions({
+        theme,
+        colorTheme: legacyTheme,
+        wrapperClassName,
+        languageAliases,
+        extensions,
+        getLineClassName,
+        injectStyles,
+        replaceColor,
+        logLevel,
+        host,
+        getLineTransformers
+      });
+
+      await processExtensions(extensions, host, cache);
     }, 'setup');
 
     const lineTransformers = getLineTransformers({
@@ -235,6 +245,7 @@ function createPlugin() {
       });
     }
   }
+
   return textmateHighlight;
 }
 

src/processExtension.js

@@ -1,12 +1,12 @@
 // @ts-check
 const path = require('path');
-const { getLanguageNames, requireJson, requirePlistOrJson, isRelativePath, readFile } = require('./utils');
+const { getLanguageNames, requireJson, requirePlistOrJson, readFile } = require('./utils');
 const { highestBuiltinLanguageId } = require('./storeUtils');
 const unzipDir = path.resolve(__dirname, '../lib/extensions');
 let languageId = highestBuiltinLanguageId + 1;
 
 /**
- * @param {string} packageJsonPath 
+ * @param {string} packageJsonPath
  */
 async function processExtension(packageJsonPath) {
   const packageJson = requireJson(packageJsonPath);
@@ -83,14 +83,10 @@ async function mergeCache(cache, key, value) {
 
 /**
  * @param {string} specifier
- * @param {string} contextDir
  * @param {Host} host
  */
-async function getExtensionPath(specifier, contextDir, host) {
-  const absolute = path.isAbsolute(specifier) ? specifier :
-    isRelativePath(specifier) ? path.normalize(path.join(contextDir, specifier)) :
-    require.resolve(specifier);
-  
+async function getExtensionPath(specifier, host) {
+  const absolute = path.isAbsolute(specifier) ? specifier : require.resolve(specifier);
   const ext = path.extname(absolute);
   if (ext.toLowerCase() === '.vsix' || ext.toLowerCase() === '.zip') {
     const outDir = path.join(unzipDir, path.basename(absolute, ext));
@@ -103,18 +99,19 @@ async function getExtensionPath(specifier, contextDir, host) {
 
 /**
  * @param {string[]} extensions
- * @param {string} contextDir
  * @param {Host} host
  * @param {*} cache
  */
-function processExtensions(extensions, contextDir, host, cache) {
-  return Promise.all(extensions.map(async extension => {
-    const packageJsonPath = path.join(await getExtensionPath(extension, contextDir, host), 'package.json');
-    const { grammars, themes } = await processExtension(packageJsonPath);
-    Object.keys(grammars).forEach(scopeName => (grammars[scopeName].languageId = languageId++));
-    await mergeCache(cache, 'grammars', grammars);
-    await mergeCache(cache, 'themes', themes);
-  }));
+function processExtensions(extensions, host, cache) {
+  return Promise.all(
+    extensions.map(async extension => {
+      const packageJsonPath = path.join(await getExtensionPath(extension, host), 'package.json');
+      const { grammars, themes } = await processExtension(packageJsonPath);
+      Object.keys(grammars).forEach(scopeName => (grammars[scopeName].languageId = languageId++));
+      await mergeCache(cache, 'grammars', grammars);
+      await mergeCache(cache, 'themes', themes);
+    })
+  );
 }
 
 module.exports = { processExtension, processExtensions };

src/utils.js

@@ -291,28 +291,28 @@ function convertLegacyThemeSettings(themeSettings) {
   };
 }
 
-const fns = new Set();
-/**
- * @template {void | Promise<void>} T
- * @param {() => T} fn
- * @param {any=} key
- * @returns {T | undefined}
- */
-function once(fn, key = fn) {
-  if (!fns.has(key)) {
-    fns.add(key);
-    return fn();
-  }
+function createOnce() {
+  const onceFns = new Set();
+  /**
+   * @template {void | Promise<void>} T
+   * @param {() => T} fn
+   * @param {any=} key
+   * @returns {T | undefined}
+   */
+  return function once(fn, key = fn) {
+    if (!onceFns.has(key)) {
+      onceFns.add(key);
+      return fn();
+    }
+  };
 }
 
-function deprecationNotice(message, key = message) {
-  once(() => {
-    logger.warn(`Deprecation notice: ${message}`);
-  }, key);
+function deprecationNotice(message) {
+  logger.warn(`Deprecation notice: ${message}`);
 }
 
 /**
- * @param {string} p 
+ * @param {string} p
  */
 function isRelativePath(p) {
   return /^\.\.?[\\/]/.test(p);
@@ -342,7 +342,7 @@ module.exports = {
   groupConditions,
   getStylesFromThemeSettings,
   convertLegacyThemeOption,
-  once,
   deprecationNotice,
-  isRelativePath
+  isRelativePath,
+  createOnce
 };

src/validateOptions.js

@@ -0,0 +1,48 @@
+const { EOL } = require('os');
+const { deprecationNotice, isRelativePath } = require('./utils');
+
+/**
+ * @param {PluginOptions} options
+ */
+function validateOptions(options) {
+  /** @type {string[]} */
+  const errors = [];
+
+  if (options.colorTheme) {
+    deprecationNotice(
+      `The 'colorTheme' option has been replaced by 'theme' and will be removed in a future version. ` +
+        `See https://github.com/andrewbranch/gatsby-remark-vscode/blob/master/MIGRATING.md for details.`
+    );
+  }
+
+  if (options.extensions) {
+    if (options.extensions.some(ext => typeof ext !== 'string')) {
+      addError(
+        'extensions',
+        'Each element must be a string. See ' +
+          'https://github.com/andrewbranch/gatsby-remark-vscode/tree/master/MIGRATING.md ' +
+          'for details.'
+      );
+    }
+
+    options.extensions.forEach(extension => {
+      if (isRelativePath(extension)) {
+        addError('extensions', `Extension paths must be absolute. Received '${extension}'.`);
+      }
+    });
+  }
+
+  if (errors.length) {
+    throw new Error(errors.join(EOL.repeat(2)));
+  }
+
+  /**
+   * @param {string} optionNme
+   * @param {string} message
+   */
+  function addError(optionNme, message) {
+    errors.push(`Invalid option '${optionNme}': ${message}`);
+  }
+}
+
+module.exports = validateOptions;