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

Clean repeated static string interpolation #5261

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

tejaswarathe
Copy link
Contributor

@tejaswarathe tejaswarathe commented Dec 10, 2024

Fixes

Fixes #4980 by @sarayourfriend

Description

The changes here is to remove the repeated interpolation strings as mentioned in #4980

I have changed the method replacer() in translations.mjs which is used to replace the string with {} brackets while the pot files are converted to json for each language from Glotpress.

I have also added an object targetWords where we can add the world which we do not want to translate. Further work required is just to change the en.json5 file and change the strings like _{github}_ to _{'github'}_ and adding that string to targetWords object. This will make sure that the translations also will keep the string within single quotes ('') to consider them as string literal.

Currently the changes have only been done for openverse string.

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 (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where 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.

@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Dec 10, 2024
@obulat obulat 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 and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Dec 10, 2024
@obulat obulat changed the title Issue 4980 clean repeated static string interpolation Clean repeated static string interpolation Dec 10, 2024
@obulat
Copy link
Contributor

obulat commented Dec 18, 2024

Hi @tejaswarathe! Great work on this PR! Is anything blocking you? It seems that you only need to run lint. Let us know if you need any help with anything.

@tejaswarathe
Copy link
Contributor Author

Hi @tejaswarathe! Great work on this PR! Is anything blocking you? It seems that you only need to run lint. Let us know if you need any help with anything.

Hi @obulat, Yes I was stuck with the same lint issue and was also travelling for past few days. Will check again today to fix it and push changes.

@tejaswarathe tejaswarathe marked this pull request as ready for review December 21, 2024 13:32
@tejaswarathe tejaswarathe requested a review from a team as a code owner December 21, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 🧱 stack: frontend Related to the Nuxt frontend
Projects
Status: 👀 Needs Review
Development

Successfully merging this pull request may close these issues.

Clean up repeated static-string interpolations
3 participants