Chore:

- Minor adjustments to composer.json file;
- Cleaned up WebpackEncorePlugin, TagRenderer and EntrypointLookup classes;

Author: OleksiiBulba

composer.json

@@ -3,13 +3,8 @@
     "description": "This is a Micro plugin for webpack-encore support",
     "type": "library",
     "version": "0.1",
-    "minimum-stability": "stable",
     "license": "MIT",
     "require": {
-        "php": "^8.0|^8.1|^8.2",
-        "micro/kernel-app": "^1",
-        "micro/kernel-boot-dependency": "^1",
-        "micro/kernel-boot-configuration": "^1",
         "micro/plugin-twig": "^1"
     },
     "autoload": {

src/Asset/EntrypointLookup.php

@@ -5,14 +5,15 @@
 namespace Boo\MicroPlugin\WebpackEncore\Asset;
 
 use Boo\MicroPlugin\WebpackEncore\Exception\EntrypointNotFoundException;
+use Boo\MicroPlugin\WebpackEncore\WebpackEncorePluginConfigurationInterface;
 
 class EntrypointLookup implements EntrypointLookupInterface
 {
     private mixed $entriesData = null;
 
     private array $returnedFiles = [];
 
-    public function __construct(private readonly string $entrypointJsonPath)
+    public function __construct(private readonly WebpackEncorePluginConfigurationInterface $configuration)
     {
     }
 
@@ -68,7 +69,7 @@ private function validateEntryName(string $entryName)
                 throw new EntrypointNotFoundException(sprintf('Could not find the entry "%s". Try "%s" instead (without the extension).', $entryName, $withoutExtension));
             }
 
-            throw new EntrypointNotFoundException(sprintf('Could not find the entry "%s" in "%s". Found: %s.', $entryName, $this->entrypointJsonPath, implode(', ', array_keys($entriesData['entrypoints']))));
+            throw new EntrypointNotFoundException(sprintf('Could not find the entry "%s" in "%s". Found: %s.', $entryName, $this->getEntrypointJsonPath(), implode(', ', array_keys($entriesData['entrypoints']))));
         }
     }
 
@@ -78,20 +79,25 @@ private function getEntriesData(): array
             return $this->entriesData;
         }
 
-        if (!file_exists($this->entrypointJsonPath)) {
-            throw new \InvalidArgumentException(sprintf('Could not find the entrypoints file from Webpack: the file "%s" does not exist.', $this->entrypointJsonPath));
+        if (!file_exists($this->getEntrypointJsonPath())) {
+            throw new \InvalidArgumentException(sprintf('Could not find the entrypoints file from Webpack: the file "%s" does not exist.', $this->getEntrypointJsonPath()));
         }
 
-        $this->entriesData = json_decode(file_get_contents($this->entrypointJsonPath), true);
+        $this->entriesData = json_decode(file_get_contents($this->getEntrypointJsonPath()), true);
 
         if (null === $this->entriesData) {
-            throw new \InvalidArgumentException(sprintf('There was a problem JSON decoding the "%s" file', $this->entrypointJsonPath));
+            throw new \InvalidArgumentException(sprintf('There was a problem JSON decoding the "%s" file', $this->getEntrypointJsonPath()));
         }
 
         if (!isset($this->entriesData['entrypoints'])) {
-            throw new \InvalidArgumentException(sprintf('Could not find an "entrypoints" key in the "%s" file', $this->entrypointJsonPath));
+            throw new \InvalidArgumentException(sprintf('Could not find an "entrypoints" key in the "%s" file', $this->getEntrypointJsonPath()));
         }
 
         return $this->entriesData;
     }
+
+    private function getEntrypointJsonPath(): string
+    {
+        return $this->configuration->getOutputPath().'/entrypoints.json';
+    }
 }

src/TagRenderer/TagRenderer.php

@@ -10,20 +10,22 @@ class TagRenderer implements TagRendererInterface
 {
     private array $renderedFiles = [];
     private array $defaultAttributes = [];
-    private array $defaultScriptAttributes = [];
+    private array $defaultScriptAttributes = [
+        'type' => 'application/javascript'
+    ];
     private array $defaultLinkAttributes = [];
 
     public function __construct(private readonly EntrypointLookupInterface $entrypointLookup)
     {
     }
 
-    public function renderWebpackScriptTags(string $entryName, string $packageName = null, array $extraAttributes = []): string
+    public function renderWebpackScriptTags(string $entryName, array $extraAttributes = []): string
     {
         $scriptTags = [];
 
         foreach ($this->entrypointLookup->getJavaScriptFiles($entryName) as $filename) {
             $attributes = [];
-            $attributes['src'] = $filename; // $this->getAssetPath($filename, $packageName);
+            $attributes['src'] = $filename;
             $attributes = array_merge($attributes, $this->defaultAttributes, $this->defaultScriptAttributes, $extraAttributes);
 
             $scriptTags[] = sprintf(
@@ -37,14 +39,14 @@ public function renderWebpackScriptTags(string $entryName, string $packageName =
         return implode('', $scriptTags);
     }
 
-    public function renderWebpackLinkTags(string $entryName, string $packageName = null, array $extraAttributes = []): string
+    public function renderWebpackLinkTags(string $entryName, array $extraAttributes = []): string
     {
         $scriptTags = [];
 
         foreach ($this->entrypointLookup->getCssFiles($entryName) as $filename) {
             $attributes = [];
             $attributes['rel'] = 'stylesheet';
-            $attributes['href'] = $filename; // $this->getAssetPath($filename, $packageName);
+            $attributes['href'] = $filename;
             $attributes = array_merge($attributes, $this->defaultAttributes, $this->defaultLinkAttributes, $extraAttributes);
 
             $scriptTags[] = sprintf(

src/TagRenderer/TagRendererInterface.php

@@ -6,7 +6,7 @@
 
 interface TagRendererInterface
 {
-    public function renderWebpackScriptTags(string $entryName, string $packageName = null, array $extraAttributes = []): string;
+    public function renderWebpackScriptTags(string $entryName, array $extraAttributes = []): string;
 
-    public function renderWebpackLinkTags(string $entryName, string $packageName = null, array $extraAttributes = []): string;
+    public function renderWebpackLinkTags(string $entryName, array $extraAttributes = []): string;
 }

src/WebpackEncorePlugin.php

@@ -4,10 +4,8 @@
 
 namespace Boo\MicroPlugin\WebpackEncore;
 
-use Micro\Component\DependencyInjection\Container;
-use Micro\Framework\Kernel\Configuration\PluginConfigurationInterface;
 use Micro\Framework\Kernel\Plugin\ConfigurableInterface;
-use Micro\Framework\Kernel\Plugin\DependencyProviderInterface;
+use Micro\Framework\Kernel\Plugin\PluginConfigurationTrait;
 use Micro\Plugin\Twig\Plugin\TwigExtensionPluginInterface;
 use Boo\MicroPlugin\WebpackEncore\Asset\EntrypointLookup;
 use Boo\MicroPlugin\WebpackEncore\Asset\EntrypointLookupInterface;
@@ -16,75 +14,30 @@
 use Boo\MicroPlugin\WebpackEncore\Twig\Extension\EntryFilesTwigExtension;
 use Twig\Extension\ExtensionInterface;
 
-class WebpackEncorePlugin implements DependencyProviderInterface, TwigExtensionPluginInterface, ConfigurableInterface
+/**
+ * @method WebpackEncorePluginConfigurationInterface configuration()
+ */
+class WebpackEncorePlugin implements TwigExtensionPluginInterface, ConfigurableInterface
 {
-    private ?TagRendererInterface $tagRenderer = null;
-
-    private ?EntrypointLookupInterface $entrypointLookup = null;
-
-    private WebpackEncorePluginConfigurationInterface $configuration;
-
-    public function provideDependencies(Container $container): void
-    {
-        $container->register(TagRendererInterface::class, function () {
-            return $this->createTagRenderer();
-        });
-        $container->register(EntrypointLookupInterface::class, function () {
-            return $this->createEntrypointLookup();
-        });
-    }
+    use PluginConfigurationTrait;
 
     public function provideTwigExtensions(): iterable
     {
         yield $this->createEntryFilesTwigExtension();
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function setConfiguration(PluginConfigurationInterface $pluginConfiguration): void
-    {
-        if ($pluginConfiguration instanceof WebpackEncorePluginConfigurationInterface) {
-            $this->configuration = $pluginConfiguration;
-
-            return;
-        }
-
-        throw new \InvalidArgumentException(sprintf(
-            'Plugin configuration should implement %s, provided %s',
-            WebpackEncorePluginConfigurationInterface::class,
-            \get_class($pluginConfiguration)
-        ));
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function configuration(): WebpackEncorePluginConfigurationInterface
-    {
-        return $this->configuration;
-    }
-
-    private function createEntryFilesTwigExtension(): ExtensionInterface
+    protected function createEntryFilesTwigExtension(): ExtensionInterface
     {
         return new EntryFilesTwigExtension($this->createTagRenderer(), $this->createEntrypointLookup());
     }
 
-    private function createTagRenderer(): TagRendererInterface
+    protected function createTagRenderer(): TagRendererInterface
     {
-        if (null === $this->tagRenderer) {
-            $this->tagRenderer = new TagRenderer($this->createEntrypointLookup());
-        }
-
-        return $this->tagRenderer;
+        return new TagRenderer($this->createEntrypointLookup());
     }
 
-    private function createEntrypointLookup(): EntrypointLookupInterface
+    protected function createEntrypointLookup(): EntrypointLookupInterface
     {
-        if (null === $this->entrypointLookup) {
-            $this->entrypointLookup = new EntrypointLookup($this->configuration->getOutputPath().'/entrypoints.json');
-        }
-
-        return $this->entrypointLookup;
+        return new EntrypointLookup($this->configuration());
     }
 }

src/WebpackEncorePluginConfigurationInterface.php

@@ -4,9 +4,7 @@
 
 namespace Boo\MicroPlugin\WebpackEncore;
 
-use Micro\Framework\Kernel\Configuration\PluginConfigurationInterface;
-
-interface WebpackEncorePluginConfigurationInterface extends PluginConfigurationInterface
+interface WebpackEncorePluginConfigurationInterface
 {
     public function getOutputPath(): string;
 }