Skip to content

Rename system.pages.content.safeMode to system.page.content.allowHtml - #711

Merged
giuscris merged 1 commit into
2.xfrom
rename-safe-mode
Jul 1, 2025
Merged

Rename system.pages.content.safeMode to system.page.content.allowHtml#711
giuscris merged 1 commit into
2.xfrom
rename-safe-mode

Conversation

@giuscris

Copy link
Copy Markdown
Member

No description provided.

@giuscris giuscris added this to the 2.0.0 milestone Jun 28, 2025
@giuscris giuscris self-assigned this Jun 28, 2025
@giuscris giuscris added the enhancement New feature or request label Jun 28, 2025
@giuscris
giuscris requested a review from Copilot June 28, 2025 21:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames the Markdown HTML-sanitization option from system.pages.content.safeMode to system.pages.content.allowHtml and updates all associated code, schema, and translations.

  • Replaced safeMode toggle with allowHtml in translations and config/schema
  • Updated parser and view code to use allowHtml and inverted default
  • Adjusted default in formwork/config/system.yaml accordingly

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
panel/translations/*.yaml Renamed panel.options.system.content.safeMode keys to …allowHtml across all languages
formwork/src/Parsers/Markdown.php Replaced $safeMode with $allowHtml, updated default logic
formwork/src/Parsers/Extensions/CommonMark/FormworkExtension.php Renamed schema entry from safeMode to allowHtml
formwork/schemes/config/system.yaml Swapped pages.content.safeMode field for pages.content.allowHtml toggle
formwork/fields/markdown.php Updated Markdown field to pull system.pages.content.allowHtml
formwork/config/views/methods.php Changed view helper to pass allowHtml instead of safeMode
formwork/config/system.yaml Renamed default pages.content.safeMode setting to allowHtml
Comments suppressed due to low confidence (1)

panel/translations/en.yaml:157

  • The description implies HTML is never allowed, which contradicts the new allowHtml toggle. It should explain that tags are only escaped when HTML is not allowed.
panel.options.system.content.allowHtml.description: Potentially dangerous tags like `<script>` and `<style>` are always converted to text

public static function parse(string $input, array $options = []): string
{
$safeMode = $options['safeMode'] ?? true;
$allowHtml = $options['allowHtml'] ??= false;

Copilot AI Jun 28, 2025

Copy link

Choose a reason for hiding this comment

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

Using the null-coalescing assignment operator here mutates the input options array and can be confusing. Consider simply using $allowHtml = $options['allowHtml'] ?? false; to avoid side effects.

Suggested change
$allowHtml = $options['allowHtml'] ??= false;
$allowHtml = $options['allowHtml'] ?? false;

Copilot uses AI. Check for mistakes.
@giuscris
giuscris merged commit 8bcded5 into 2.x Jul 1, 2025
1 check passed
@giuscris
giuscris deleted the rename-safe-mode branch July 1, 2025 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants