Skip to content

Start working on readme for version 6.12#1926

Merged
Crabcyborg merged 4 commits into
masterfrom
update_readme_6.12
Aug 21, 2024
Merged

Start working on readme for version 6.12#1926
Crabcyborg merged 4 commits into
masterfrom
update_readme_6.12

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

No description provided.

@Crabcyborg Crabcyborg marked this pull request as ready for review August 21, 2024 11:46
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 21, 2024

Walkthrough

Version 6.12 introduces significant enhancements to functionality, accessibility, and compatibility within the plugin. Key updates include an overhaul of default form styles, improved accessibility with screen reader support, resolution of rendering issues with Turnstile captcha, and validation enhancements for field length limits. Deprecated functions have been removed to streamline code maintenance, ensuring a smoother user experience while maintaining compatibility across various WordPress versions.

Changes

File/Entity Change Summary
src/FrmAppController.php Removed deprecated functions: include_embed_form_icons, get_form_shortcode.
src/frmFrontForm.js Removed deprecated JavaScript function: frmFrontForm.savingDraft.
changelog.txt, readme.txt Updated to reflect version change from 6.11.2 to 6.12 and document significant updates and fixes.
Various files (style settings) Updated default form style settings; existing sites retain old settings until manually reset.
Accessibility features Added hidden screen reader labels for bulk checkboxes in the entries list admin pages.
Compatibility enhancements Added checks for WordPress versions < 6.5; excluded fields with form state on servers lacking OpenSSL.
Validation processes Corrected character counting for field length limits, including accented characters.
HTML5 usage setting Standardized to always true across all sites, removing user configuration.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Crabcyborg Crabcyborg added this to the 6.12 milestone Aug 21, 2024
@Crabcyborg Crabcyborg merged commit 8a157ab into master Aug 21, 2024
@Crabcyborg Crabcyborg deleted the update_readme_6.12 branch August 21, 2024 11:48
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (10)
readme.txt (2)

375-375: Clarify the update on form style settings.

The description of the update to form style settings could be more explicit about the impact on existing sites.

Consider rephrasing for clarity:

- New: Many default form style settings have been updated. Existing sites will continue to use their existing default settings. To experience the new default style settings, access the list of styles from the style tab in form settings and select Reset to Defaults from the dropdown menu for a target style.
+ New: Many default form style settings have been updated. Existing sites will retain their current default settings unless manually reset. To apply the new default style settings, navigate to the style tab in form settings and select 'Reset to Defaults' for the desired style.

383-383: Clarify the removal of the HTML5 setting.

The statement about the HTML5 setting removal could be clearer.

Consider rephrasing for clarity:

- The setting to use HTML5 has been removed. This is now always true for all sites.
+ The option to disable HTML5 has been removed. HTML5 is now enforced for all sites.
changelog.txt (8)

3-3: Clarify style reset instructions.

The instructions for resetting to default style settings could be more explicit. Consider adding a step-by-step guide or a link to documentation.


5-5: Clarify Turnstile captcha fix.

The fix for Turnstile captcha rendering twice should specify the conditions under which this issue occurred, if applicable.


6-6: Compatibility check details.

The extra compatibility check for older WordPress versions should specify what was checked or improved for clarity.


7-7: Submit button visual bug fix.

Consider providing more details about the visual bug with the submit button to help users understand the impact of the fix.


8-8: Character validation fix.

The fix for character validation should specify which types of characters were affected to provide more context.


10-10: Sync improvements.

The updates to improve syncing of field options and conditional logic settings should mention any specific issues that were addressed.


11-11: HTML5 setting change.

The removal of the HTML5 setting and making it always true should be communicated clearly to users, as it may affect form behavior.


13-13: JavaScript function removal.

The removal of the deprecated JavaScript function should include information on alternatives or replacements if needed.

Comment thread readme.txt
* Fix: Turnstile captcha widgets were rendering twice.
* Fix: An extra check has been added to improve compatibility with older versions of WordPress before version 6.5.
* Fix: The submit button would appear as an entry table row on the entry view admin page.
* Fix: When validating field length limits, some characters including types with accents were not getting counted as expected and could fail validation.
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.

Add a missing comma for clarity.

A comma is needed after "some characters" to improve readability.

Use this diff to add the missing comma:

- Fix: When validating field length limits, some characters including types with accents were not getting counted as expected and could fail validation.
+ Fix: When validating field length limits, some characters, including types with accents, were not getting counted as expected and could fail validation.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* Fix: When validating field length limits, some characters including types with accents were not getting counted as expected and could fail validation.
* Fix: When validating field length limits, some characters, including types with accents, were not getting counted as expected and could fail validation.
Tools
LanguageTool

[uncategorized] ~380-~380: Possible missing comma found.
Context: ...en validating field length limits, some characters including types with accents were not g...

(AI_HYDRA_LEO_MISSING_COMMA)

Comment thread changelog.txt
* Checks have been added to no longer include fields with form state on servers where open SSL is not installed. This is to improve compatibility.
* Some updates have been made to improve the syncing of field option updates and conditional logic settings.
* The setting to use HTML5 has been removed. This is now always true for all sites.
* Some old deprecated PHP functions have been removed including FrmAppController::include_embed_form_icons and FrmAppController::get_form_shortcode.
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.

Deprecation of PHP functions.

The removal of deprecated PHP functions should include guidance on any necessary code changes for users who relied on these functions.

Do you want me to provide a guide or open a GitHub issue to help users transition away from these deprecated functions?

@coderabbitai coderabbitai Bot mentioned this pull request Mar 24, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Dec 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant