Fetch metafield definitions on start-up

.changeset/rare-coins-sit.md

@@ -0,0 +1,5 @@
+---
+'theme-check-vscode': minor
+---
+
+Fetch metafield definitions on start-up

packages/vscode-extension/src/node/metafieldDefinitions.ts

@@ -0,0 +1,36 @@
+import * as child_process from 'child_process';
+import { promisify } from 'node:util';
+
+const exec = promisify(child_process.exec);
+
+const isWin = process.platform === 'win32';
+
+export async function fetchMetafieldDefinitions() {
+  const path = getShopifyCliPath();
+
+  if (!path) {
+    return;
+  }
+
+  try {
+    await exec(`${path} theme metafields pull`, { timeout: 10_000 });
+  } catch (_) {
+    // CLI command can break because of incorrect version or not being logged in
+    // If this fails, the user must fetch their own metafield definitions
+  }
+}
+
+// eslint-disable-next-line no-unused-vars
+async function getShopifyCliPath() {
+  if (isWin) {
+    const { stdout } = await exec(`where.exe shopify`);
+    const executables = stdout
+      .replace(/\r/g, '')
+      .split('\n')
+      .filter((exe) => exe.endsWith('bat'));
+    return executables.length > 0 ? executables[0] : '';
+  } else {
+    const { stdout } = await exec(`which shopify`);
+    return stdout.split('\n')[0].replace('\r', '');
+  }
+}

packages/vscode-extension/src/node/server.ts

@@ -1,6 +1,7 @@
 import type { AbstractFileSystem } from '@shopify/theme-check-common';
 import { getConnection, NodeFileSystem, startServer } from '@shopify/theme-language-server-node';
 import { VsCodeFileSystem } from '../common/VsCodeFileSystem';
+import { fetchMetafieldDefinitions } from './metafieldDefinitions';
 
 const connection = getConnection();
 
@@ -10,6 +11,7 @@ const fileSystems: Record<string, AbstractFileSystem> = {
 };
 
 startServer(connection, new VsCodeFileSystem(connection, fileSystems));
+fetchMetafieldDefinitions();
 
 process.on('uncaughtException', (e) => {
   console.error(e);