tatethurston/TwirpScript

package.json Commands Broken

arranf opened this issue · 3 comments

arranf commented

After checking out and cloning the repo the following commands seem to be broken:

  • examples:check
  • examples:gen
  • test:e2e

Also the examples seem to depend on the current published version of the package as opposed to the current version of the package in the repo which might lead to some bugs going undetected. I'm not an expert at how to link the examples to the package but if they could be linked then we might be able to run the examples as a soft sort of E2E test.

tatethurston commented

Hey @arranf these commands actually all depend on the test:e2e:prepare command.This npm links a local build instead of pulling the published version of the package. I recognize this is currently undocumented.

There is a good deal of test coverage I'm planning to backfill. I'm not sure that I want to promote these to E2E tests, they are a bridge solution for testing gaps, but I would prefer more targeted tests.

yarn test:e2e:prepare
yarn examples:check

arranf commented

@tatethurston That makes sense!
I'll take a stab at running these commands - it might be worth briefly outlining these in the README?

tatethurston commented

I created examples:setup and test:e2e:setup which are hopefully a bit more discoverable. These are also fully automated, which is an improvement over the previous approach.