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

Remove this from VGridSkeleton props default #3341

Merged
merged 3 commits into from
Nov 13, 2023

Conversation

Ashhar-24
Copy link
Contributor

Fixes

Fixes #3268 by @Ashhar-24

Description

As mentioned in the issue #3268 that VGridSkeleton uses this in the props' default function and this causes a build error in Vue 3.
So I have moved default element count to the setup function and the numElems is replaced with elementCount in the template.

Note: if this PR is ready after #3322 is merged, this PR needs to remove the TODO from packages/eslint-plugin/src/configs/vue.ts:

    // TODO: disable after https://github.com/WordPress/openverse/issues/3268 is fixed
    "vue/no-deprecated-props-default-this": "off",

Testing Instructions

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Ashhar-24 Ashhar-24 requested a review from a team as a code owner November 12, 2023 07:23
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend labels Nov 12, 2023
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Awesome work, @Ashhar-24 !
I think the only thing that's preventing the linting step in the CI is the any in the setup call. I added a suggestion how to fix it. If the CI passes after that fix, I'll approved this PR. Otherwise I'll level another review :)

},
},
setup() {
setup(props: { numElems: any; isForTab: string; }) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
setup(props: { numElems: any; isForTab: string; }) {
setup(props) {

The types of props are defined above, and we don't need to add any type information here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the suggested changes.
But still the CI test is failing @obulat

@obulat
Copy link
Contributor

obulat commented Nov 12, 2023

You will need to run just lint and commit the changes.

@Ashhar-24
Copy link
Contributor Author

You will need to run just lint and commit the changes.

image
This is error message that i'm receiveing.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

I went ahead and committed the suggested changes, @Ashhar-24. Now it's ready to go 🚀

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the contribution @Ashhar-24!

@dhruvkb dhruvkb merged commit 9793ad3 into WordPress:main Nov 13, 2023
41 checks passed
@Ashhar-24
Copy link
Contributor Author

Thank you @obulat for your constant support.
Was nice working with the issue.

@Ashhar-24 Ashhar-24 deleted the Issue_3268 branch November 13, 2023 10:02
@Ashhar-24 Ashhar-24 restored the Issue_3268 branch November 13, 2023 10:02
@Ashhar-24 Ashhar-24 deleted the Issue_3268 branch November 13, 2023 10:02
@obulat obulat mentioned this pull request Nov 29, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Remove this from VGridSkeleton props default
4 participants