Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VRT scripts are confusing #67

Open
dalin- opened this issue Dec 10, 2024 · 0 comments
Open

VRT scripts are confusing #67

dalin- opened this issue Dec 10, 2024 · 0 comments

Comments

@dalin-
Copy link
Contributor

dalin- commented Dec 10, 2024

The FIRE version of the VRT scripts are confusing

The first issue is that there's so many commands

  vrt:generate-backstop-config  [vgc] Creates a basic Backstop.json for you.
  vrt:init                      [vinit] Configure your local enviroment from scratch to use VRT testing.
  vrt:local-env-config          [vlec] Alters your local enviroment so you can use backstop.
  vrt:reference                 [vref] Takes new reference screeshots from the reference URL.
  vrt:run                       [vrun] Runs your VRT testing.
  vrt:testing-setup             [vts] Setups the Testing and reference sites for VRT testing.

It's not clear which of these are 1-time things, and which are day-to-day commands. Here's some suggestions on new command names and descriptions:

  vrt:setup:init                      [vinit] Configure your Lando or Ddev config files to allow VRT testing.
  vrt:setup:local-env-config          [vlec] I HAVE NO IDEA HOW THIS IS DIFFERENT FROM THE PREVIOUS
  vrt:setup:generate-backstop-config  [vgc] Create a scaffold backstop.json that you'll then edit further.
  vrt:run:env-prepare             [vprep] Prepare the Reference and Tested environments for VRT testing, and writes a local config file.
  vrt:run:reference                 [vref] Take screenshots of the Reference environment.
  vrt:run:test                       [vtest] Take screenshots of the Tested environment, and create the final report.

Though I suspect that I'm still misunderstanding some things.

The second issue is that the old scripts did a pretty good job of giving messages at the end like "Here's how to interpret the above, including some common errors... The next step is to... " And I'm not seeing that in the commands that I ran (though maybe I ran the wrong commands because of the naming confusion).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant