-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
fix(config): typo in unsafeInlineCompatibility
name
#6583
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #6583 +/- ##
===========================================
+ Coverage 64.73% 95.86% +31.13%
===========================================
Files 78 78
Lines 2705 2709 +4
Branches 699 700 +1
===========================================
+ Hits 1751 2597 +846
+ Misses 759 97 -662
+ Partials 195 15 -180
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change for users who are using unsafeInlineCompatiblity
, we can change it in major release or normalize unsafeInlineCompatiblity
to unsafeInlineCompatiblity
with a warning message
@PedroD Example how you could do that: https://github.com/nuxt/nuxt.js/pull/4674/files |
Ok, allow me some time, I'll try to implement this. |
…rder to avoid breaking-changes (displaying an alert), but also allowing the correct name `unsafeInlineCompatibility` to be used. Introduced TODO comments/notes that should be resolved before the release of Nuxt 3.
Please take a look if the changes I made are ok. So Nuxt should allow the usage of both old and new property names. When the developer uses the old name, an alert message appears. I created tests to make sure both names are supported, thus making this PR non-breaking. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM,could you open a pr for changing doc as well? Thanks🙏
@clarkdo I think the doc was already updated accordingly, please take a look here: nuxt/docs#1650 How can I link this PR to the existing doc PR? |
Great, thanks |
I found that the problematic file comes from this PR (#6586). The linter also failed in there: https://circleci.com/gh/nuxt/nuxt.js/56629?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link I can try and fix the issue still on the scope of this PR (if I still have permissions after the merge attempt), or this should be done in the original PR? Or in a new PR at all? |
Fixed |
unsafeInlineCompatibility
name
Replacing all occurrences of
unsafeInlineCompatiblity
tounsafeInlineCompatibility
(notice the missing "i" in "Compatibility".Types of changes
Edit: Removed the [x] from "Breaking change", as it is now a non-breaking typo fix.
Description
Just fixing a minor typo that can create confusion when typing this property (correctly) from memory. This can lead to wasted time in debugging a wrong property name.
Replacing all occurrences of
unsafeInlineCompatiblity
tounsafeInlineCompatibility
.Note: This can cause all apps using the old property name to stop working!
Checklist: