Add .shopify/metafields.json to .gitignore by default

[karreiro]

WHY are these changes introduced?

Fixes #5183

We've noticed a significant number of users discussing whether to ignore the .shopify/metafields.json file. While this decision ultimately rests with the developer, ignoring it by default seems like a sensible approach. This PR proposes implementing that default.

WHAT is this pull request doing?

This PR updates the .shopify/metafields.json creation to also add it to .gitignore.

How to test your changes?

• Run shopify theme metafields pull
• Notice that, when the .shopify/metafields.json file is created, it's also added in the gitingore

Post-release steps

N/A

Measuring impact

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

• n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
• Existing analytics will cater for this addition
• PR includes analytics changes to measure impact

Checklist

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

[illarionvk]

It looks like your code always adds the line to .gitignore; how to opt-out of it?

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	75.14% (+0.02% 🔼)	8888/11829
🟡	Branches	70.29% (+0.02% 🔼)	4342/6177
🟡	Functions	75.07% (+0.03% 🔼)	2328/3101
🟡	Lines	75.69% (+0.02% 🔼)	8402/11100

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49% (-2.7% 🔻)	90.48%	98.61%

Test suite run success

2008 tests passing in 906 suites.

Report generated by 🧪jest coverage report action from bb40a59

[karreiro]

Thank you for the review, @illarionvk!

It looks like your code always adds the line to .gitignore; how to opt-out of it?

It adds the line only when the file gets created. In subsequent synchronizations, it will no longer update the .gitignore. Users who prefer to sync the file can undo the .gitignore change and they won't be prompted to add that anymore.

[aswamy]

❤️

[github-actions]

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

• Some seemingly private modules might be re-exported through public modules.
• If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/fs.d.ts

@@ -278,6 +278,31 @@ export declare function glob(pattern: Pattern | Pattern[], options?: GlobOptions
  * @returns The File URL.
  */
 export declare function pathToFileURL(path: string): URL;
+/**
+ * The operating system-specific end-of-line marker:
+ * - 
+    node/20.18.1
+
+Use up/down arrow keys to select a version, return key to install, d to delete, q to quit on POSIX
+ * -  on Windows
+ */
+export type EOL = '
+' | '
+';
+/**
+ * Detects the end-of-line marker used in a string.
+ *
+ * @param content - file contents to analyze
+ *
+ * @returns The detected end-of-line marker
+ */
+export declare function detectEOL(content: string): EOL;
+/**
+ * Returns the operating system's end-of-line marker.
+ *
+ * @returns The OS-specific end-of-line marker
+ */
+export declare function defaultEOL(): EOL;
 /**
  * Find a file by walking parent directories.
  *

[frandiox]

Thanks!

[frandiox]

We should consider centralizing this logic in cli-kit 😅
https://github.com/Shopify/hydrogen/blob/6bc6068fbffebbcd07c3d1db97956248bfa6a742/packages/cli/src/lib/shopify-config.ts#L135