Fetch metafield definitions on start-up #597

aswamy · 2024-11-15T20:43:48Z

What are you adding in this PR?

Part of #502

Adding the ability to fetch metafield definitions on VSCode startup
Does not check the version of the CLI
Timeouts if the CLI does not complete the action

Tophat

Unfortunately, the CLI does not contain the metafield definitions pull command yet. To tophat the change override the path variable to use a locally built version of CLI of the main branch.

E.g.

const  path = '<path-to-cli-repo>/packages/cli/bin/dev.js';

UPDATE: CLI version 3.73 has shopify theme metafields pull command so you can just update your CLI and it should work if you're logged in.

What's next? Any followup issues?

Should we be adding .shopify/metafields.json as part of gitignore for themes?

Before you deploy

I included a minor bump changeset

aswamy · 2024-11-15T20:46:33Z

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

+const isWin = process.platform === 'win32';
+
+export async function fetchMetafieldDefinitions() {
+  const path = getShopifyCliPath();


The current CLI does not have the ability to pull metafields, so tophat this build the CLI PR here and hardcode this value to the path.

E.g.

const path = '<where-ever-you-cloned-it>/cli/packages/cli/bin/dev.js'

charlespwd · 2024-11-19T13:22:52Z

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

@@ -10,6 +11,7 @@ const fileSystems: Record<string, AbstractFileSystem> = {
 };

 startServer(connection, new VsCodeFileSystem(connection, fileSystems));
+fetchMetafieldDefinitions();


I think this should somehow be injected in startServer's fetchMetafieldsForURI injection.

IIRC the metafields should be loaded per theme root, not per workspace.

I don't 100% know how the shopify cli works and if there's an auth per theme, but I don't think someone running a monorepo will necessarily have the same metafield definitions for shop A & shop B

aswamy · 2024-11-20T21:21:20Z

@charlespwd Should we also only do this if we're working with themes, and not theme app extensions?

charlespwd · 2024-11-25T13:32:05Z

Should we also only do this if we're working with themes, and not theme app extensions?

I think so. At least until we validate we have a solution for them. Can they even use metafields? Probably?

We do have a getModeForURI: Promise<'theme' | 'app'> in the language server, but it depends on how we load the config. Probably going to be fun (not) to use that from the outside. 😓

aswamy · 2025-01-02T22:12:10Z

Update

Made sure we only fetch metafields using CLI if it's a theme, not a theme app or anything else
Made sure we only fetch metafields using CLI when called from node environment
Fetch metafield definitions for each workspace folder + any folder that get's added dynamically to the workspace

graygilmore · 2025-01-08T17:43:54Z

.changeset/plenty-flowers-eat.md

Should we be adding .shopify/metafields.json as part of gitignore for themes?

Ideally the whole .shopify folder is ignored similar to how Hydrogen does it https://github.com/Shopify/hydrogen/blob/main/.gitignore#L8

but we might be a little late to that party now. I wonder if there's a way we could warn the user somehow? Or maybe the CLI itself takes care of that flow? Hmmmm, none of those options are great.

I think that the generated file should not be added to a user's repo but I also don't have a good suggestion on ensuring that other than through an interactive call in the CLI itself (ie, not via theme-tools).

I talked to @karreiro about this before the break. We can add it to Shopify-manged themes' .gitignore files, but we concluded that it'd be the merchant's responsibility to do so. Having it in their repo isn't going to break anything - If someone accidentally pushes it into their repo, they can easily remove it (just like a node_modules directory).

While checking out theme app extensions, i realized that shopify app dev command also generates a .shopify folder inside their repo. TAEs explicitly have .shopify in .gitignore, so if we wanted to follow them, we could do the same for Shopify-managed themes.

👍🏻

I think we should do two things:

Add .shopify to .gitignore in our 1P themes

Update the CLI to warn if there is a .shopify folder that isn't ignored during theme dev

What do you think?

graygilmore · 2025-01-08T21:07:32Z

.changeset/plenty-flowers-eat.md

👍🏻

I think we should do two things:

Add .shopify to .gitignore in our 1P themes

Update the CLI to warn if there is a .shopify folder that isn't ignored during theme dev

What do you think?

jeffreyguenther · 2025-01-08T23:34:44Z

Update the CLI to warn if there is a .shopify folder that isn't ignored during theme dev

Yes, pls. A nice error is a great way to be hinted at how things work!

madmath · 2025-01-10T16:33:22Z

packages/theme-language-server-node/src/metafieldDefinitions.ts

+
+const shopifyCliPathPromise = getShopifyCliPath();
+
+export async function fetchMetafieldDefinitionsForURI(uri: string) {


I have the exact same need for a different CLI command (here).
Could you pull the logic into some kind of ShopifyCLI caller where I could pass my command and get back the result?

seems like the only difference is that you're calling theme metafields pull and I want to call theme profile!

Note: my code is in another package (vscode-extension)

This feature needs to go in asap so I will refactor in a follow-up PR.

packages/theme-language-server-common/src/server/startServer.ts

charlespwd

LGTM! 🙏

aswamy · 2025-01-13T15:56:20Z

@graygilmore @jeffreyguenther we went with a different approach where when the command is run, we automatically add it to gitignore (if it exists) so no warning will be required:

Shopify/cli#5184

aswamy commented Nov 15, 2024

View reviewed changes

aswamy requested a review from charlespwd November 15, 2024 20:46

aswamy marked this pull request as ready for review November 18, 2024 20:55

charlespwd reviewed Nov 19, 2024

View reviewed changes

aswamy force-pushed the fetch-metafield-defs-on-start-up branch from dedbbb8 to 2235083 Compare January 2, 2025 22:10

aswamy requested a review from a team as a code owner January 2, 2025 22:10

Fetch metafield definitions on start-up using CLI

cbdffd4

aswamy force-pushed the fetch-metafield-defs-on-start-up branch from 2235083 to cbdffd4 Compare January 2, 2025 22:16

aswamy requested a review from charlespwd January 7, 2025 21:13

graygilmore reviewed Jan 8, 2025

View reviewed changes

graygilmore approved these changes Jan 8, 2025

View reviewed changes

madmath reviewed Jan 10, 2025

View reviewed changes

charlespwd reviewed Jan 10, 2025

View reviewed changes

packages/theme-language-server-common/src/server/startServer.ts Show resolved Hide resolved

charlespwd approved these changes Jan 10, 2025

View reviewed changes

aswamy merged commit 4a429e1 into main Jan 13, 2025
6 checks passed

aswamy deleted the fetch-metafield-defs-on-start-up branch January 13, 2025 22:26

aswamy mentioned this pull request Jan 14, 2025

Refactor CLI command runner #708

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fetch metafield definitions on start-up #597

Fetch metafield definitions on start-up #597

aswamy commented Nov 15, 2024 •

edited

Loading

aswamy Nov 15, 2024

charlespwd Nov 19, 2024

aswamy commented Nov 20, 2024

charlespwd commented Nov 25, 2024

aswamy commented Jan 2, 2025

graygilmore Jan 8, 2025

aswamy Jan 8, 2025

graygilmore Jan 8, 2025

graygilmore Jan 8, 2025

jeffreyguenther commented Jan 8, 2025

madmath Jan 10, 2025

aswamy Jan 13, 2025

charlespwd left a comment

aswamy commented Jan 13, 2025


		const shopifyCliPathPromise = getShopifyCliPath();

		export async function fetchMetafieldDefinitionsForURI(uri: string) {

Fetch metafield definitions on start-up #597

Fetch metafield definitions on start-up #597

Conversation

aswamy commented Nov 15, 2024 • edited Loading

What are you adding in this PR?

Tophat

What's next? Any followup issues?

Before you deploy

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aswamy commented Nov 20, 2024

charlespwd commented Nov 25, 2024

aswamy commented Jan 2, 2025

Update

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffreyguenther commented Jan 8, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlespwd left a comment

Choose a reason for hiding this comment

aswamy commented Jan 13, 2025

aswamy commented Nov 15, 2024 •

edited

Loading