/**

protected $format = 'plaintext';

/**

public function __invoke( $args, $assoc_args ) {

$this->source = realpath( $args[0] );

if ( ! $this->source || ! is_dir( $this->source ) ) {

WP_CLI::error( 'Not a valid source directory.' );

}

$this->slug = Utils\get_flag_value( $assoc_args, 'slug', Utils\basename( $this->source ) );

$this->domain = Utils\get_flag_value( $assoc_args, 'domain', null );

$this->skip_js = Utils\get_flag_value( $assoc_args, 'skip-js', $this->skip_js );

$this->skip_php = Utils\get_flag_value( $assoc_args, 'skip-php', $this->skip_php );

$this->skip_blade = Utils\get_flag_value( $assoc_args, 'skip-blade', $this->skip_blade );

$this->skip_block_json = Utils\get_flag_value( $assoc_args, 'skip-block-json', $this->skip_block_json );

$this->skip_theme_json = Utils\get_flag_value( $assoc_args, 'skip-theme-json', $this->skip_theme_json );

$this->format = Utils\get_flag_value( $assoc_args, 'format', $this->format );

$ignore_domain = Utils\get_flag_value( $assoc_args, 'ignore-domain', false );

$include = Utils\get_flag_value( $assoc_args, 'include', [] );

if ( ! empty( $include ) ) {

$this->include = array_map( 'trim', explode( ',', $include ) );

}

$exclude = Utils\get_flag_value( $assoc_args, 'exclude', [] );

if ( ! empty( $exclude ) ) {

$this->exclude = array_map( 'trim', explode( ',', $exclude ) );

}

$this->main_file_data = $this->get_main_file_data();

if ( $ignore_domain ) {

WP_CLI::debug( 'Extracting all strings regardless of text domain', 'audit' );

}

if ( ! $ignore_domain ) {

if ( null === $this->domain ) {

$this->domain = $this->slug;

if ( ! empty( $this->main_file_data['Text Domain']['value'] ) ) {

$this->domain = $this->main_file_data['Text Domain']['value'];

}

}

WP_CLI::debug(

sprintf(

'Auditing strings for %s, using "%s" as text domain.',

$this->slug,

$this->domain

),

'audit'

);

}

$translations = $this->extract_strings_for_audit();

$issues = $this->collect_audit_issues( $translations );

$this->output_results( $issues );

// Only output summary messages in plaintext format.

if ( 'plaintext' === $this->format ) {

$issue_count = count( $issues );

if ( $issue_count > 0 ) {

WP_CLI::warning( sprintf( 'Found %d %s.', $issue_count, Utils\pluralize( 'issue', $issue_count ) ) );

} else {

WP_CLI::success( 'No issues found.' );

}

}

}

/**

protected function get_main_file_data() {

$files = new \IteratorIterator( new \DirectoryIterator( $this->source ) );

/** @var \DirectoryIterator $file */

foreach ( $files as $file ) {

$stylesheet_path = null;

$project_path = null;

// wp-content/themes/my-theme/style.css

if ( $file->isFile() && 'style' === $file->getBasename( '.css' ) && $file->isReadable() ) {

$stylesheet_path = $file->getRealPath();

$project_path = $file->getRealPath();

} elseif ( $file->isDir() && ! $file->isDot() && is_readable( $file->getRealPath() . '/style.css' ) ) {

// wp-content/themes/my-themes/theme-a/style.css

$stylesheet_path = $file->getRealPath() . '/style.css';

$project_path = $file->getRealPath();

}

if ( $stylesheet_path ) {

$theme_data = FileDataExtractor::get_file_data(

$stylesheet_path,

array_combine(

$this->get_file_headers( 'theme' ),

$this->get_file_headers( 'theme' )

)

);

// Stop when it contains a valid Theme Name header.

if ( ! empty( $theme_data['Theme Name']['value'] ) ) {

if ( 'plaintext' === $this->format ) {

WP_CLI::log( 'Theme stylesheet detected.' );

}

WP_CLI::debug( sprintf( 'Theme stylesheet: %s', $stylesheet_path ), 'audit' );

$this->project_type = 'theme';

$this->main_file_path = $project_path;

return $theme_data;

}

}

// wp-content/plugins/my-plugin/my-plugin.php

if ( $file->isFile() && $file->isReadable() && 'php' === $file->getExtension() ) {

$plugin_data = FileDataExtractor::get_file_data(

$file->getRealPath(),

array_combine(

$this->get_file_headers( 'plugin' ),

$this->get_file_headers( 'plugin' )

)

);

// Stop when we find a file with a valid Plugin Name header.

if ( ! empty( $plugin_data['Plugin Name']['value'] ) ) {

if ( 'plaintext' === $this->format ) {

WP_CLI::log( 'Plugin file detected.' );

}

WP_CLI::debug( sprintf( 'Plugin file: %s', $file->getRealPath() ), 'audit' );

$this->project_type = 'plugin';

$this->main_file_path = $file->getRealPath();

return $plugin_data;

}

}

}

WP_CLI::debug( 'No valid theme stylesheet or plugin file found, treating as a regular project.', 'audit' );

return [];

}

/**

protected function extract_strings_for_audit() {

$translations = new Translations();

if ( $this->domain ) {

$translations->setDomain( $this->domain );

}

$is_theme = isset( $this->main_file_data['Theme Name'] );

try {

if ( ! $this->skip_php ) {

$options = [

// Extract 'Template Name' headers in theme files.

'wpExtractTemplates' => $is_theme,

// Extract 'Title' and 'Description' headers from pattern files.

'wpExtractPatterns' => $is_theme,

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'php' ],

'addReferences' => $this->location,

];

PhpCodeExtractor::fromDirectory( $this->source, $translations, $options );

}

if ( ! $this->skip_blade ) {

$options = [

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'blade.php' ],

'addReferences' => $this->location,

];

BladeCodeExtractor::fromDirectory( $this->source, $translations, $options );

}

if ( ! $this->skip_js ) {

JsCodeExtractor::fromDirectory(

$this->source,

$translations,

[

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'js', 'jsx' ],

'addReferences' => $this->location,

]

);

MapCodeExtractor::fromDirectory(

$this->source,

$translations,

[

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'map' ],

'addReferences' => $this->location,

]

);

}

if ( ! $this->skip_block_json ) {

BlockExtractor::fromDirectory(

$this->source,

$translations,

[

'schema' => JsonSchemaExtractor::BLOCK_JSON_SOURCE,

'schemaFallback' => JsonSchemaExtractor::BLOCK_JSON_FALLBACK,

// Only look for block.json files in any folder, nothing else.

'restrictFileNames' => [ 'block.json' ],

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'json' ],

'addReferences' => $this->location,

]

);

}

if ( ! $this->skip_theme_json ) {

JsonSchemaExtractor::fromDirectory(

$this->source,

$translations,

[

// Only look for theme.json files in any folder, nothing else.

'restrictFileNames' => [ 'theme.json' ],

'schema' => JsonSchemaExtractor::THEME_JSON_SOURCE,

'schemaFallback' => JsonSchemaExtractor::THEME_JSON_FALLBACK,

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'json' ],

'addReferences' => $this->location,

]

);

// Themes can have style variations in the top-level "styles" folder.

// They're like theme.json but can have any name.

if ( $is_theme ) {

JsonSchemaExtractor::fromDirectory(

$this->source,

$translations,

[

'restrictDirectories' => [ 'styles' ],

'schema' => JsonSchemaExtractor::THEME_JSON_SOURCE,

'schemaFallback' => JsonSchemaExtractor::THEME_JSON_FALLBACK,

'include' => $this->include,

'exclude' => $this->exclude,

'extensions' => [ 'json' ],

'addReferences' => $this->location,

]

);

}

}

} catch ( \Exception $e ) {

WP_CLI::error( $e->getMessage() );

}

return $translations;

}

/**

protected function get_comment_text( $comment ) {

return $comment instanceof ParsedComment ? $comment->getComment() : $comment;

}

/**

protected function collect_audit_issues( $translations ) {

$issues = [];

foreach ( $translations as $translation ) {

/** @var Translation $translation */

$references = $translation->getReferences();

// File headers don't have any file references.

if ( ! $translation->hasReferences() ) {

continue;

}

$file = $references[0][0];

$line = $references[0][1] ?? null;

// Check 1: Flag strings with placeholders that should have translator comments.

if (

! $translation->hasExtractedComments() &&

preg_match( self::SPRINTF_PLACEHOLDER_REGEX, $translation->getOriginal() ) >= 1

) {

$issues[] = [

'file' => $file,

'line' => $line,

'message' => sprintf(

'The string "%s" contains placeholders but has no "translators:" comment to clarify their meaning.',

$translation->getOriginal()

),

'code' => 'missing-translator-comment',

];

}

// Check 2: Flag strings with different translator comments.

if ( $translation->hasExtractedComments() ) {

$comments = $translation->getExtractedComments();

// Remove plugin header information from comments.

$comments = array_filter(

$comments,

function ( $comment ) {

/** @var ParsedComment|string $comment */

/** @var string $file_header */

foreach ( $this->get_file_headers( $this->project_type ) as $file_header ) {

if ( 0 === strpos( $this->get_comment_text( $comment ), $file_header ) ) {

return false;

}

}

return $comment;

}

);

$unique_comment_texts = array_unique(

array_map( [ $this, 'get_comment_text' ], $comments )

);

$comments_count = count( $unique_comment_texts );

if ( $comments_count > 1 ) {

$issues[] = [

'file' => $file,

'line' => $line,

'message' => sprintf(

"The string \"%s\" has %d different translator comments.\n%s",

$translation->getOriginal(),

$comments_count,

implode( "\n", array_values( $unique_comment_texts ) )

),

'code' => 'multiple-translator-comments',

];

}

}

$non_placeholder_content = trim( preg_replace( self::SPRINTF_PLACEHOLDER_REGEX, '', $translation->getOriginal() ) );

// Check 3: Flag empty strings without any translatable content.

if ( '' === $non_placeholder_content ) {

$issues[] = [

'file' => $file,

'line' => $line,

'message' => 'Found string without translatable content.',

'code' => 'empty-string',

];

}

// Check 4: Flag strings with multiple unordered placeholders (%s %s %s vs. %1$s %2$s %3$s).

$unordered_matches_count = preg_match_all( self::UNORDERED_SPRINTF_PLACEHOLDER_REGEX, $translation->getOriginal(), $unordered_matches );

if ( $unordered_matches_count >= 2 ) {

$issues[] = [

'file' => $file,

'line' => $line,

'message' => 'Multiple placeholders should be ordered.',

'code' => 'unordered-placeholders',

];

}

if ( $translation->hasPlural() ) {

preg_match_all( self::SPRINTF_PLACEHOLDER_REGEX, $translation->getOriginal(), $single_placeholders );

$single_placeholders = $single_placeholders[0];

preg_match_all( self::SPRINTF_PLACEHOLDER_REGEX, $translation->getPlural(), $plural_placeholders );

$plural_placeholders = $plural_placeholders[0];

// see https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#plurals

if ( count( $single_placeholders ) < count( $plural_placeholders ) ) {

// Check 5: Flag things like _n( 'One comment', '%s Comments' )

$issues[] = [

'file' => $file,

'line' => $line,

'message' => 'Missing singular placeholder, needed for some languages. See https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#plurals',

'code' => 'missing-singular-placeholder',

];

} else {

// Reordering is fine, but mismatched placeholders is probably wrong.

sort( $single_placeholders );

sort( $plural_placeholders );

// Check 6: Flag things like _n( '%s Comment (%d)', '%s Comments (%s)' )

if ( $single_placeholders !== $plural_placeholders ) {

$issues[] = [

'file' => $file,

'line' => $line,

'message' => 'Mismatched placeholders for singular and plural string.',

'code' => 'mismatched-placeholders',

];

}

}

}

}

return $issues;

}

/**

protected function output_results( $issues ) {

if ( empty( $issues ) ) {

return;

}

switch ( $this->format ) {

case 'json':

WP_CLI::line( json_encode( $issues, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) );

break;

case 'github-actions':

foreach ( $issues as $issue ) {

$file = $issue['file'];

$line = $issue['line'] ?? 1;

$message = $issue['message'];

WP_CLI::line( sprintf( '::warning file=%s,line=%d::%s', $file, $line, $message ) );

}

break;

case 'plaintext':

default:

foreach ( $issues as $issue ) {

$file = $issue['file'];

$line = $issue['line'] ?? null;

$message = $issue['message'];

$location = $line ? "$file:$line" : $file;

WP_CLI::warning( sprintf( '%s: %s', $location, $message ) );

}

break;

}

}