Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Typescriptify VModal components #1926

Merged
merged 3 commits into from Nov 8, 2022
Merged

Typescriptify VModal components #1926

merged 3 commits into from Nov 8, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 20, 2022

Fixes

Fixes #1925 by @obulat

Description

This PR converts JSDoc types to TS syntax, and adds the VModal directory to tsconfig.json

Testing Instructions

The types step of CI should pass.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.

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.

@obulat obulat requested a review from a team as a code owner October 20, 2022 05:38
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Oct 20, 2022
@github-actions
Copy link

github-actions bot commented Oct 20, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1926
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1926/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🟩 priority: low Low priority and doesn't need to be rushed 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Oct 20, 2022
@github-actions
Copy link

github-actions bot commented Oct 20, 2022

Size Change: -7.47 kB (-1%)

Total Size: 808 kB

Filename Size Change
./.nuxt/dist/client/227.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/227.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/228.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 128 kB -3.42 kB (-3%)
./.nuxt/dist/client/app.modern.js 119 kB -3.6 kB (-3%)
./.nuxt/dist/client/commons/app.js 88.2 kB +16 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB -36 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.41 kB -18 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB -16 B (0%)
./.nuxt/dist/client/components/v-external-search-form.js 3.08 kB -26 B (-1%)
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB -22 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.js 2.55 kB -22 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB -23 B (-1%)
./.nuxt/dist/client/components/v-no-results.js 2.75 kB -24 B (-1%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB -22 B (-1%)
./.nuxt/dist/client/components/v-search-grid.js 5.42 kB -25 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.39 kB -21 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB -27 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.7 kB -26 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.23 kB -53 B (-1%)
./.nuxt/dist/client/runtime.js 2.62 kB -60 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.63 kB -58 B (-2%)
./.nuxt/dist/client/vendors/app.modern.js 56.5 kB -22 B (0%)
./.nuxt/dist/client/214.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/214.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/215.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 744 B -1 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 751 B +1 B (0%)
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.76 kB +2 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.73 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.02 kB -3 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 356 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 359 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB +1 B (0%)
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -2 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-audio-track.js 5.12 kB +2 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.07 kB +6 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.js 537 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 541 B 0 B
./.nuxt/dist/client/components/v-bone.js 685 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 690 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-page.js 467 B +1 B (0%)
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 776 B -2 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 B +1 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB +4 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB -4 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 999 B -2 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 999 B 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.5 kB -3 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.48 kB +1 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.js 748 B +4 B (+1%)
./.nuxt/dist/client/components/v-dmca-notice.modern.js 752 B -1 B (0%)
./.nuxt/dist/client/components/v-error-image.js 1.69 kB +2 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB +3 B (0%)
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B -1 B (0%)
./.nuxt/dist/client/components/v-full-layout.js 1.49 kB -1 B (0%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.49 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB -1 B (0%)
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-details.js 1.44 kB 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-grid.js 2.53 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB +1 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 521 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 525 B 0 B
./.nuxt/dist/client/components/v-load-more.js 790 B +1 B (0%)
./.nuxt/dist/client/components/v-load-more.modern.js 682 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 799 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 808 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB -1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 kB -1 B (0%)
./.nuxt/dist/client/components/v-media-tag.js 430 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB +1 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB -3 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.24 kB +2 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.1 kB +2 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB +2 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.js 966 B +1 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB -1 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB +6 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 813 B -1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 0 B
./.nuxt/dist/client/components/v-search-results-title.js 658 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 651 B +1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 795 B +2 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 769 B +2 B (0%)
./.nuxt/dist/client/components/v-server-timeout.js 298 B -2 B (-1%)
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 996 B -1 B (0%)
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 895 B -1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.js 889 B +1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 892 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 302 B 0 B
./.nuxt/dist/client/pages/about.js 1.06 kB +1 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.07 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.89 kB -1 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.73 kB +3 B (0%)
./.nuxt/dist/client/pages/external-sources.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.24 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 7.24 kB +4 B (0%)
./.nuxt/dist/client/pages/index.js 5 kB -1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.86 kB +3 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -1 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB -3 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.54 kB +1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search.js 2.75 kB -1 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.59 kB 0 B
./.nuxt/dist/client/pages/search/audio.js 1.19 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.19 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.79 kB +5 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.97 kB +2 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB 0 B
./.nuxt/dist/client/pages/search/model-3d.js 243 B +2 B (+1%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B +1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.js 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B -1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.44 kB -3 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB +2 B (0%)
./.nuxt/dist/client/vendors/app.js 57.2 kB 0 B

compressed-size-action

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.

No blocking comments, but 1 nit and a 1 question.

@@ -29,11 +32,11 @@ import { defineComponent } from '@nuxtjs/composition-api'
import VLogoLoader from '~/components/VLogoLoader/VLogoLoader.vue'
import VButton from '~/components/VButton.vue'

import OpenverseLogoText from '~/assets/icons/openverse-logo-text.svg?inline'
import OpenverseLogoText from '~/assets/icons/openverse-logo-text.svg'
Copy link
Member

Choose a reason for hiding this comment

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

I don't remember if there was a specific reason we are getting rid of ?inline. But this is leading to the SVG tag being duplicated in both the SVG file and in the HTML.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wrote about the reasons in this issue: https://github.com/WordPress/openverse-frontend/issues/1715.
I haven't noticed the duplication, I'll look into it, thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see the SVG tag duplication, @dhruvkb:
Screen Shot 2022-10-27 at 9 23 40 PM

tsconfig.json Outdated Show resolved Hide resolved
@openverse-bot
Copy link
Contributor

Based on the low urgency of this PR, the following reviewers are being gently reminded to review this PR:

@zackkrida
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was updated 5 day(s) ago. PRs labelled with low urgency are expected to be reviewed within 5 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM! Glad to see this one finally converted. Nice work getting through all of its dependencies 🥳

Openverse PRs automation moved this from Needs review to Reviewer approved Nov 8, 2022
@obulat obulat merged commit 43ac3de into main Nov 8, 2022
Openverse PRs automation moved this from Reviewer approved to Merged! Nov 8, 2022
@obulat obulat deleted the tsify_modal_content branch November 8, 2022 06:53
github-actions bot pushed a commit that referenced this pull request Nov 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

Add types to VModal components
4 participants