Enable injections

Author: andrewbranch

.vscode/launch.json

@@ -17,6 +17,15 @@
       "program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
       "args": ["--runInBand"],
       "console": "integratedTerminal"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Example Site",
+      "cwd": "${workspaceFolder}/examples/example-site",
+      "program": "${workspaceFolder}/examples/example-site/node_modules/.bin/gatsby",
+      "args": ["develop"],
+      "console": "integratedTerminal"
     }
   ]
 }

examples/example-site/content/blog/hello-world/index.md

@@ -4,14 +4,6 @@ date: "2015-05-01T22:12:03.284Z"
 description: "Hello World"
 ---
 
-
-
-
-
-
-
-
-
 ```jsx
 const Wrapper = styled.section`
   border-radius: 4px;
@@ -27,4 +19,13 @@ const Wrapper = styled.section`
 export default function MyComponent({ children }) = (
   <Wrapper>{children}</Wrapper>
 )
+```
+
+```js
+/**
+ * @param {string} x
+ */
+function foo(x) {
+
+}
 ```

src/createGetRegistry.js

@@ -1,6 +1,6 @@
 // @ts-check
 const fs = require('fs');
-const { getGrammarLocation, getGrammar } = require('./storeUtils');
+const { getGrammarLocation, getGrammar, getAllGrammars } = require('./storeUtils');
 const { promisify } = require('util');
 const { Registry, parseRawGrammar } = require('vscode-textmate');
 const readFile = promisify(fs.readFile);
@@ -49,15 +49,25 @@ function createGetRegistry() {
    */
   async function getRegistry(cache, onMissingLanguageFile) {
     if (!registry) {
+      const grammars = getAllGrammars(await cache.get('grammars'));
       registry = new Registry({
         loadGrammar: async scopeName => {
-          const grammarInfo = getGrammar(scopeName, await cache.get('grammars'));
+          const grammarInfo = getGrammar(scopeName, grammars);
           const fileName = grammarInfo && getGrammarLocation(grammarInfo);
           if (fileName) {
             const contents = await readFile(fileName, 'utf8');
             return parseRawGrammar(contents, fileName);
           }
           onMissingLanguageFile(scopeName);
+        },
+        getInjections: scopeName => {
+          return Object.keys(grammars).reduce((acc, s) => {
+            const grammar = grammars[s];
+            if (grammar.injectTo && grammar.injectTo.includes(scopeName)) {
+              acc.push(s);
+            }
+            return acc;
+          }, []);
         }
       });
     }

src/downloadExtension.js

@@ -6,20 +6,13 @@ const util = require('util');
 const request = require('request');
 const decompress = require('decompress');
 const processExtension = require('./processExtension');
-const {
-  getScope,
-  getGrammar,
-  getGrammarLocation,
-  getThemeLocation,
-  highestBuiltinLanguageId
-} = require('./storeUtils');
+const { highestBuiltinLanguageId } = require('./storeUtils');
 const {
   parseExtensionIdentifier,
   getExtensionPath,
   getExtensionBasePath,
   getExtensionPackageJson
 } = require('./utils');
-const exists = util.promisify(fs.exists);
 const gunzip = util.promisify(zlib.gunzip);
 let languageId = highestBuiltinLanguageId + 1;
 
@@ -83,21 +76,17 @@ async function downloadExtension(extensionDemand, cache, extensionDir) {
 
 /**
  * @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, extensionDir }) {
+async function downloadExtensionsIfNeeded({ extensions, cache, extensionDir }) {
   extensions = extensions.slice();
-  const extensionExists = type === 'grammar' ? grammarExists : themeExists;
-  while (extensions.length && !(await extensionExists(name))) {
+  while (extensions.length) {
     const extensionDemand = extensions.shift();
     const { identifier, version } = extensionDemand;
     const extensionPath = getExtensionBasePath(identifier, extensionDir);
@@ -113,19 +102,6 @@ async function downloadExtensionIfNeeded({ type, name, extensions, cache, langua
 
     await syncExtensionData(extensionDemand, cache, extensionDir);
   }
-
-  /** @param {string} languageName */
-  async function grammarExists(languageName) {
-    const grammarCache = await cache.get('grammars');
-    const grammar = getGrammar(getScope(languageName, grammarCache, languageAliases), grammarCache);
-    return grammar && getGrammarLocation(grammar) && exists(getGrammarLocation(grammar));
-  }
-
-  /** @param {string} themeName */
-  async function themeExists(themeName) {
-    const location = getThemeLocation(themeName, await cache.get('themes'));
-    return location && exists(location);
-  }
 }
 
-module.exports = { downloadExtension, downloadExtensionIfNeeded, syncExtensionData };
+module.exports = { downloadExtension, downloadExtensionIfNeeded: downloadExtensionsIfNeeded, syncExtensionData };

src/index.js

@@ -9,7 +9,7 @@ const parseCodeFenceHeader = require('./parseCodeFenceHeader');
 const { sanitizeForClassName } = require('./utils');
 const { loadColorTheme } = require('../lib/vscode/colorThemeData');
 const { getClassNameFromMetadata } = require('../lib/vscode/modes');
-const { downloadExtensionIfNeeded } = require('./downloadExtension');
+const { downloadExtensionIfNeeded: downloadExtensionsIfNeeded } = require('./downloadExtension');
 const { getGrammar, getScope, getThemeLocation } = require('./storeUtils');
 const { generateTokensCSSForColorMap } = require('../lib/vscode/tokenization');
 const { renderRule, prefersDark, prefersLight, prefixRules, joinClassNames } = require('./cssUtils');
@@ -155,12 +155,9 @@ 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({
-        type: 'grammar',
-        name: languageName,
+      await downloadExtensionsIfNeeded({
         extensions,
         cache,
-        languageAliases,
         extensionDir: extensionDataDirectory
       });
 
@@ -190,14 +187,6 @@ function createPlugin() {
         for (const setting in colorThemeSettings) {
           const colorThemeIdentifier = colorThemeSettings[setting];
           if (!colorThemeIdentifier) continue;
-          await downloadExtensionIfNeeded({
-            type: 'theme',
-            name: colorThemeIdentifier,
-            extensions,
-            cache,
-            languageAliases,
-            extensionDir: extensionDataDirectory
-          });
 
           const themeClassName = themeClassNames[setting];
           const themeCache = await cache.get('themes');

src/processExtension.js

@@ -19,6 +19,7 @@ async function processExtension(packageJsonPath) {
           path: sourcePath,
           tokenTypes: grammar.tokenTypes,
           embeddedLanguages: grammar.embeddedLanguages,
+          injectTo: grammar.injectTo,
           languageNames: languageRegistration ? getLanguageNames(languageRegistration) : []
         };
       })
@@ -31,6 +32,7 @@ async function processExtension(packageJsonPath) {
           path: grammar.path,
           tokenTypes: grammar.tokenTypes,
           embeddedLanguages: grammar.embeddedLanguages,
+          injectTo: grammar.injectTo,
           languageNames: grammar.languageNames
         }
       }),

src/storeUtils.js

@@ -61,7 +61,14 @@ const highestBuiltinLanguageId = Object.keys(grammarManifest).reduce(
  * @param {*} grammarCache
  */
 function getGrammar(scopeName, grammarCache) {
-  return { ...grammarManifest, ...grammarCache }[scopeName];
+  return getAllGrammars(grammarCache)[scopeName];
 }
 
-module.exports = { getScope, getGrammar, getGrammarLocation, getThemeLocation, highestBuiltinLanguageId };
+/**
+ * @param {*} grammarCache 
+ */
+function getAllGrammars(grammarCache) {
+  return { ...grammarManifest, ...grammarCache };
+}
+
+module.exports = { getScope, getGrammar, getGrammarLocation, getThemeLocation, highestBuiltinLanguageId, getAllGrammars };