Introduce AGENTS.md file support in shopify theme init
#6625
Conversation
This comment has been minimized.
This comment has been minimized.
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3442 tests passing in 1395 suites. Report generated by 🧪jest coverage report action from 313b9bf |
karreiro
force-pushed
the
themes-agents.md
branch
2 times, most recently
from
ff2d07b to
0275d5c
Compare
|
/snapit |
aswamy
left a comment
aswamy
left a comment
There was a problem hiding this comment.
Two optional changes, but looks good. I tophatted it on MacOS. I snapped it to test symlinks on Windows. Will report async when it's done.
|
🫰✨ Thanks @aswamy! Your snapshot has been published to npm. Test the snapshot by installing your package globally: npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]Caution After installing, validate the version by running just |
aswamy
left a comment
aswamy
left a comment
There was a problem hiding this comment.
🚨 Tophat issue: The snap fails on Windows when creating the symlinks, but works on MacOS
karreiro
force-pushed
the
themes-agents.md
branch
from
641199a to
8af7d48
Compare
|
/snapit |
|
🫰✨ Thanks @karreiro! Your snapshot has been published to npm. Test the snapshot by installing your package globally: npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]Caution After installing, validate the version by running just |
karreiro
force-pushed
the
themes-agents.md
branch
2 times, most recently
from
e583f79 to
e5e7460
Compare
|
Thanks a lot for the review, @aswamy! Windows require some specific permissions to create symbolic links, that's the reason we faced some errors. Now, we've update this PR to fallback to file creation (with a warning) when symbolic links can't be created: 
This PR is ready for re-review. Thanks again for the review! |
aswamy
left a comment
aswamy
left a comment
There was a problem hiding this comment.
Code looks great! Tiny type changes requested. Did not tophat on Windows - seems like my VM is having issues.
Co-authored-by: Alok Swamy <[email protected]>
Co-authored-by: Alok Swamy <[email protected]>
karreiro
force-pushed
the
themes-agents.md
branch
from
8bed73d to
313b9bf
Compare
Differences in type declarationsWe 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:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/public/node/fs.d.ts@@ -126,6 +126,13 @@ export declare function removeFile(path: string): Promise<void>;
* @param to - New path for the file.
*/
export declare function renameFile(from: string, to: string): Promise<void>;
+/**
+ * Creates a symbolic link.
+ *
+ * @param target - Path that the symlink points to.
+ * @param path - Path where the symlink will be created.
+ */
+export declare function symlink(target: string, path: string): Promise<void>;
/**
* Synchronously removes a file at the given path.
*
|
|
👋 @Shopify/app-inner-loop could you please take a look when you have a moment? |
3 participants
WHY are these changes introduced?
This pull request updates the
shopify theme initto consistently useAGENTS.mdfiles. For consistency and compatibility, we are keeping symlinks with each editor standard.Additionally, this pull request introduces a new "All" option to create symlinks for all editors:
WHAT is this pull request doing?
This pull request:
inittheme service to handle the feature mentioned abovecli-kitto expose the symlink creation APIHow to test your changes?
shopify theme initPost-release steps
None
Measuring impact
How do we know this change was effective? Please choose one:
Checklist