packages/hooks/src/validateHookName.ts - trunk - githubmirror/gutenberg

packages/hooks/src/validateHookName.ts

34 строки983 B

Eshaan Dabasiya

Migrate `hooks` package to TypeScript (#70488)

11 июл 2025, 08:13

11 июл 2025, 08:137db8f38

/**
 * Validate a hookName string.
 *
 * @param hookName The hook name to validate. Should be a non empty string containing
 *                 only numbers, letters, dashes, periods and underscores. Also,
 *                 the hook name cannot begin with `__`.
 *
 * @return Whether the hook name is valid.
 */
function validateHookName( hookName: string ): boolean {
	if ( 'string' !== typeof hookName || '' === hookName ) {
		// eslint-disable-next-line no-console
		console.error( 'The hook name must be a non-empty string.' );
		return false;
	}

	if ( /^__/.test( hookName ) ) {
		// eslint-disable-next-line no-console
		console.error( 'The hook name cannot begin with `__`.' );
		return false;
	}

	if ( ! /^[a-zA-Z][a-zA-Z0-9_.-]*$/.test( hookName ) ) {
		// eslint-disable-next-line no-console
		console.error(
			'The hook name can only contain numbers, letters, dashes, periods and underscores.'
		);
		return false;
	}

	return true;
}

export default validateHookName;