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

refactor(locale): unfreeze arrays #2928

Merged
merged 2 commits into from
Jun 3, 2024
Merged

refactor(locale): unfreeze arrays #2928

merged 2 commits into from
Jun 3, 2024

Conversation

Shinigami92
Copy link
Member

closes #2890

@Shinigami92 Shinigami92 added c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent labels May 27, 2024
@Shinigami92 Shinigami92 added this to the v9.0 milestone May 27, 2024
@Shinigami92 Shinigami92 self-assigned this May 27, 2024
@Shinigami92 Shinigami92 requested a review from a team as a code owner May 27, 2024 15:46
Copy link

netlify bot commented May 27, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 0f58f5a
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/665c7582f46a7a000878d833
😎 Deploy Preview https://deploy-preview-2928.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Shinigami92 Shinigami92 added the m: science Something is referring to the science module label May 27, 2024
Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (a082ed2) to head (0f58f5a).

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2928      +/-   ##
==========================================
- Coverage   99.95%   99.95%   -0.01%     
==========================================
  Files        2986     2986              
  Lines      215926   215926              
  Branches      598      945     +347     
==========================================
- Hits       215839   215833       -6     
- Misses         87       93       +6     
Files Coverage Δ
src/locales/en/science/chemical_element.ts 100.00% <100.00%> (ø)
src/locales/en/science/unit.ts 100.00% <100.00%> (ø)
src/locales/eo/science/chemical_element.ts 100.00% <100.00%> (ø)
src/locales/eo/science/unit.ts 100.00% <100.00%> (ø)
src/locales/nb_NO/science/chemical_element.ts 100.00% <100.00%> (ø)
src/locales/nb_NO/science/unit.ts 100.00% <100.00%> (ø)
src/locales/pl/science/chemical_element.ts 100.00% <100.00%> (ø)
src/locales/pl/science/unit.ts 100.00% <100.00%> (ø)
src/locales/zh_CN/science/chemical_element.ts 100.00% <100.00%> (ø)
src/locales/zh_CN/science/unit.ts 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

@ST-DDT ST-DDT requested review from a team May 27, 2024 15:55
@xDivisionByZerox
Copy link
Member

xDivisionByZerox commented May 27, 2024

Multiple questions from my side:

  1. Although the title's humor is appreciated, could we consider revising it to more accurately reflect the content of the change? This would enhance the final result of the autogenerated changelog.
  2. I'd consider this change a refactor over a chore given the potential side-effects during runtime. Would you agree?
  3. While these changes are not breaking, I believe it would be prudent to include a note in the migration guide for v9, informing developers that all our locale data will be mutable in future versions. Providing developers with advance notice may prevent frustration and avoidable inquiries. What do you think?

@Shinigami92 Shinigami92 changed the title chore: unfreeeeeeze 🥶 refactor(locale): unfreeze arrays May 27, 2024
@Shinigami92 Shinigami92 added c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs c: locale Permutes locale definitions and removed c: chore PR that doesn't affect the runtime behavior labels May 27, 2024
@Shinigami92
Copy link
Member Author

  1. Although the title's humor is appreciated, could we consider revising it to more accurately reflect the content of the change? This would enhance the final result of the autogenerated changelog.

done

  1. I'd consider this change a refactor over a chore given the potential side-effects during runtime. Would you agree?

done

  1. While these changes are not breaking, I believe it would be prudent to include a note in the migration guide for v9, informing developers that all our locale data will be mutable in future versions. Providing developers with advance notice may prevent frustration and avoidable inquiries. What do you think?

not sure, maybe we want to discuss? I think unfreeze wont affect the end-user in any way
If it would be the opposite (freezing objects) then it would have a potential negative effect if user did modify the objects

@Shinigami92 Shinigami92 merged commit badaa6d into next Jun 3, 2024
23 checks passed
@Shinigami92 Shinigami92 deleted the chore-unfreeze-locale branch June 3, 2024 19:22
eLoyyyyy pushed a commit to eLoyyyyy/faker that referenced this pull request Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: locale Permutes locale definitions c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs m: science Something is referring to the science module p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check whether complex objects should be frozen
3 participants