Support an extensionDataDirectory option

Author: andrewbranch

src/downloadExtension.js

@@ -35,9 +35,10 @@ async function mergeCache(cache, key, value) {
 /**
  * @param {import('.').ExtensionDemand} extensionDemand
  * @param {*} cache
+ * @param {string} extensionDir
  */
-async function syncExtensionData({ identifier }, cache) {
-  const packageJsonPath = path.join(getExtensionPath(identifier), 'package.json');
+async function syncExtensionData({ identifier }, cache, extensionDir) {
+  const packageJsonPath = path.join(getExtensionPath(identifier, extensionDir), 'package.json');
   const { grammars, themes } = await processExtension(packageJsonPath);
   Object.keys(grammars).forEach(scopeName => (grammars[scopeName].languageId = languageId++));
   await mergeCache(cache, 'grammars', grammars);
@@ -47,8 +48,9 @@ async function syncExtensionData({ identifier }, cache) {
 /**
  * @param {import('.').ExtensionDemand} extensionDemand
  * @param {*} cache
+ * @param {string} extensionDir
  */
-async function downloadExtension(extensionDemand, cache) {
+async function downloadExtension(extensionDemand, cache, extensionDir) {
   const { identifier, version } = extensionDemand;
   const { publisher, name } = parseExtensionIdentifier(identifier);
   const url = `https://marketplace.visualstudio.com/_apis/public/gallery/publishers/${publisher}/vsextensions/${name}/${version}/vspackage`;
@@ -73,37 +75,43 @@ async function downloadExtension(extensionDemand, cache) {
     });
   });
 
-  const extensionPath = getExtensionBasePath(identifier);
+  const extensionPath = getExtensionBasePath(identifier, extensionDir);
   await decompress(archive, extensionPath);
-  await syncExtensionData(extensionDemand, cache);
+  await syncExtensionData(extensionDemand, cache, extensionDir);
   return extensionPath;
 }
 
 /**
- * @param {'grammar' | 'theme'} type
- * @param {string} name
- * @param {import('.').ExtensionDemand[]} extensions
- * @param {*} cache
- * @param {Record<string, string>} languageAliases
+ * @typedef {object} DownloadExtensionOptions
+ * @property {'grammar' | 'theme'} type
+ * @property {string} name
+ * @property {import('.').ExtensionDemand[]} extensions
+ * @property {*} cache
+ * @property {Record<string, string>} languageAliases
+ * @property {string} extensionDir
+ */
+
+/**
+ * @param {DownloadExtensionOptions} options
  */
-async function downloadExtensionIfNeeded(type, name, extensions, cache, languageAliases) {
+async function downloadExtensionIfNeeded({ type, name, extensions, cache, languageAliases, extensionDir }) {
   extensions = extensions.slice();
   const extensionExists = type === 'grammar' ? grammarExists : themeExists;
   while (extensions.length && !(await extensionExists(name))) {
     const extensionDemand = extensions.shift();
     const { identifier, version } = extensionDemand;
-    const extensionPath = getExtensionBasePath(identifier);
+    const extensionPath = getExtensionBasePath(identifier, extensionDir);
     if (!fs.existsSync(extensionPath)) {
-      await downloadExtension(extensionDemand, cache);
+      await downloadExtension(extensionDemand, cache, extensionDir);
       continue;
     }
-    const packageJson = getExtensionPackageJson(identifier);
+    const packageJson = getExtensionPackageJson(identifier, extensionDir);
     if (packageJson.version !== version) {
-      await downloadExtension(extensionDemand, cache);
+      await downloadExtension(extensionDemand, cache, extensionDir);
       continue;
     }
 
-    await syncExtensionData(extensionDemand, cache);
+    await syncExtensionData(extensionDemand, cache, extensionDir);
   }
 
   /** @param {string} languageName */

src/index.js

@@ -119,6 +119,7 @@ function getStylesFromSettings(settings) {
  * @property {(line: LineData) => string=} getLineClassName
  * @property {boolean=} injectStyles
  * @property {(colorValue: string, theme: string) => string=} replaceColor
+ * @property {string=} extensionDataDirectory
  */
 
 function createPlugin() {
@@ -138,7 +139,8 @@ function createPlugin() {
       extensions = [],
       getLineClassName = () => '',
       injectStyles = true,
-      replaceColor = x => x
+      replaceColor = x => x,
+      extensionDataDirectory = path.resolve(__dirname, '../lib/extensions')
     } = {}
   ) {
     /** @type {Record<string, string>} */
@@ -153,7 +155,14 @@ function createPlugin() {
       const text = node.value || (node.children && node.children[0] && node.children[0].value);
       if (!text) continue;
       const { languageName, options } = parseCodeFenceHeader(node.lang ? node.lang.toLowerCase() : '');
-      await downloadExtensionIfNeeded('grammar', languageName, extensions, cache, languageAliases);
+      await downloadExtensionIfNeeded({
+        type: 'grammar',
+        name: languageName,
+        extensions,
+        cache,
+        languageAliases,
+        extensionDir: extensionDataDirectory
+      });
 
       const grammarCache = await cache.get('grammars');
       const scope = getScope(languageName, grammarCache, languageAliases);
@@ -180,7 +189,14 @@ function createPlugin() {
       for (const setting in colorThemeSettings) {
         const colorThemeIdentifier = colorThemeSettings[setting];
         if (!colorThemeIdentifier) continue;
-        await downloadExtensionIfNeeded('theme', colorThemeIdentifier, extensions, cache, languageAliases);
+        await downloadExtensionIfNeeded({
+          type: 'theme',
+          name: colorThemeIdentifier,
+          extensions,
+          cache,
+          languageAliases,
+          extensionDir: extensionDataDirectory
+        });
 
         const themeClassName = themeClassNames[setting];
         const themeCache = await cache.get('themes');

src/utils.js

@@ -22,26 +22,29 @@ function parseExtensionIdentifier(identifier) {
 /**
  * Gets the absolute path to the download path of a downloaded extension.
  * @param {string} identifier
+ * @param {string} extensionDir
  */
-function getExtensionBasePath(identifier) {
-  return path.resolve(__dirname, '../lib/extensions', identifier);
+function getExtensionBasePath(identifier, extensionDir) {
+  return path.join(extensionDir, identifier);
 }
 
 /**
  * Gets the absolute path to the data directory of a downloaded extension.
  * @param {string} identifier
+ * @param {string} extensionDir
  */
-function getExtensionPath(identifier) {
-  return path.resolve(getExtensionBasePath(identifier), 'extension');
+function getExtensionPath(identifier, extensionDir) {
+  return path.join(getExtensionBasePath(identifier, extensionDir), 'extension');
 }
 
 /**
  * Gets the package.json of an extension as a JavaScript object.
  * @param {string} identifier
+ * @param {string} extensionDir
  * @returns {object}
  */
-function getExtensionPackageJson(identifier) {
-  return require(path.join(getExtensionPath(identifier), 'package.json'));
+function getExtensionPackageJson(identifier, extensionDir) {
+  return require(path.join(getExtensionPath(identifier, extensionDir), 'package.json'));
 }
 
 /**