refactor(svg): remove json return format

Author: firestar300

config/plugins.js

@@ -19,9 +19,7 @@ module.exports = {
 			new WebpackThemeJsonPlugin({
 				watch: mode !== 'production',
 			}),
-			new SpriteHashPlugin({
-				returnFormat: 'php',
-			}),
+			new SpriteHashPlugin(),
 			new CleanWebpackPlugin({
 				cleanOnceBeforeBuildPatterns: ['**/*', '!images', '!images/**'],
 			}),

config/webpack-sprite-hash-plugin.js

@@ -2,33 +2,23 @@ const fs = require('fs')
 const path = require('path')
 const crypto = require('crypto')
 
-const ALLOWED_RETURN_FORMATS = ['json', 'php']
-
 /**
  * Webpack plugin to generate content hashes for SVG sprite files.
- * Creates a sprite-hashes.json (or sprite-hashes.asset.php) file in the dist folder.
+ * Creates a sprite-hashes.php file in the dist folder.
  *
  * @param {Object} options Plugin options.
- * @param {string} [options.returnFormat='json'] Output format: 'json' or 'php'.
- *   When 'php', generates a .asset.php file (outputFilename .json → .asset.php).
  * @param {string} [options.outputPath='dist'] Output directory.
  * @param {string} [options.spritePath='dist/icons'] Sprite SVG directory.
- * @param {string} [options.outputFilename='sprite-hashes.json'] Output file name.
+ * @param {string} [options.outputFilename='sprite-hashes.php'] Output file name.
  * @param {number} [options.hashLength=8] Hash length in characters.
  */
 class SpriteHashPlugin {
 	constructor(options = {}) {
-		const returnFormat = options.returnFormat || 'json'
-		if (!ALLOWED_RETURN_FORMATS.includes(returnFormat)) {
-			throw new Error(`SpriteHashPlugin: returnFormat must be one of ${ALLOWED_RETURN_FORMATS.join(', ')}`)
-		}
-
 		this.options = {
 			outputPath: options.outputPath || 'dist',
 			spritePath: options.spritePath || 'dist/icons',
-			outputFilename: options.outputFilename || 'sprite-hashes.' + returnFormat,
+			outputFilename: options.outputFilename || 'sprite-hashes.asset.php',
 			hashLength: options.hashLength || 8,
-			returnFormat,
 		}
 	}
 
@@ -50,11 +40,7 @@ class SpriteHashPlugin {
 	apply(compiler) {
 		compiler.hooks.afterEmit.tapAsync('SpriteHashPlugin', (compilation, callback) => {
 			const spriteDir = path.resolve(compiler.options.context, this.options.spritePath)
-			const outputFilename =
-				this.options.returnFormat === 'php'
-					? this.options.outputFilename.replace(/\.json$/i, '.asset.php')
-					: this.options.outputFilename
-			const outputFile = path.resolve(compiler.options.context, this.options.outputPath, outputFilename)
+			const outputFile = path.resolve(compiler.options.context, this.options.outputPath, this.options.outputFilename)
 
 			if (!fs.existsSync(spriteDir)) {
 				console.warn(`SpriteHashPlugin: Sprite directory not found: ${spriteDir}`)
@@ -75,22 +61,20 @@ class SpriteHashPlugin {
 				hashes[relativePath] = hash
 			})
 
-			if (this.options.returnFormat === 'php') {
-				const phpLines = [
-					'<?php',
-					'/**',
-					' * Sprite file hashes. Generated by SpriteHashPlugin.',
-					' *',
-					' * @return array<string, string> Path => hash.',
-					' */',
-					'return ' + this.formatPhpArray(hashes) + ';',
-					'',
-				]
-				fs.writeFileSync(outputFile, phpLines.join('\n'))
-			} else {
-				fs.writeFileSync(outputFile, JSON.stringify(hashes, null, 2))
-			}
-			console.log(`SpriteHashPlugin: Generated ${outputFilename} with ${Object.keys(hashes).length} sprites`)
+			const phpLines = [
+				'<?php',
+				'/**',
+				' * Sprite file hashes. Generated by SpriteHashPlugin.',
+				' *',
+				' * @return array<string, string> Path => hash.',
+				' */',
+				'return ' + this.formatPhpArray(hashes) + ';',
+				'',
+			]
+			fs.writeFileSync(outputFile, phpLines.join('\n'))
+			console.log(
+				`SpriteHashPlugin: Generated ${this.options.outputFilename} with ${Object.keys(hashes).length} sprites`
+			)
 
 			callback()
 		})

inc/Services/Svg.php

@@ -120,23 +120,17 @@ public function get_sprite_hash( string $sprite_name ): ?string {
 		static $sprite_hashes = null;
 
 		if ( null === $sprite_hashes ) {
-			$php_file  = get_theme_file_path( '/dist/sprite-hashes.php' );
-			$json_file = get_theme_file_path( '/dist/sprite-hashes.json' );
-
-			if ( is_readable( $php_file ) ) {
-				$sprite_hash = require $php_file;
-				$sprite_hash = \is_array( $sprite_hashes ) ? $sprite_hashes : [];
-			} elseif ( is_readable( $json_file ) ) {
-				$sprite_hash = file_get_contents( $json_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-				try {
-					$sprite_hash = json_decode( $json_content, true, 512, JSON_THROW_ON_ERROR );
-					$sprite_hash = \is_array( $sprite_hashes ) ? $sprite_hashes : [];
-				} catch ( \JsonException $e ) {
-					$sprite_hashes = [];
-
-					return null;
-				}
-			} else {
+			$sprite_hash_file = get_theme_file_path( '/dist/sprite-hashes.asset.php' );
+
+			if ( ! is_readable( $sprite_hash_file ) ) {
+				$sprite_hashes = [];
+
+				return null;
+			}
+
+			$sprite_hash = require $sprite_hash_file;
+
+			if ( ! is_array( $sprite_hash ) ) {
 				$sprite_hashes = [];
 
 				return null;
@@ -145,6 +139,6 @@ public function get_sprite_hash( string $sprite_name ): ?string {
 			$sprite_hashes = $sprite_hash;
 		}
 
-		return $sprite_hash[ sprintf( 'icons/%s.svg', $sprite_name ) ] ?? null;
+		return $sprite_hashes[ sprintf( 'icons/%s.svg', $sprite_name ) ] ?? null;
 	}
 }