Document BuildJsScope model and split tracking scripts - #606
Merged
adiati98 merged 1 commit intoJul 29, 2026
Merged
Conversation
Documents the JS build scope model from mautic/mautic#16660: the BuildJsScope enum, BuildJsEvent::appendJsForScope()/acceptsScope(), the /mautic-essential.js and /mautic-tracking.js endpoints, client-side runtime globals, and the backward-compatibility impact on legacy appendJs() subscribers. Re-homed from mautic#601 to a fresh branch at @adiati98's request so the new PR head gets a clean Read the Docs status from the start.
adiati98
approved these changes
Jul 29, 2026
Contributor
Author
|
Just a reminder: I review PR comments by default. If you want me to ignore a specific comment, start it with |
promptless-for-oss
deleted the
promptless/pr-16660-mtc-script-split-7.2-rehome
branch
July 29, 2026 18:20
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Open this suggestion in Promptless to view citations and reasoning process
Updates the MauticJS tracking script developer page (
docs/mauticjs_api/tracking_script.rst) to document the JS build scope model introduced in mautic/mautic#16660 ("Splitmtc.jsinto essential and tracking scripts", MTC-11100).New developer-facing surface documented:
Mautic\CoreBundle\Event\BuildJsScopeenum (RUNTIME,ESSENTIAL,TRACKING).BuildJsEvent::appendJsForScope($js, BuildJsScope $scope, $section = '')andacceptsScope(BuildJsScope $scope): bool, with plugin-style PHP subscriber examples.appendJs()now delegates toappendJsForScope()withBuildJsScope::TRACKING, plus a backward-compatibility warning (with argument-position migration guidance) thatappendJs()-only subscribers are excluded from/mautic-essential.js./mautic-essential.js,/mautic-tracking.js,/mtc.js) and their scope mappings.MauticJS.runtimeReady,trackingEnabled,requestWithCredentials) and themauticEssentialReadyevent, with a safe dual-path readiness guard example.No new Vale errors introduced; the one pre-existing baseline finding on unchanged content remains.
This PR re-homes the identical documentation content from #601 onto a fresh branch at @adiati98's request, so the new PR head receives a clean Read the Docs build status from the start. The Read the Docs check on #601 stayed stuck against a stale commit and did not clear after a dashboard rebuild, a close/reopen, or an empty commit. The documentation substance is unchanged from #601, including the review responses already applied there for @patrykgruszka and @adiati98.
Replaces #601.
Source PR: mautic/mautic#16660
Trigger Events
mtc.jsinto essential and tracking scriptsThis documentation update was prepared by Promptless.