Fix #38690: Explain persistence of registered content scripts across browsers #38746
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### **Extended Commit Description:** This update improves the documentation for the `registerContentScripts` method by explicitly clarifying the persistence behavior of registered content scripts across different browsers. #### **Changes made:** - Added a **Persistence of Registered Scripts** section under **Return Value** to describe how long scripts remain registered in **Firefox** and **Chrome**. - Explained that in **Firefox**, registered scripts are **removed when the extension is unloaded or reloaded**. - Clarified that in **Chrome**, registered scripts **persist across restarts** if `persistAcrossSessions: true`, but **are unregistered when the extension is updated**. - Highlighted the role of the `persistAcrossSessions` property in controlling script persistence. #### **Why this change?** - The previous documentation did not explicitly state how long registered scripts persist. - There was confusion regarding **browser-specific behaviors**, leading to inconsistencies in developer expectations. - Ensures that developers using the `scripting.registerContentScripts` API fully understand its behavior in **both Firefox and Chrome**. This fix references [MDN GitHub Issue mdn#38690 ](mdn#38690) and improves the clarity of the API documentation.
github-actions
bot
added
Content:WebExt
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Comment on lines
36
to
37
| > [!NOTE] | ||
| > **Persistence of Registered Scripts:** |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| > [!NOTE] | |
| > **Persistence of Registered Scripts:** | |
| > [!NOTE] > **Persistence of Registered Scripts:** | |
| > |
|
Preview URLs (comment last updated: 2025-03-21 19:17:04) |
### **Extended Commit Description** This update fixes a syntax issue in the YAML front matter of the `index.md` file for `registerContentScripts`. The issue was caused by parentheses `()` in the `title` field, leading to a **SyntaxError: Unexpected token** during the CI checks. #### **Changes made:** - Removed parentheses `()` from the `title` field in the YAML front matter. - Updated the title from: ```yaml title: scripting.registerContentScripts() ``` to ```yaml title: scripting.registerContentScripts ```
### **Extended Commit Description** This update fixes **code style issues** in the `index.md` file by applying **Prettier formatting** to ensure compliance with MDN’s documentation standards. The CI checks failed due to **formatting inconsistencies**, and this commit resolves those issues. #### **Changes made:** - **Ran Prettier to format `index.md`** and fix all linting issues. - Ensured that the file follows **MDN’s code style guidelines**. - Addressed **all CI linting failures** that were blocking the PR merge. #### **Why this change?** - The CI logs indicated **formatting issues** in `index.md`:
|
Thanks for the update! And it seems that Firefox will also unregister the script after the extension update, same as Chrome.
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extended Commit Description
This update improves the documentation for the
registerContentScriptsmethod by explicitly clarifying the persistence behavior of registered content scripts across different browsers.Changes made:
persistAcrossSessions: true, but are unregistered when the extension is updated.persistAcrossSessionsproperty in controlling script persistence.Why this change?
scripting.registerContentScriptsAPI fully understand its behavior in both Firefox and Chrome.This fix references MDN GitHub Issue #38690 and improves the clarity of the API documentation.
Description
This PR updates the
registerContentScriptsAPI documentation to clarify the persistence behavior of registered content scripts across different browsers. It explicitly explains how scripts behave in Firefox and Chrome, ensuring that developers are aware of browser-specific differences.Motivation
persistAcrossSessionsproperty was not well-documented, especially regarding script removal during Chrome extension updates.Additional Details
persistAcrossSessionschrome.scripting.registerContentScriptsRelated Issues and Pull Requests