8000 chore: Move from script tags containing dom elements to template tags by fsbraun · Pull Request #8237 · django-cms/django-cms · GitHub
[go: up one dir, main page]

Skip to content

chore: Move from script tags containing dom elements to template tags #8237

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

Merged
merged 1 commit into from
May 22, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented May 22, 2025

Description

Ports back #8233 to release/5.0.x

Related resources

Checklist

  • I have opened this pull request against main
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Backport the change to use HTML elements in place of <script> tags for plugin placeholder content in the 5.0.x release

Enhancements:

  • Replace <script> tags wrapping cms-plugin-child-classes content with tags in rendering logic

    Tests:

    • Update test fixtures and assertions to expect tags instead of <script> for plugin-child-classes templates

…#8233)

* [5.1.0dev1 release process] Bumped version to 5.1.0dev1

* [5.1.0dev1 release process] compilemessages

* [5.1.0dev1 release process] compiling new static files

* [5.1.0dev1 release process] updating latest docs

* Prepare new main branch

* Fix typos

* fix: No changes to changelog

* fix: Remove unnecessary change to migration

* Remove circular import

* Fix import order

* Re-introduce dummy `PlaceholderField` for legacy migrations

* fix: Do not assume page url cache to be filled

* fix: Structure board update sometimes failed to add all interactive elements (#8227)

* fix: Scan plugin data after structure mode Xhr load

* Fix test

* fix js linting issues

* fix: Update assets

* fix: Empty plugin selectors in all but first placeholder

* chore: Move from script tags containing dom elements to template tags

* Update cms/models/fields.py

* Update cms/models/fields.py

---------

Co-authored-by: Github Release Action <info@django-cms.org>
Copy link
Contributor
sourcery-ai bot commented May 22, 2025

Reviewer's Guide

This PR ports the change to release/5.0.x by replacing script tags used for CMS template placeholders with HTML template tags across rendering logic, fixtures, and tests.

Class Diagram: Modified Template Attributes in Renderers

classDiagram
    class StructureRenderer {
        +placeholder_edit_template: string
    }
    class LegacyRenderer {
        +placeholder_edit_template: string
    }
Loading

File-Level Changes


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Change Details Files
Swap script tags for template tags in placeholder rendering definitions
  • Updated StructureRenderer.placeholder_edit_template wrapper
  • Updated LegacyRenderer.placeholder_edit_template wrapper
cms/plugin_rendering.py
Update HTML fixture to use template tags
  • Replaced opening and closing <script> wrappers with in plugin_child_classes.html
cms/tests/frontend/unit/fixtures/plugin_child_classes.html Adjust tests to expect template tags
  • Replaced expected <script> tag assertions with in test_placeholder.py
cms/tests/test_placeholder.py

Copy link

👋 Hi there!

Please remember to MERGE COMMIT pull requests from main!

Do not SQUASH commits to preserve history for the changelog.

7F85

@fsbraun fsbraun merged commit 6302e60 into release/5.0.x May 22, 2025
69 checks passed
@fsbraun fsbraun deleted the chore/port-8322 branch May 22, 2025 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0