Skip to content

docs(examples-plugins): add example plugin file-size #315

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 48 commits into from
Dec 2, 2023
Merged

docs(examples-plugins): add example plugin file-size #315

merged 48 commits into from
Dec 2, 2023

Conversation

@BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Nov 24, 2023 •
edited
Loading

This PR includes:

  • add project example-plugins
  • add project & lint;test targets
    • add memfs constant to @code-pushup/testing-utils
  • add file size plugin
    • add unit tests
    • add integration tests

@BioPhoton BioPhoton added 📖 Project documentation improvements or additions to the project documentation 🦾 CI/CD Continuous integration and deployment and removed 🦾 CI/CD Continuous integration and deployment labels Nov 24, 2023
@BioPhoton BioPhoton self-assigned this Nov 24, 2023
@vmasek
Copy link
Collaborator

vmasek commented Nov 25, 2023

Good example 👍🏻

@BioPhoton BioPhoton marked this pull request as ready for review November 25, 2023 15:31
@BioPhoton BioPhoton requested a review from matejchalk November 25, 2023 16:10
@BioPhoton BioPhoton changed the title docs: example plugin file size docs(example-plugins): add example plugin file-size Nov 28, 2023
@BioPhoton BioPhoton changed the title docs(example-plugins): add example plugin file-size docs(examples-plugins): add example plugin file-size Nov 28, 2023
@BioPhoton BioPhoton requested a review from matejchalk November 29, 2023 13:50
Tlacenka
Tlacenka reviewed Nov 29, 2023
View reviewed changes
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.

Overall I think you did a great job.

Most of my feedback is regarding helper variables. Ideally, one would read the test top to bottom and understand the values used without the need to scroll up or look up the value of a variable. The main value of test comes from its readability and maintainability. As tests are independent of each other, as long as within one test the value is consistent, it is fine to use hardcoded values.

BioPhoton and others added 4 commits November 30, 2023 19:27
matejchalk
matejchalk reviewed Nov 30, 2023
View reviewed changes
@BioPhoton BioPhoton requested a review from matejchalk December 1, 2023 16:58
matejchalk
matejchalk previously approved these changes Dec 1, 2023
View reviewed changes
@BioPhoton @matejchalk
Update testing-utils/src/lib/setup/fs.mock.ts
38b2940 
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
@BioPhoton BioPhoton merged commit 0d6feb2 into main Dec 2, 2023
@BioPhoton BioPhoton deleted the example-plugin-file-size branch December 2, 2023 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matejchalk matejchalk matejchalk approved these changes

+1 more reviewer

@Tlacenka Tlacenka Tlacenka left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@BioPhoton BioPhoton

Labels

🧩 core 🧩 models 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 utils

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@BioPhoton @vmasek @Tlacenka @matejchalk