Escape-html: Convert package to TypeScript (#62586)

Co-authored-by: jpstevens <[email protected]>
Co-authored-by: sirreal <[email protected]>
Co-authored-by: up1512001 <[email protected]>

packages/escape-html/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Internal
+
+-   Refactor to TypeScript ([#62586](https://github.com/WordPress/gutenberg/pull/62586)).
+
 ## 3.0.0 (2024-05-31)
 
 ### Breaking Changes

packages/escape-html/src/escape-greater.js → packages/escape-html/src/escape-greater.ts

@@ -6,10 +6,10 @@
  *
  * See: https://core.trac.wordpress.org/ticket/45387
  *
- * @param {string} value Original string.
+ * @param value Original string.
  *
- * @return {string} Escaped string.
+ * @return Escaped string.
  */
-export default function __unstableEscapeGreaterThan( value ) {
+export default function __unstableEscapeGreaterThan( value: string ): string {
 	return value.replace( />/g, '>' );
 }

packages/escape-html/src/index.js → packages/escape-html/src/index.ts

@@ -11,10 +11,9 @@ import __unstableEscapeGreaterThan from './escape-greater';
  * and noncharacters."
  *
  * @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
- *
- * @type {RegExp}
  */
-const REGEXP_INVALID_ATTRIBUTE_NAME = /[\u007F-\u009F "'>/="\uFDD0-\uFDEF]/;
+const REGEXP_INVALID_ATTRIBUTE_NAME: RegExp =
+	/[\u007F-\u009F "'>/="\uFDD0-\uFDEF]/;
 
 /**
  * Returns a string with ampersands escaped. Note that this is an imperfect
@@ -26,33 +25,33 @@ const REGEXP_INVALID_ATTRIBUTE_NAME = /[\u007F-\u009F "'>/="\uFDD0-\uFDEF]/;
  * @see https://w3c.github.io/html/syntax.html#ambiguous-ampersand
  * @see https://w3c.github.io/html/syntax.html#named-character-references
  *
- * @param {string} value Original string.
+ * @param value Original string.
  *
- * @return {string} Escaped string.
+ * @return Escaped string.
  */
-export function escapeAmpersand( value ) {
+export function escapeAmpersand( value: string ): string {
 	return value.replace( /&(?!([a-z0-9]+|#[0-9]+|#x[a-f0-9]+);)/gi, '&' );
 }
 
 /**
  * Returns a string with quotation marks replaced.
  *
- * @param {string} value Original string.
+ * @param value Original string.
  *
- * @return {string} Escaped string.
+ * @return Escaped string.
  */
-export function escapeQuotationMark( value ) {
+export function escapeQuotationMark( value: string ): string {
 	return value.replace( /"/g, '"' );
 }
 
 /**
  * Returns a string with less-than sign replaced.
  *
- * @param {string} value Original string.
+ * @param value Original string.
  *
- * @return {string} Escaped string.
+ * @return Escaped string.
  */
-export function escapeLessThan( value ) {
+export function escapeLessThan( value: string ): string {
 	return value.replace( /</g, '&lt;' );
 }
 
@@ -72,11 +71,11 @@ export function escapeLessThan( value ) {
  *
  * See: https://core.trac.wordpress.org/ticket/45387
  *
- * @param {string} value Attribute value.
+ * @param value Attribute value.
  *
- * @return {string} Escaped attribute value.
+ * @return Escaped attribute value.
  */
-export function escapeAttribute( value ) {
+export function escapeAttribute( value: string ): string {
 	return __unstableEscapeGreaterThan(
 		escapeQuotationMark( escapeAmpersand( value ) )
 	);
@@ -90,11 +89,11 @@ export function escapeAttribute( value ) {
  * "the text must not contain the character U+003C LESS-THAN SIGN (<) or an
  * ambiguous ampersand."
  *
- * @param {string} value Element value.
+ * @param value Element value.
  *
- * @return {string} Escaped HTML element value.
+ * @return Escaped HTML element value.
  */
-export function escapeHTML( value ) {
+export function escapeHTML( value: string ): string {
 	return escapeLessThan( escapeAmpersand( value ) );
 }
 
@@ -103,21 +102,21 @@ export function escapeHTML( value ) {
  * `escapeHTML`, because for editable HTML, ALL ampersands must be escaped in
  * order to render the content correctly on the page.
  *
- * @param {string} value Element value.
+ * @param value Element value.
  *
- * @return {string} Escaped HTML element value.
+ * @return Escaped HTML element value.
  */
-export function escapeEditableHTML( value ) {
+export function escapeEditableHTML( value: string ): string {
 	return escapeLessThan( value.replace( /&/g, '&amp;' ) );
 }
 
 /**
  * Returns true if the given attribute name is valid, or false otherwise.
  *
- * @param {string} name Attribute name to test.
+ * @param name Attribute name to test.
  *
- * @return {boolean} Whether attribute is valid.
+ * @return Whether attribute is valid.
  */
-export function isValidAttributeName( name ) {
+export function isValidAttributeName( name: string ): boolean {
 	return ! REGEXP_INVALID_ATTRIBUTE_NAME.test( name );
 }

packages/escape-html/src/test/index.js → packages/escape-html/src/test/index.ts

@@ -9,17 +9,19 @@ import {
 	escapeHTML,
 	isValidAttributeName,
 	escapeEditableHTML,
-} from '../';
+} from '..';
 import __unstableEscapeGreaterThan from '../escape-greater';
 
-function testUnstableEscapeGreaterThan( implementation ) {
+type Implementation = ( str: string ) => string;
+
+function testUnstableEscapeGreaterThan( implementation: Implementation ) {
 	it( 'should escape greater than', () => {
 		const result = implementation( 'Chicken > Ribs' );
 		expect( result ).toBe( 'Chicken > Ribs' );
 	} );
 }
 
-function testEscapeAmpersand( implementation ) {
+function testEscapeAmpersand( implementation: Implementation ) {
 	it( 'should escape ampersand', () => {
 		const result = implementation(
 			'foo & bar & & baz Σ &#bad; Σ Σ &#xevil;'
@@ -31,15 +33,15 @@ function testEscapeAmpersand( implementation ) {
 	} );
 }
 
-function testEscapeQuotationMark( implementation ) {
+function testEscapeQuotationMark( implementation: Implementation ) {
 	it( 'should escape quotation mark', () => {
 		const result = implementation( '"Be gone!"' );
 
 		expect( result ).toBe( '"Be gone!"' );
 	} );
 }
 
-function testEscapeLessThan( implementation ) {
+function testEscapeLessThan( implementation: Implementation ) {
 	it( 'should escape less than', () => {
 		const result = implementation( 'Chicken < Ribs' );