Storyblok CLI - components pull --separate-files - deleted blocks are not removing respective files

[edvinasjurele]

I am not certain how components pull should work when removing old component in --separate-files mode.

Repro flow:

1. add new schema block a in CMS Block Library
2. run storyblok components pull to fetch all JSON files (observe a.json created)
3. remove schema block a in CMS Block Library
4. run same command again (⚠️ observe a.json file NOT REMOVED ⚠️ )

Should users themselves remove old schema blocks from file system when they are removing a block from space? 🤔 I am sure this should be automated and part of CLI responsibility.

[edvinasjurele]

cc @alvarosabu

[edvinasjurele]

@alvarosabu @imranolas any resolution here?

[alvarosabu]

Hey @edvinasjurele I believe the pull command does not empty the directory by default, so that's probably the cause.

Should users themselves remove old schema blocks from the file system when they are removing a block from space? 🤔 I am sure this should be automated and part of CLI responsibility.

It probably depends on which is the source of truth for the components; it is the space UI, is the local .storyblok/components folder? Would it be the expectation only to empty the directory on pull?.

Overall, I think users should be in control of the operations and not the CLI, especially for delicate operations as deletion. Probably is a good idea to add a delete command for components that allow bulk operations (delete multiple)

[edvinasjurele]

Hey, I would lean towards having the CLI remove unused blocks (though it’s ultimately your call), as this would cover scenarios where a developer removes a component in the DEVELOPMENT space, pulls components to code, and expects the file to be removed automatically.

While this functionality may not seem like a huge deal, it’s possible that a developer might forget to double-check for redundant files in git. As a result, the "deleted" component would remain removed only in the DEVELOPMENT space but could still be pushed to STAGING/PRODUCTION spaces.

I suppose this depends on how people perceive the pull command. Personally, I think of it as a command that "syncs" components with git in a 1:1 manner, rather than just stacking new ones on top without removing the old. Perhaps introducing a feature flag like --remove-unused would be a great option, allowing users to opt into the deletion cycle if they choose.

[edvinasjurele]

Ah, you just gave me a great idea for a workaround! I could essentially rm -rf my components folder first and then pull the components using the CLI command. This way, I can ensure that I only get the latest updates with files being recreated, and git would handle the rest for me.

[alexjoverm]

Closing as a resolution was reached. Thank you!