10000 chore: Move from script tags containing dom elements to template tags by fsbraun · Pull Request #8233 · 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 #8233

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
May 21, 2025
Merged

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

merged 19 commits into from
May 21, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented May 21, 2025 •
edited by sourcery-ai bot
Loading

Description

Structure mode uses <script> tags to enclose DOM elements to not be rendered on the screen. These should be <template> tags.

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

Replace <script> tags with <template> tags for hidden plugin templates in structure mode.

Enhancements:

  • Use <template> tags instead of <script> tags in StructureRenderer and LegacyRenderer placeholder edit templates.
  • Update HTML fixtures to wrap plugin child class markup in <template> tags.

Tests:

  • Adjust placeholder tests to expect <template> tags instead of <script> tags.

Summary by Sourcery

Replace script tags with HTML template tags for hidden plugin templates in structure mode to improve semantics and prevent unwanted rendering

Enhancements:

  • Use tags instead of <script> tags for hidden plugin templates in StructureRenderer and LegacyRenderer

    Tests:

    • Update HTML fixtures and placeholder tests to expect tags for plugin child classes

Github Release Action and others added 16 commits May 12, 2025 09:40
[5.1.0dev1 release process] Bumped version to 5.1.0dev1
5dcfaee
[5.1.0dev1 release process] compilemessages
0e66eb1
[5.1.0dev1 release process] compiling new static files
f62dc80
[5.1.0dev1 release process] updating latest docs
2e61493
@fsbraun
Prepare new main branch
e73c887
@fsbraun
Fix typos
752eee1
@fsbraun
fix: No changes to changelog
0df9391
@fsbraun
fix: Remove unnecessary change to migration
4bc36a1
@fsbraun
Remove circular import
339e8c2
@fsbraun
Fix import order
d31bcd2
@fsbraun
Re-introduce dummy PlaceholderField for legacy migrations
29860d1
@fsbraun
fix: Do not assume page url cache to be filled
d1e5a3a
@fsbraun
fix: Structure board update sometimes failed to add all interactive e…
06e531a 
…lements (#8227)

* fix: Scan plugin data after structure mode Xhr load

* Fix test

* fix js linting issues
@fsbraun
fix: Update assets
4e764b9
@fsbraun
fix: Empty plugin selectors in all but first placeholder
73feff6
@fsbraun
chore: Move from script tags containing dom elements to template tags
a219785
@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented May 21, 2025 •
edited
Loading

Reviewer's Guide

Replaces all <script>-wrapped hidden plugin templates with semantic tags, updating renderer implementations, HTML fixtures, and tests for consistency.

Updated Class Diagram: Renderer Template Attributes

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

File-Level Changes

Change Details Files
Refactor renderer templates to use tags
  • Swap <script> for in StructureRenderer.placeholder_edit_template
  • Swap <script> for in LegacyRenderer.placeholder_edit_template
cms/plugin_rendering.py Update HTML fixture for plugin child classes
  • Replace <script> wrapper with tag around plugin child class markup
cms/tests/frontend/unit/fixtures/plugin_child_classes.html Adjust placeholder rendering tests
  • Change assertions to expect tags instead of <script>
  • Update test expectations for cms-plugin-child-classes IDs
    • cms/tests/test_placeholder.py
    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

fsbraun
fsbraun commented May 21, 2025
View reviewed changes
fsbraun
fsbraun commented May 21, 2025
View reviewed changes
sourcery-ai[bot]
sourcery-ai bot reviewed May 21, 2025
View reviewed changes
Copy link
Contributor
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@fsbraun fsbraun requested a review from jrief May 21, 2025 07:53
@vinitkumar
Copy link
Member

@fsbraun Is this ready to be reviewed?

@vinitkumar vinitkumar merged commit 0204fc6 into main May 21, 2025
66 checks passed
@fsbraun fsbraun deleted the chore/script2template branch May 22, 2025 06:33
fsbraun added a commit that referenced this pull request May 22, 2025
@fsbraun
chore: Move from script tags containing dom elements to template tags (…
99bf94a 
…#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>
@fsbraun fsbraun mentioned this pull request May 22, 2025
Merged
4 tasks
fsbraun added a commit that referenced this pull request May 22, 2025
@fsbraun
chore: Move from script tags containing dom elements to template tags (…
6302e60 
…#8233) (#8237)

* [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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@vinitkumar vinitkumar vinitkumar approved these changes

@jrief jrief Awaiting requested review from jrief

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fsbraun @vinitkumar
0