From efec923d4e8035f7f6f074a41f7a0c7005f60eaa Mon Sep 17 00:00:00 2001 From: Miguel Perez Pellicer <5908855+puntope@users.noreply.github.com> Date: Mon, 21 Aug 2023 11:01:14 +0400 Subject: [PATCH 1/2] Remove HookDocsGenerator legacy file --- bin/HooksDocsGenerator.php | 265 ------------------------------------- 1 file changed, 265 deletions(-) delete mode 100644 bin/HooksDocsGenerator.php diff --git a/bin/HooksDocsGenerator.php b/bin/HooksDocsGenerator.php deleted file mode 100644 index eac13af78e..0000000000 --- a/bin/HooksDocsGenerator.php +++ /dev/null @@ -1,265 +0,0 @@ - $files ) { - $hooks_found = []; - - foreach ( $files as $f ) { - $current_file = $f; - $tokens = token_get_all( file_get_contents( $f ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions - $token_type = false; - $current_class = ''; - $current_function = ''; - - if ( in_array( $current_file, $scanned, true ) ) { - continue; - } - - $scanned[] = $current_file; - - foreach ( $tokens as $index => $token ) { - if ( is_array( $token ) ) { - $trimmed_token_1 = trim( $token[1] ); - if ( T_CLASS === $token[0] ) { - $token_type = 'class'; - } elseif ( T_FUNCTION === $token[0] ) { - $token_type = 'function'; - } elseif ( 'do_action' === $token[1] ) { - $token_type = 'action'; - } elseif ( 'apply_filters' === $token[1] ) { - $token_type = 'filter'; - } elseif ( $token_type && ! empty( $trimmed_token_1 ) ) { - switch ( $token_type ) { - case 'class': - $current_class = $token[1]; - break; - case 'function': - $current_function = $token[1]; - break; - case 'filter': - case 'action': - $hook = trim( $token[1], "'" ); - $hook = str_replace( '_FUNCTION_', strtoupper( $current_function ), $hook ); - $hook = str_replace( '_CLASS_', strtoupper( $current_class ), $hook ); - $hook = str_replace( '$this', strtoupper( $current_class ), $hook ); - $hook = str_replace( [ '.', '{', '}', '"', "'", ' ', ')', '(' ], '', $hook ); - $hook = preg_replace( '/\/\/phpcs:(.*)(\n)/', '', $hook ); - $loop = 0; - - // Keep adding to hook until we find a comma or colon. - while ( 1 ) { - $loop++; - $prev_hook = is_string( $tokens[ $index + $loop - 1 ] ) ? $tokens[ $index + $loop - 1 ] : $tokens[ $index + $loop - 1 ][1]; - $next_hook = is_string( $tokens[ $index + $loop ] ) ? $tokens[ $index + $loop ] : $tokens[ $index + $loop ][1]; - - if ( in_array( $next_hook, [ '.', '{', '}', '"', "'", ' ', ')', '(' ], true ) ) { - continue; - } - - if ( in_array( $next_hook, [ ',', ';' ], true ) ) { - break; - } - - $hook_first = substr( $next_hook, 0, 1 ); - $hook_last = substr( $next_hook, -1, 1 ); - - if ( '{' === $hook_first || '}' === $hook_last || '$' === $hook_first || ')' === $hook_last || '>' === substr( $prev_hook, -1, 1 ) ) { - $next_hook = strtoupper( $next_hook ); - } - - $next_hook = str_replace( [ '.', '{', '}', '"', "'", ' ', ')', '(' ], '', $next_hook ); - - $hook .= $next_hook; - } - - $hook = trim( $hook ); - - if ( isset( $hooks_found[ $hook ] ) ) { - $hooks_found[ $hook ]['files'][] = [ - 'path' => $current_file, - 'line' => $token[2], - ]; - } else { - $hooks_found[ $hook ] = [ - 'files' => [ - [ - 'path' => $current_file, - 'line' => $token[2], - ], - ], - 'class' => $current_class, - 'function' => $current_function, - 'type' => $token_type, - ]; - } - break; - } - $token_type = false; - } - } - } - } - - ksort( $hooks_found ); - - if ( ! empty( $hooks_found ) ) { - $results[ $heading ] = $hooks_found; - } - } - - return $results; - } - - /** - * Get file URL. - * - * @param array $file File data. - * @return string - */ - protected static function get_file_url( array $file ): string { - $url = str_replace( '.php', '.php#L' . $file['line'], $file['path'] ); - return $url; - } - - /** - * Get file link. - * - * @param array $file File data. - * @return string - */ - protected static function get_file_link( array $file ): string { - return '' . basename( $file['path'] ) . "#L{$file['line']}" . ''; - } - - /** - * Get delimited list output. - * - * @param array $hook_list List of hooks. - * @param array $files_to_scan List of files to scan. - */ - protected static function get_delimited_list_output( array $hook_list, array $files_to_scan ): string { - $output = "# Hooks Reference\n\n"; - $output .= "A list of hooks, i.e `actions` and `filters`, that are defined or used in this project.\n\n"; - - foreach ( $hook_list as $hooks ) { - foreach ( $hooks as $hook => $details ) { - $output .= "## {$hook}\n\n"; - $output .= "**Type**: {$details['type']}\n\n"; - $output .= "**Used in**:\n\n"; - $link_list = []; - foreach ( $details['files'] as $file ) { - $link_list[] = '- ' . self::get_file_link( $file ); - } - $output .= implode( "\n", $link_list ); - $output .= "\n\n"; - } - } - - return $output; - } - - /** - * Generate hooks documentation. - */ - public static function generate_hooks_docs() { - $files_to_scan = self::get_files_to_scan(); - $hook_list = self::get_hooks( $files_to_scan ); - - if ( empty( $hook_list ) ) { - return; - } - - // Add hooks reference content. - $output = self::get_delimited_list_output( $hook_list, $files_to_scan ); - - file_put_contents( self::HOOKS_MARKDOWN_OUTPUT, $output ); // phpcs:ignore WordPress.WP.AlternativeFunctions - } -} - -HooksDocsGenerator::generate_hooks_docs(); From da25796afd0947f0e1e215f6736280c512fc398a Mon Sep 17 00:00:00 2001 From: Miguel Perez Pellicer <5908855+puntope@users.noreply.github.com> Date: Mon, 21 Aug 2023 14:11:29 +0400 Subject: [PATCH 2/2] Remove legacy script --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index 29d049b546..7db0ed42ea 100644 --- a/package.json +++ b/package.json @@ -90,7 +90,6 @@ "check-licenses": "wp-scripts check-licenses", "dev": "NODE_ENV=development wp-scripts build", "dewps:woo": "node bin/list-woo-dewped.mjs", - "doc:hooks": "php bin/HooksDocsGenerator.php", "doc:tracking": "woocommerce-grow-jsdoc ./js/src", "format": "wp-scripts format", "i18n": "WP_CLI_PHP_ARGS='-d memory_limit=2048M' ./vendor/bin/wp i18n make-pot ./ languages/$npm_package_name.pot --slug=$npm_package_name --domain=$npm_package_name --exclude=bin,data,js/src,node_modules,tests,vendor",