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

Refine configurations for the vue-i18n eslint plugin #1252

Merged
merged 9 commits into from
Apr 11, 2022

Conversation

krysal
Copy link
Member

@krysal krysal commented Apr 8, 2022

Fixes

Related to #1160 by @sarayourfriend

Description

This PR:

  • makes the i18n plugin ignore raw texts in test files, we don't need to check that rule there so this will get us rid of the recurring warnings
  • makes this rule check to error 🔴 instead of warning
  • deletes some comments for eslint exceptions as we can centralize specific texts to ignore from the eslint config file 🔥

It builds on top of #1239 that fixes the lint and lint:fix commands.

Testing Instructions

Look at the Files changed tab of this PR and observe there are no warnings annotations. Try adding raw text different to brand names in templates, then run pnpm lint and observe the error is announced.

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.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • [N/A] 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.

@krysal krysal added 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Apr 8, 2022
@krysal krysal self-assigned this Apr 8, 2022
@krysal krysal requested a review from a team as a code owner April 8, 2022 17:12
@krysal krysal requested review from obulat and dhruvkb April 8, 2022 17:12
Comment on lines +168 to +174
// Brand names that should not be translated
'Common Crawl',
'Creative Commons',
'Europeana',
'Flickr',
'Openverse',
'WordPress',
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice! This is a great find.

@sarayourfriend
Copy link
Contributor

@krysal I just found out about the --max-warnings option for eslint, we can pass it as --max-warnings=0 in the lint script and in the lint-staged script to prevent any warnings from sneaking into committed code without having to update the eslint configuration to change all the warnings to errors.

How do you feel about adding that to this PR (or to the base branch for this PR)? That way we can close #1160.

Base automatically changed from fix_lint_fix_command to main April 11, 2022 14:15
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 love how cleaner the right side of the diff looks, @krysal ! Thank you for fixing this.

@krysal
Copy link
Member Author

krysal commented Apr 11, 2022

Great find @sarayourfriend! Added in 133c471.

@krysal krysal merged commit 3fab476 into main Apr 11, 2022
@krysal krysal deleted the improv/eslint-plugin-vue-i18n-rules branch April 11, 2022 23:11
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: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants