Merge branch 'release-1.10.0' into test/update-e2e-tests

Author: badasswp

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Feat: Add Plugin options page.
 * Feat: Add Shortcut command (CMD + F).
 * Feat: Add custom hooks: `afterSearchReplace`, `excludedPostTypes`, `regexPattern`.
+* Fix: Make default search literal & regex opt-in.
 * Refactor: Use `replaceInput` in place of repeated instances of `text`.
 * Test: Add e2e tests for plugin codebase.
 * Tested up to WP 6.9.

README.md

@@ -1,21 +1,21 @@
-# search-and-replace
+# search-replace-for-block-editor
 Search and Replace text within the Block Editor quickly and easily.
 
-<img width="446" alt="search-and-replace" src="https://github.com/badasswp/search-and-replace/assets/149586343/c3febf99-e9db-4b7b-82fd-c01e5428123a">
+<img width="446" alt="search-replace-for-block-editor" src="https://github.com/badasswp/search-and-replace/assets/149586343/c3febf99-e9db-4b7b-82fd-c01e5428123a">
 
 ## Download
 
 Download from [WordPress plugin repository](https://wordpress.org/plugins/search-replace-for-block-editor/).
 
-You can also get the latest version from any of our [release tags](https://github.com/badasswp/search-and-replace/releases).
+You can also get the latest version from any of our [release tags](https://github.com/badasswp/search-replace-for-block-editor/releases).
 
 ## Why Search and Replace for Block Editor?
 
 This plugin brings the familiar __Search and Replace__ functionality that PC users have grown accustomed to while using __Microsoft Word__ and __Google Docs__ to the Block Editor.
 
 Now you can easily search and replace text right in the Block Editor. Its easy and does exactly what it says. You can also match the text case using the 'Match Case | Expression' toggle.
 
-https://github.com/badasswp/search-and-replace/assets/149586343/d4acfab3-338b-434f-b09c-769df9331095
+https://github.com/badasswp/search-replace-for-block-editor/assets/149586343/d4acfab3-338b-434f-b09c-769df9331095
 
 ### Hooks
 

readme.txt

@@ -51,7 +51,7 @@ You can also <strong>select text</strong> on your Block Editor and <strong>use t
 
 The Search & Replace for Block Editor plugin is built to work right out of the box. Simply install, activate and start using.
 
-Want to add your personal touch? All of our documentation can be found [here](https://github.com/badasswp/search-and-replace). You can override the plugin's behaviour with custom logic of your own using [hooks](https://github.com/badasswp/search-and-replace?tab=readme-ov-file#hooks).
+Want to add your personal touch? All of our documentation can be found [here](https://github.com/badasswp/search-replace-for-block-editor). You can override the plugin's behaviour with custom logic of your own using [hooks](https://github.com/badasswp/search-replace-for-block-editor?tab=readme-ov-file#hooks).
 
 == Screenshots ==
 
@@ -69,6 +69,7 @@ Want to add your personal touch? All of our documentation can be found [here](ht
 * Feat: Add Plugin options page.
 * Feat: Add Shortcut command (CMD + F).
 * Feat: Add custom hooks: `afterSearchReplace`, `excludedPostTypes`, `regexPattern`.
+* Fix: Make default search literal & regex opt-in.
 * Refactor: Use `replaceInput` in place of repeated instances of `text`.
 * Test: Add e2e tests for plugin codebase.
 * Tested up to WP 6.9.
@@ -184,6 +185,6 @@ Want to add your personal touch? All of our documentation can be found [here](ht
 
 == Contribute ==
 
-If you'd like to contribute to the development of this plugin, you can find it on [GitHub](https://github.com/badasswp/search-and-replace).
+If you'd like to contribute to the development of this plugin, you can find it on [GitHub](https://github.com/badasswp/search-replace-for-block-editor).
 
 To build, clone repo and run `npm install && npm run build`

src/core/app.tsx

@@ -13,6 +13,8 @@ import {
 
 import { Shortcut } from './shortcut';
 import {
+	getPattern,
+	escapeRegex,
 	getAllowedBlocks,
 	getBlockEditorIframe,
 	ifIsCaseSensitiveBasedOnFilter,
@@ -169,13 +171,27 @@ const SearchReplaceForBlockEditor = (): JSX.Element => {
 		}
 
 		// Prepare raw string pattern.
-		const rawPattern = `(?<!<[^>]*)${ searchInput }(?<![^>]*<)`;
+		const rawPattern = getPattern(
+			isRegexExpression ? searchInput : escapeRegex( searchInput )
+		);
+
+		// Is Search case sensitive.
+		const isSearchCaseSensitive =
+			ifIsCaseSensitiveBasedOnFilter() || isCaseSensitive ? 'g' : 'gi';
+
+		// Define pattern.
+		let regexPattern: RegExp;
 
 		// Get Regex search pattern.
-		const regexPattern: RegExp = new RegExp(
-			rawPattern,
-			ifIsCaseSensitiveBasedOnFilter() || isCaseSensitive ? 'g' : 'gi'
-		);
+		try {
+			regexPattern = new RegExp( rawPattern, isSearchCaseSensitive );
+		} catch ( error ) {
+			// fallback to non-regex pattern.
+			regexPattern = new RegExp(
+				getPattern( escapeRegex( searchInput ) ),
+				isSearchCaseSensitive
+			);
+		}
 
 		/**
 		 * Filter the way we set the pattern, let users

src/core/filters.tsx

@@ -73,7 +73,7 @@ addFilter(
 				);
 
 				return {
-					newAttr: JSON.parse( tableString ),
+					newAttr: JSON.parse( tableString || '{}' ),
 					isChanged: tableString !== JSON.stringify( oldAttr ),
 				};
 

src/core/utils.tsx

@@ -397,3 +397,34 @@ export const isAllowedForPostType = (): boolean => {
 
 	return true;
 };
+
+/**
+ * Escape user input for safe
+ * literal RegExp usage.
+ *
+ * @since 1.10.0
+ *
+ * @param {string} value Raw user input.
+ * @return {string} Escaped input.
+ */
+export const escapeRegex = ( value: string ): string => {
+	if ( typeof value !== 'string' ) {
+		return '';
+	}
+
+	return value.replace( /[.*+?^${}()|[\]\\]/g, '\\$&' );
+};
+
+/**
+ * Get Search Pattern.
+ *
+ * This function returns a string pattern
+ * that targets only texts within valid HTML markup.
+ *
+ * @since 1.10.0
+ *
+ * @param {string} searchText Search Text.
+ * @return {string} Search Pattern.
+ */
+export const getPattern = ( searchText: string ): string =>
+	`(?<!<[^>]*)${ searchText }(?<![^>]*<)`;

tests/unit/js/utils.test.tsx

@@ -391,3 +391,37 @@ describe( 'getShortcutEvent', () => {
 		expect( shortcutEvent ).toBeInstanceOf( KeyboardEvent );
 	} );
 } );
+
+describe( 'escapeRegex', () => {
+	beforeEach( () => {
+		jest.resetModules();
+	} );
+
+	it( 'escapeRegex escapes regex metacharacters', () => {
+		const { escapeRegex } = require( '../../../src/core/utils' );
+
+		const escaped = escapeRegex( 'a.b+c*^$()[]{}|\\' );
+
+		expect( escaped ).toBe( 'a\\.b\\+c\\*\\^\\$\\(\\)\\[\\]\\{\\}\\|\\\\' );
+	} );
+
+	it( 'escapeRegex leaves plain text unchanged', () => {
+		const { escapeRegex } = require( '../../../src/core/utils' );
+
+		const escaped = escapeRegex( 'plain text' );
+
+		expect( escaped ).toBe( 'plain text' );
+	} );
+
+	it( 'escapeRegex returns empty string for non-string inputs', () => {
+		const { escapeRegex } = require( '../../../src/core/utils' );
+
+		expect( escapeRegex( 123 ) ).toBe( '' );
+	} );
+
+	it( 'escapeRegex returns empty string for empty input', () => {
+		const { escapeRegex } = require( '../../../src/core/utils' );
+
+		expect( escapeRegex( '' ) ).toBe( '' );
+	} );
+} );