feat: add astro support for VSCode extension (#3475)

* feat: add astro syntax grammar support * feat: add astro support for language server
graphql · Jan 24, 2024 · 98af530 · 98af530
1 parent 88ae243
commit 98af530
Show file tree

Hide file tree

Showing 15 changed files with 195 additions and 41 deletions.
diff --git a/.changeset/grumpy-moles-grin.md b/.changeset/grumpy-moles-grin.md
@@ -0,0 +1,7 @@
+---
+'graphql-language-service-server': minor
+'vscode-graphql': minor
+'vscode-graphql-syntax': minor
+---
+
+Add Astro file support
diff --git a/custom-words.txt b/custom-words.txt
@@ -65,6 +65,8 @@ yoshiakis
 
 // packages and tools
 argparse
+astro
+astrojs
 changesets
 clsx
 codemirror

diff --git a/packages/graphql-language-service-server/package.json b/packages/graphql-language-service-server/package.json
@@ -38,10 +38,12 @@
   },
   "COMMENT": "please do not remove depenencies without thorough testing. many dependencies are not imported directly, as they are peer dependencies",
   "dependencies": {
+    "@astrojs/compiler": "^2.5.0",
     "@babel/parser": "^7.23.6",
     "@babel/types": "^7.23.5",
     "@graphql-tools/code-file-loader": "8.0.3",
     "@vue/compiler-sfc": "^3.4.5",
+    "astrojs-compiler-sync": "^0.3.5",
     "cosmiconfig-toml-loader": "^1.0.0",
     "dotenv": "10.0.0",
     "fast-glob": "^3.2.7",
@@ -51,12 +53,12 @@
     "mkdirp": "^1.0.4",
     "node-abort-controller": "^3.0.1",
     "nullthrows": "^1.0.0",
+    "source-map-js": "1.0.2",
+    "svelte": "^4.1.1",
     "vscode-jsonrpc": "^8.0.1",
     "vscode-languageserver": "^8.0.1",
     "vscode-languageserver-types": "^3.17.2",
-    "vscode-uri": "^3.0.2",
-    "svelte": "^4.1.1",
-    "source-map-js": "1.0.2"
+    "vscode-uri": "^3.0.2"
   },
   "devDependencies": {
     "@types/glob": "^8.1.0",

diff --git a/packages/graphql-language-service-server/src/constants.ts b/packages/graphql-language-service-server/src/constants.ts
@@ -54,6 +54,7 @@ export const DEFAULT_SUPPORTED_EXTENSIONS = [
   '.tsx',
   '.vue',
   '.svelte',
+  '.astro',
   '.cts',
   '.mts',
 ] as const;

diff --git a/packages/graphql-language-service-server/src/findGraphQLTags.ts b/packages/graphql-language-service-server/src/findGraphQLTags.ts
@@ -19,6 +19,7 @@ import { TAG_MAP } from './constants';
 import { ecmaParser, tsParser } from './parsers/babel';
 // import { svelteParser } from './parsers/svelte';
 import { vueParser } from './parsers/vue';
+import { astroParser } from './parsers/astro';
 import type { Logger, NoopLogger } from './Logger';
 import { RangeMapper } from './parsers/types';
 
@@ -44,6 +45,7 @@ const parserMap = {
   // '.svelte': svelteParser,
   '.svelte': vueParser,
   '.vue': vueParser,
+  '.astro': astroParser,
 };
 
 export function findGraphQLTags(

diff --git a/packages/graphql-language-service-server/src/parsers/astro.ts b/packages/graphql-language-service-server/src/parsers/astro.ts
@@ -0,0 +1,69 @@
+import { parse } from 'astrojs-compiler-sync';
+import { Position, Range } from 'graphql-language-service';
+import { RangeMapper, SourceParser } from './types';
+import { babelParser } from './babel';
+
+type ParseAstroResult =
+  | { type: 'error'; errors: string[] }
+  | {
+      type: 'ok';
+      scriptOffset: number;
+      scriptAst: any[];
+    };
+
+function parseAstro(source: string): ParseAstroResult {
+  // eslint-disable-next-line unicorn/no-useless-undefined
+  const { ast, diagnostics } = parse(source, undefined);
+  if (diagnostics.some(d => d.severity === /* Error */ 1)) {
+    return {
+      type: 'error',
+      errors: diagnostics.map(d => JSON.stringify(d)),
+    };
+  }
+
+  for (const node of ast.children) {
+    if (node.type === 'frontmatter') {
+      try {
+        return {
+          type: 'ok',
+          scriptOffset: (node.position?.start.line ?? 1) - 1,
+          scriptAst: [babelParser(node.value, ['typescript'])],
+        };
+      } catch (error) {
+        return {
+          type: 'error',
+          errors: [String(error)],
+        };
+      }
+    }
+  }
+
+  return { type: 'error', errors: ['Could not find frontmatter block'] };
+}
+
+export const astroParser: SourceParser = (text, uri, logger) => {
+  const parseAstroResult = parseAstro(text);
+  if (parseAstroResult.type === 'error') {
+    logger.error(
+      `Could not parse the astro file at ${uri} to extract the graphql tags:`,
+    );
+    for (const error of parseAstroResult.errors) {
+      logger.error(String(error));
+    }
+    return null;
+  }
+
+  const rangeMapper: RangeMapper = range => {
+    return new Range(
+      new Position(
+        range.start.line + parseAstroResult.scriptOffset,
+        range.start.character,
+      ),
+      new Position(
+        range.end.line + parseAstroResult.scriptOffset,
+        range.end.character,
+      ),
+    );
+  };
+  return { asts: parseAstroResult.scriptAst, rangeMapper };
+};
diff --git a/packages/vscode-graphql-execution/package.json b/packages/vscode-graphql-execution/package.json
@@ -97,9 +97,9 @@
     "@types/node": "^16.18.4",
     "@types/vscode": "1.62.0",
     "@types/ws": "8.2.2",
+    "@vscode/vsce": "^2.22.1-2",
     "esbuild": "0.18.10",
-    "ovsx": "0.5.1",
-    "vsce": "^2.13.0"
+    "ovsx": "0.5.1"
   },
   "dependencies": {
     "@graphql-tools/code-file-loader": "8.0.3",

diff --git a/packages/vscode-graphql-syntax/grammars/graphql.js.json b/packages/vscode-graphql-syntax/grammars/graphql.js.json
@@ -1,6 +1,6 @@
 {
   "scopeName": "inline.graphql",
-  "injectionSelector": "L:(meta.embedded.block.javascript | meta.embedded.block.typescript | source.js | source.ts | source.tsx | source.vue | source.svelte) -source.graphql -inline.graphql -string -comment",
+  "injectionSelector": "L:(meta.embedded.block.javascript | meta.embedded.block.typescript | source.js | source.ts | source.tsx | source.vue | source.svelte | source.astro) -source.graphql -inline.graphql -string -comment",
   "patterns": [
     {
       "contentName": "meta.embedded.block.graphql",
@@ -28,7 +28,11 @@
           "name": "punctuation.definition.string.template.end.js"
         }
       },
-      "patterns": [{ "include": "source.graphql" }]
+      "patterns": [
+        {
+          "include": "source.graphql"
+        }
+      ]
     },
     {
       "contentName": "meta.embedded.block.graphql",
@@ -53,7 +57,11 @@
           "name": "punctuation.definition.string.template.end.js"
         }
       },
-      "patterns": [{ "include": "source.graphql" }]
+      "patterns": [
+        {
+          "include": "source.graphql"
+        }
+      ]
     },
     {
       "name": "taggedTemplates",
@@ -73,7 +81,11 @@
           "name": "punctuation.definition.string.template.end.js"
         }
       },
-      "patterns": [{ "include": "source.graphql" }]
+      "patterns": [
+        {
+          "include": "source.graphql"
+        }
+      ]
     }
   ]
 }
diff --git a/packages/vscode-graphql-syntax/package.json b/packages/vscode-graphql-syntax/package.json
@@ -62,6 +62,7 @@
           "source.tsx",
           "source.vue",
           "source.svelte",
+          "source.astro",
           "text.html.markdown"
         ],
         "scopeName": "inline.graphql",

diff --git a/packages/vscode-graphql/.vscodeignore b/packages/vscode-graphql/.vscodeignore
@@ -11,3 +11,15 @@ renovate.json
 *.tsbuildinfo
 esbuild.js
 dist/**
+
+# exclude all node_modules by default
+../../node_modules/**
+
+# @astrojs/compiler relies on the filesystem structure, therefore can't be bundled
+!../../node_modules/@astrojs/compiler
+# astrojs-compiler-sync relies on the filesystem structure, therefore can't be bundled
+!../../node_modules/astrojs-compiler-sync
+# synckit is the dependency of astrojs-compiler-sync
+!../../node_modules/synckit
+# @pkgr/core is the dependency of synckit
+!../../node_modules/@pkgr/core
diff --git a/packages/vscode-graphql/esbuild.js b/packages/vscode-graphql/esbuild.js
@@ -13,8 +13,11 @@ build({
   outdir: 'out/',
   format: 'cjs',
   sourcemap: true,
-  // Avoid bundling @vue/compiler-sfc's dynamic dependencies
   external: [
+    // Avoid bundling @astrojs/compiler since esbuild can't handle WASM correctly
+    '@astrojs/compiler',
+    'astrojs-compiler-sync',
+    // Avoid bundling @vue/compiler-sfc's dynamic dependencies
     'squirrelly',
     'teacup',
     'coffee-script',

diff --git a/packages/vscode-graphql/package.json b/packages/vscode-graphql/package.json
@@ -167,9 +167,9 @@
   "devDependencies": {
     "@types/capitalize": "2.0.0",
     "@types/vscode": "1.62.0",
+    "@vscode/vsce": "^2.22.1-2",
     "esbuild": "0.18.10",
-    "ovsx": "0.5.1",
-    "vsce": "^2.13.0"
+    "ovsx": "0.5.1"
   },
   "dependencies": {
     "graphql": "^16.8.1",

diff --git a/packages/vscode-graphql/src/apis/statusBar.ts b/packages/vscode-graphql/src/apis/statusBar.ts
@@ -62,6 +62,7 @@ const statusBarActivationLanguageIds = [
   'typescriptreact',
   'vue',
   'svelte',
+  'astro',
 ];
 
 export const createStatusBar = () => {

diff --git a/packages/vscode-graphql/src/extension.ts b/packages/vscode-graphql/src/extension.ts
@@ -60,6 +60,7 @@ export async function activate(context: ExtensionContext) {
       { scheme: 'file', language: 'vue' },
       { scheme: 'file', language: 'vue-html' },
       { scheme: 'file', language: 'svelte' },
+      { scheme: 'file', language: 'astro' },
     ],
     synchronize: {
       // TODO: This should include any referenced graphql files inside the graphql-config
@@ -77,7 +78,7 @@ export async function activate(context: ExtensionContext) {
         // TODO: load ignore
         // These ignore node_modules and .git by default
         workspace.createFileSystemWatcher(
-          '**/{*.graphql,*.graphqls,*.gql,*.js,*.mjs,*.cjs,*.esm,*.es,*.es6,*.jsx,*.ts,*.tsx,*.vue,*.svelte,*.cts,*.mts,*.json}',
+          '**/{*.graphql,*.graphqls,*.gql,*.js,*.mjs,*.cjs,*.esm,*.es,*.es6,*.jsx,*.ts,*.tsx,*.vue,*.svelte,*.cts,*.mts,*.json,*.astro}',
         ),
       ],
     },