Set up new config structure and refactor lots

[calebeby]

What does this change (user-facing)?

• Primarily, it changes the configuration process. Now lighthouse-parade can be configured with a config file or via CLI options, and there are consistent validation processes for passing options either way that more rigorously check that the inputs are valid and give helpful errors when they aren't.
• Using zod for validating both the configuration file and CLI flags
• Customized error output when input is invalid (different for CLI flags and for config file)
• Allow replacing the default crawler when using a config file. This addresses #3 and other crawler-related issues requesting more specific use cases. Users can, for example, provide a CSV file with a list of URLs to crawl and write a custom getURLs that pulls in the URLs from there.
• Having a config file opens up a lot more flexibility in how lighthouse works (e.g. passing any LH option through to LH, supported in this PR) and more control over the page loading (e.g. by customizing things with puppeteer, in a future PR)

What does this change (internally)?

The CLI parsing/typechecking is rewritten. Now the schemas for most of the input types are stored in config.ts and those get pulled into cli.ts when parsing CLI flags. The same schemas are used for parsing a config file, but the errors get presented differently

The interface for a crawler was simplified and refactored, to allow the crawler to be more easily replaced with a user-created one. No more AsyncIteratorQueue.

Screenshots

Reviewing

I am mainly hoping that people can test it out and make sure that it works as expected and that any errors are helpful.

To test:

1. git clone https://github.com/cloudfour/lighthouse-parade
2. git checkout config
3. npm ci
4. npm run build
5. node dist/cli.js --help - Hopefully the help text combined with the readme is enough info but if it's not I can add to it!

Also reviewing the documentation and help text would be helpful. Preview of updated README

There is a lot of code changed in this PR, sorry. If you don't have time to do a close review that's OK! Or if you have questions or want me to summarize some changes I am happy to!

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 36d9de8039d74a7ee2a85cd4e6107aab955b0c2a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ----------------- | ----- | | lighthouse-parade | Major |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR