Update theme info command to support multiple environments #5392

EvilGenius13 · 2025-02-14T16:05:57Z

Follow up from #5284
Allow theme info command to be called using multiple environments

WHAT is this pull request doing?

These changes allow a user to pass multiple environment from their shopify.theme.toml file at once.

Before:

After:
With terminal hyperlinks:

Without terminal hyperlinks:

How to test your changes?

Pull down the branch
Build the branch
If you don't already have one, create a shopify.theme.toml file

Note: You will need to create an access token through your shop(s) to bypass the need to login during theme commands.
The most basic example of the structure needed would be this:

[environments.env1]
store = "myfirstshop.myshopify.com"
password = "access_token"
[environments.env2]
store = "mysecondshop.myshopify.com"
password = "access_token"

Run theme info -e env1 -e env2 or whatever you named your environments.

Post-release steps

We will be converting more commands to support multiple environments.

Measuring impact

How do we know this change was effective? Please choose one:

Existing analytics will cater for this addition

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
[] I've considered possible documentation changes

github-actions · 2025-02-14T16:10:15Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	76.77%	9383/12223
🟡	Branches	71.94%	4596/6389
🟡	Functions	76.41%	2432/3183
🟡	Lines	77.33% (+0.01% 🔼)	8871/11472

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / app-event-watcher.ts	96.39% (-1.2% 🔻)	88.57% (-2.86% 🔻)	95.45%	100%

Test suite run success

2140 tests passing in 938 suites.

Report generated by 🧪jest coverage report action from 70a9a02

EvilGenius13 · 2025-02-14T18:07:53Z

packages/theme/src/cli/commands/theme/info.ts

-        .map(([key, val]) => formatSection(key, `${val}`))
-        .join('\n\n')
-      outputInfo(infoMessage)
+      const formattedInfo = await formatThemeInfo(output, flags)


Moved the logic of the output into packages/theme/src/cli/services/info.ts

EvilGenius13 · 2025-02-14T18:11:38Z

packages/theme/src/cli/services/info.test.ts

@@ -84,3 +101,54 @@ describe('info', () => {
    })
  })
 })
+
+describe('formatThemeInfo', () => {
+  beforeEach(() => {


Due to how our mocking works, we need to refresh when testing formatSection. I followed the same principles from another test.

EvilGenius13 · 2025-02-14T18:14:29Z

packages/theme/src/cli/services/info.ts

@@ -84,3 +85,26 @@ function tabularSection(title: string, data: InlineToken[][]): AlertCustomSectio
    body: {tabularData: data, firstColumnSubdued: true},
  }
 }
+


Originally, I was going to try using tabularData but the main problem is the output is key : value so if you have PREVIEW_URL : https://mystoremyshopify.com?preview_theme_id=130327216212, it will wrap onto another line when within renderInfo.

We could adopt an approach similar to the shopify theme dev command and use the LinkToken with a truncated label :)

Agreed. I have taken this approach in the new commit.

graygilmore · 2025-02-14T23:27:19Z

packages/theme/src/cli/services/info.test.ts

+      ],
+    })
+
+    expect(formatSection).toHaveBeenCalledTimes(6)


How valuable of an assertion are you thinking this is? Can we skip mocking the function entirely?

karreiro

Thank you for this PR, @EvilGenius13!

I've noticed that we are not displaying the environment when users run the info command without passing the --theme:

Aside from that minor detail, the changes are on the right track! :)

karreiro

Thank you, @EvilGenius13!

I've left only one minor comment we may apply in a different PR 🚀

karreiro · 2025-03-13T12:45:52Z

packages/theme/src/cli/services/info.ts

+              title: `Theme information`,
+              body: [{subdued: `Environment name: ${flags.environment}`}],


I don't think it is ideal to show the environment name under the theme information because the environment is not actually related to any theme.

I believe we could instead always display the environment name (when available) and present it in a separate section from the theme.

We may apply that enhancement in a different PR tho 🙇

I'll open another issue and tackle it there! - New issue opened

This commit refactors the theme info command to use multiple environment flags.

EvilGenius13 force-pushed the add-info-to-multi-env branch 2 times, most recently from d744382 to 1f4d53f Compare February 14, 2025 17:59

EvilGenius13 commented Feb 14, 2025

View reviewed changes

EvilGenius13 requested a review from karreiro February 14, 2025 20:43

EvilGenius13 marked this pull request as ready for review February 14, 2025 20:44

EvilGenius13 requested review from a team as code owners February 14, 2025 20:44

graygilmore reviewed Feb 14, 2025

View reviewed changes

karreiro reviewed Feb 17, 2025

View reviewed changes

EvilGenius13 force-pushed the add-info-to-multi-env branch 3 times, most recently from f718064 to 7165d29 Compare March 5, 2025 15:03

EvilGenius13 requested a review from karreiro March 5, 2025 19:34

karreiro approved these changes Mar 13, 2025

View reviewed changes

EvilGenius13 added 3 commits March 17, 2025 14:51

Refactored theme info command to use the new multi-environment setup

109dbc8

This commit refactors the theme info command to use multiple environment flags.

added tests for info formatting

f3f66ef

change rendering to tabular data with render links

70a9a02

EvilGenius13 force-pushed the add-info-to-multi-env branch from 7165d29 to 70a9a02 Compare March 17, 2025 18:51

EvilGenius13 added this pull request to the merge queue Mar 17, 2025

Merged via the queue into main with commit c8bb1c3 Mar 17, 2025
2 checks passed

EvilGenius13 deleted the add-info-to-multi-env branch March 17, 2025 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update theme info command to support multiple environments #5392

Update theme info command to support multiple environments #5392

Uh oh!

EvilGenius13 commented Feb 14, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Feb 14, 2025 •

edited

Loading

Uh oh!

EvilGenius13 Feb 14, 2025

Uh oh!

EvilGenius13 Feb 14, 2025

Uh oh!

EvilGenius13 Feb 14, 2025

Uh oh!

karreiro Feb 17, 2025

Uh oh!

EvilGenius13 Feb 27, 2025

Uh oh!

graygilmore Feb 14, 2025

Uh oh!

karreiro left a comment

Uh oh!

karreiro left a comment

Uh oh!

karreiro Mar 13, 2025

Uh oh!

EvilGenius13 Mar 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		title: `Theme information`,
		body: [{subdued: `Environment name: ${flags.environment}`}],

Update theme info command to support multiple environments #5392

Update theme info command to support multiple environments #5392

Uh oh!

Conversation

EvilGenius13 commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHAT is this pull request doing?

How to test your changes?

Post-release steps

Measuring impact

Checklist

Uh oh!

github-actions bot commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

EvilGenius13 Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

EvilGenius13 Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

EvilGenius13 Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

karreiro Feb 17, 2025

Choose a reason for hiding this comment

Uh oh!

EvilGenius13 Feb 27, 2025

Choose a reason for hiding this comment

Uh oh!

graygilmore Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

karreiro Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

EvilGenius13 Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

EvilGenius13 commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

EvilGenius13 Mar 17, 2025 •

edited

Loading