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

WebExtension tweaks for Safari and Manifest V3 #17532

Merged
merged 4 commits into from Aug 23, 2022

Conversation

xeenon
Copy link
Contributor

@xeenon xeenon commented Aug 23, 2022

  • Add better version specific notes for Safari support.
  • Add Safari 16 version support for runtime.getFrameId and drop STP reference.
  • Add more consistent manifest version availability notes.
    • Features that are dropped in V3 noted as "Manifest V2 only".
    • Features that are added in V3 noted as "Manifest V3 or later" to avoid prematurely limiting to V3 when future versions are supported.
    • Features that are dropped in V3 by some browsers but are supported in full in others still noted as "Manifest V2 or later".
  • More consistent use of required/optional instead of mandatory.

@github-actions github-actions bot added the data:webext 🎲 Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions label Aug 23, 2022
@xeenon xeenon force-pushed the safari-extension-tweaks branch 4 times, most recently from e340e37 to 39bfa2b Compare August 23, 2022 20:30
@xeenon
Copy link
Contributor Author

xeenon commented Aug 23, 2022

@queengooborg let me know if this is okay, or if there are somethings I should do differently.

@queengooborg
Copy link
Collaborator

Throughout MDN, the terms "required" and "optional" are used more frequently than "mandatory" -- could we keep using the term "required" and replace "not required"/"not mandatory" with optional?

},
{
"version_added": "42",
"alternative_name": "applications",
Copy link
Contributor Author

@xeenon xeenon Aug 23, 2022

Choose a reason for hiding this comment

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

This alternative_name was a dummy entry to allow per-version notes here. I removed it to avoid confusion.

Copy link
Collaborator

@queengooborg queengooborg left a comment

Choose a reason for hiding this comment

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

Thanks for tackling this! While we're here, let's also tweak some of the wording to follow the typical formula for notes:

webextensions/manifest/browser_specific_settings.json Outdated Show resolved Hide resolved
webextensions/manifest/theme.json Outdated Show resolved Hide resolved
* Features that are dropped in V3 noted as "Manifest V2 only".
* Features that are added in V3 noted as "Manifest V3 or later" to avoid prematurely limiting to V3 when future versions are supported.
* Features that are dropped in V3 by some browsers but are supported in full in others still noted as "Manifest V2 or later".
Copy link
Collaborator

@queengooborg queengooborg left a comment

Choose a reason for hiding this comment

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

Thank you, this is LGTM!

@xeenon
Copy link
Contributor Author

xeenon commented Aug 23, 2022

Rebased and ready to merge when you can, thanks @queengooborg!

@queengooborg
Copy link
Collaborator

By the way, no need to rebase and force push for BCD PRs -- we squash merge all pull requests to this repository!

@queengooborg queengooborg merged commit 68cb7e9 into mdn:main Aug 23, 2022
@xeenon xeenon deleted the safari-extension-tweaks branch August 23, 2022 21:48
Comment on lines -24 to +18
],
"firefox": {
"version_added": "42",
"notes": "Before Firefox 48, this property was required."
},
Copy link
Member

Choose a reason for hiding this comment

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

Why has this been changed? This breaks some of our tools and it took me a while to figure that out since it is not mentioned anywhere in the changelog. This patch is for Safari, it would have been good to not change Firefox data or to move these changes to a separate issue/PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This PR is actually for Manifest V3 entirely as well, and if you look at the diff, you'll notice that this is simply consolidating the statements together to adhere to the typical structure of BCD (where a behavioral difference that only applies to one browser should be a single note, rather than two separated statements).

We apologize in advance for the changes causing an issue with your tooling; however, please do note that features may be added, removed or modified at any time to match developer interest, BCD data guidelines, or for better accuracy, as explained in the Semantic versioning policy. In other words, changes such as this are expected to happen in any release and will not result in any changelog notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:webext 🎲 Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants