Shopify / themekit

Shopify theme development command line tool.
https://shopify.dev/tools/theme-kit
MIT License
1.2k stars 375 forks source link

Checksum checking feature has very verbose logging #789

Closed romainmenke closed 4 years ago

romainmenke commented 4 years ago
processing ....
Skipped ... (Checksum: ...)

Can these logs be behind the verbose flag?

tanema commented 4 years ago

Hi @romainmenke, when opening an issue, can you please provide more information on both what you are doing, what commands you are running and what you expect, like the template requests? This benefits both of us so that I do not need to ask so many follow up questions.

As for this issue, I cannot tell because you have not shown us an actual log but you may be running the theme watch command. If this is so, I do not think we will be removing it because we need to indicate that themekit is not just frozen and has taken action accordingly from actions of the developer.

romainmenke commented 4 years ago

Thank you for the follow up.

This indeed happens when first running the watch command. I understand wanting to give feedback during this process but for example the download already logs differently.

A less verbose option would be to follow the already existing functionality of showing a progress bar :

104|104 [==============================================================]  100 %
tanema commented 4 years ago

How would a progress bar work for watch, a command the has nothing to do unless you do something. And then when you do something it uploads a single file. A progress bar is meaningless in this context.

The output of the watch command is consistent with other tools that have similar behaviour

romainmenke commented 4 years ago

Looked through the source code it seems to be the result of how the file watcher polling works. The watcher (github.com/radovskyb/watcher) keeps an in memory state of when a file was last modified. On the first run this state is missing and emits a first series of events ,causing the theme watch command to log once for each file.

Looking at it more closely I do not think a distinction can be made between these initial events and actual file change events.

Just to clarify :

I have absolutely no issue with logging actual events during the watching process. It are the initial logs when starting the command that bug me.

This seemed an obvious issue to me and I did not take the time to fully explain my case.

romainmenke commented 4 years ago

Closing this.

Thank you your feedback :)