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

feat(plugin-lighthouse): add lighthouse plugin #593

Merged
merged 190 commits into from
Apr 10, 2024
Merged

Conversation

BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Mar 30, 2024

This PR includes all remaining snippets and docs to release the Lighthouse plugin.
In the process of comparing the code with the existing plugins I renamed and moved a couple of files. To get a better overview I grouped the changes as seen below.

Polish from #549:

Moving existing code:

  • introduced runner folder to encapsulate lighthouse only related logic and types

Removed code:

  • removed unused getLighthouseCliArguments function (better types and direct derivation from lighthouse made it obsolete)

New code in tests:

  • e2e tests in cli-e2e
  • covered edge case in getConfig with error
  • added unit tests to getConfig
  • changed a couple of test names to better readability and narrowed their case (mostly runner utils)

New code in logic:

  • added helper functions to create CategoryRefs
  • docs
  • installed dev dependency @types/debug for better typing
  • I implemented normalisation and refactored the incoming and forwarded flag types
  • adjust runtime error message for lighthouse plugin as it was not clear which plugin it came from
Screenshot 2024-03-31 at 15 12 12

Note

The e2e tests of compare are hard to change as they require a clean history to run. This could get discussed on how to fix it.

Followup changes:

closes #90

@BioPhoton BioPhoton requested a review from Tlacenka April 10, 2024 00:44
examples/react-todos-app/code-pushup.config.js Outdated Show resolved Hide resolved
packages/plugin-lighthouse/README.md Outdated Show resolved Hide resolved
packages/plugin-lighthouse/src/lib/runner/constants.ts Outdated Show resolved Hide resolved
packages/plugin-lighthouse/src/lib/types.ts Outdated Show resolved Hide resolved
packages/plugin-lighthouse/src/lib/lighthouse-plugin.ts Outdated Show resolved Hide resolved
matejchalk
matejchalk previously approved these changes Apr 10, 2024
Copy link
Collaborator

@Tlacenka Tlacenka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last commented changes can be done in a follow-up PR.

@BioPhoton
Copy link
Collaborator Author

The following comments will get addressed in a followup PR:

@BioPhoton BioPhoton merged commit ac5a0e2 into main Apr 10, 2024
19 checks passed
@BioPhoton BioPhoton deleted the add-lighthouse-plugin branch April 10, 2024 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🦾 CI/CD continuous integration and deployment 🧩 lighthouse-plugin 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling 🧩 utils
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement Lighthouse plugin
4 participants