blockly-samples icon indicating copy to clipboard operation
blockly-samples copied to clipboard

usability of migrate script

Open maribethb opened this issue 2 years ago • 0 comments

Category

  • Plugins

Component

migrate

Is your feature request related to a problem? Please describe.

Trying to use the migrate script as someone who doesn't know how it works is a bit confusing:

  • The README is light on details
  • You have to run two layers of --help when you run the command. it might not be obvious you can do @blockly/migrate fix-imports --help to get additional help content
  • not enough information about how to specify files
  • trial and error to figure out what kinds of wildcards are supported
  • it's complicated to specify "recursively do everything in this directory" as you need multiple layers of wildcards
  • you can't just pass a directory name
  • if you don't use a wildcard and no files are affected, you just get no output which is confusing

Describe the solution you'd like

  • Add more information to the README (specifically about using the in-place flag)
  • accept a directory and work on all files in that directory. consider adding a -r flag to recursively work on all (js and ts) files in all subdirectories as well
  • print a message if no files have been affected

Describe alternatives you've considered

Additional context

maribethb avatar Nov 02 '22 19:11 maribethb