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

Fix lint staged to match pnpm:fix order and settings #1761

Merged
merged 4 commits into from
Aug 31, 2022

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented Aug 30, 2022

Fixes

Fixes #1658 by @dhruvkb

Description

Fixes a discrepancy between pnpm lint:fix and our precommit linting script. Now they run eslint and prettier formatting in the same order with the same settings.

@zackkrida zackkrida requested a review from a team as a code owner August 30, 2022 16:35
@zackkrida zackkrida requested review from obulat and dhruvkb August 30, 2022 16:35
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Aug 30, 2022
@github-actions
Copy link

github-actions bot commented Aug 30, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1761
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1761/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.

@zackkrida zackkrida changed the title Fix lint staged to max pnpm:fix order and settings Fix lint staged to match pnpm:fix order and settings Aug 30, 2022
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Aug 31, 2022
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 couldn't resist looking more into this situation :)

Since we are already running prettier --write, we do not need eslint to check for prettier errors (and un-do the prettier fixes while doing that!). We can actually fix this whole thing if we add "prettier/prettier": "off" to the rules in .eslintrc.js.

Also, I re-arranged the commands in this file locally:

{
  "*.{json,yml,yaml,mdx,md}": "prettier --write",
  "*.{ts,js,vue}": ["prettier --write", "eslint --ext .js,.vue,.ts --ignore-path .gitignore --ignore-path .eslintignore --max-warnings=0 ."],
}

If two commands are in a bracketed list, they are executed sequentially. The two separate commands in this object are executed at the same time.

And tried committing the VSkipToContainer file with the wrong order of classes:
class="ms-2 z-50 mt-2 focus:fixed focus:absolute".
lintstaged first ran prettier and fixed the class order to the correct class="z-50 mt-2 ms-2 focus:fixed focus:absolute", and then eslint did not undo it. So, husky said that it's an empty commit and refused to commit it :)

Co-authored-by: Olga Bulat <obulat@gmail.com>
@zackkrida
Copy link
Member Author

Fantastic, thanks @obulat! I implemented your suggestions.

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.

LGTM!

@zackkrida zackkrida requested a review from krysal August 31, 2022 11:39
@github-actions
Copy link

Size Change: -381 B (0%)

Total Size: 768 kB

Filename Size Change
./.nuxt/dist/client/235.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/235.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/236.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 110 kB -185 B (0%)
./.nuxt/dist/client/app.modern.js 102 kB -181 B (0%)
./.nuxt/dist/client/233.js 273 B +273 B (new file) 🆕
./.nuxt/dist/client/233.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/234.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 87.8 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 76.7 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 746 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 751 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 508 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 512 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 4.13 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 4.01 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 344 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 349 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.66 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.65 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 4.55 kB 0 B
./.nuxt/dist/client/components/v-audio-track.modern.js 4.51 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 570 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 575 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.19 kB 0 B
./.nuxt/dist/client/components/v-box-layout.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.06 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 763 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 773 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.78 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.59 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 2.94 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 2.91 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.4 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.38 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 743 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 375 B 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.55 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB 0 B
./.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 0 B
./.nuxt/dist/client/components/v-image-grid.js 2.57 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.46 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 923 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 918 B 0 B
./.nuxt/dist/client/components/v-load-more.js 815 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 715 B 0 B
./.nuxt/dist/client/components/v-media-license.js 801 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 809 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.03 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.03 kB 0 B
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.js 2.94 kB 0 B
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.modern.js 2.91 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 429 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 433 B 0 B
./.nuxt/dist/client/components/v-meta-search-form.js 2.7 kB 0 B
./.nuxt/dist/client/components/v-meta-search-form.modern.js 2.66 kB 0 B
./.nuxt/dist/client/components/v-meta-source-list.js 2.06 kB 0 B
./.nuxt/dist/client/components/v-meta-source-list.modern.js 2.02 kB 0 B
./.nuxt/dist/client/components/v-modal.js 875 B 0 B
./.nuxt/dist/client/components/v-modal.modern.js 876 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.27 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.23 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.24 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.14 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 3.02 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 965 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 964 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.72 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.73 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 804 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 809 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.06 kB 0 B
./.nuxt/dist/client/components/v-search-grid.modern.js 4.99 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 673 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 666 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 831 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.modern.js 820 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 991 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 892 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 888 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 891 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 977 B 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 983 B 0 B
./.nuxt/dist/client/components/v-sources-table.js 14.3 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 14.3 kB 0 B
./.nuxt/dist/client/components/v-tab-panel.js 689 B 0 B
./.nuxt/dist/client/components/v-tab-panel.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-tab.js 1.73 kB 0 B
./.nuxt/dist/client/components/v-tab.modern.js 1.71 kB 0 B
./.nuxt/dist/client/components/v-tabs.js 779 B 0 B
./.nuxt/dist/client/components/v-tabs.modern.js 766 B 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.05 kB -2 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.06 kB -1 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 6.42 kB 0 B
./.nuxt/dist/client/pages/audio/_id.modern.js 6.26 kB 0 B
./.nuxt/dist/client/pages/feedback.js 3.23 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.2 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 7.05 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 6.83 kB +1 B (0%)
./.nuxt/dist/client/pages/index.js 5.09 kB +1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.97 kB -2 B (0%)
./.nuxt/dist/client/pages/meta-search.js 1.67 kB 0 B
./.nuxt/dist/client/pages/meta-search.modern.js 1.67 kB 0 B
./.nuxt/dist/client/pages/preferences.js 1.28 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.27 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.54 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB -1 B (0%)
./.nuxt/dist/client/pages/search.js 2.72 kB 0 B
./.nuxt/dist/client/pages/search.modern.js 2.56 kB -1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 2.86 kB 0 B
./.nuxt/dist/client/pages/search/audio.modern.js 2.75 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.96 kB 0 B
./.nuxt/dist/client/pages/search/image.modern.js 2.83 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.js 816 B +1 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 733 B 0 B
./.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./.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 0 B
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/runtime.js 2.7 kB -7 B (0%)
./.nuxt/dist/client/runtime.modern.js 2.71 kB -6 B (0%)
./.nuxt/dist/client/vendors/app.js 47.8 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 47.1 kB 0 B

compressed-size-action

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

So glad the root cause was found! 🥳

@zackkrida zackkrida merged commit 8cd2728 into main Aug 31, 2022
@zackkrida zackkrida deleted the fix-linting-discrepancies branch August 31, 2022 19:15
github-actions bot pushed a commit that referenced this pull request Aug 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prettier works differently for directory and single file
4 participants