Add --playwright & --cypress flags

[tmeasday]

When set, build storybook by directly invoking the binary from @chromaui/test-archiver.

This is a POC, we will move this binary into a chromatic-playwright package soon.

TODO:

• Add cypress flag too
• Ensure the flag works in the action
• Throw errors if incompatible flags are used
• Tests

Some notes:

• This won't work if you symlink the chromatic package into a test project (due to symlinking and resolution). Probably just use the canary to test it out ([email protected])

• For this to work in it's current form, you need to add the following export to the @chromaui/archive-storybook package.json:exports field:

    "./package.json": {
      "require": "./package.json",
      "import": "./package.json"
    }

I did this manually inside node_modules of my test project for now.

For some reason I couldn't require.resolve('@chromaui/archive-storybook') directly. @ndelangen may know more about this.

• We'll want to resolve things in chromatic-playwright really, so we'd be adding the export to that package once we setup the monorepo.

• This calls node path/to/@chromaui/archive-storybook/dist/bin/build-archive-storybook.js -o ..., which then calls node path/to/@storybook/cli/dist/bin/storybook.js -c path/to/config. There might be a way to avoid the double node invocation. Then again, it's probably not a big deal.

📦 Published PR as canary version: 10.6.0--canary.882.7635273249.0

✨ Test out this PR locally via:

npm install [email protected]
# or 
yarn add [email protected]

[ndelangen]

You can simplify:

    "./package.json": {
      "require": "./package.json",
      "import": "./package.json"
    }

to:

    "./package.json": "./package.json"

[tmeasday]

@ndelangen do you know why I could require.resolve() @chromaui/archive-storybook/package.json but not @chromaui/archive-storybook, given there is a exports field already containing '.'?

https://github.com/chromaui/archive-storybook/blob/26a2269c17b10ecf693d74c296b8254b1ece807c/package.json#L14-L20

[ndelangen]

No, it should resolve to the full require path from here:
https://github.com/chromaui/archive-storybook/blob/main/package.json#L16C8-L16C36

So the outcome would be:
/path/to/node_modules/@chromaui//archive-storybook/dist/index.js

What error did you get? "could not resolve"?

[tmeasday]

Yes, the standard MODULE_NOT_FOUND that we check for in this PR.

[tmeasday]

@tevanoff are you good with me merging this?

[tevanoff]

If we're going to cut 1.0.0 versions of these when we go GA, we might want to include that here.

[tmeasday]

OK, we can do that. It'll still be possible to test (with incorrect versions) against the current versions if we do that, but it'll warn in some package managers, and error in npm: https://www.notion.so/chromatic-ui/Peer-Dependency-Investigations-ae77792bae6e420bbe860916bec10cbe?pvs=4#176332d500194cdfacadf1efd927c815

[tmeasday]

Oh, I misinterpreted, you mean to have both versions supported 👍

[tevanoff]

Left one suggestion on the peer deps, but otherwise looks good!

[tmeasday]

QA-ed on my test app w/ [email protected] and works well. The only issue I found was that because I had no scripts at all in my package.json, so I made this change: 42d2d2b

[ghengeveld]

🚀 PR was released in v10.5.0 🚀