├── phpstan.neon
├── ecs.php
├── src
    ├── translations
    │   └── en
    │   │   └── vite.php
    ├── services
    │   ├── ServicesTrait.php
    │   └── Helper.php
    ├── variables
    │   └── ViteVariable.php
    ├── helpers
    │   └── PluginConfig.php
    ├── icon.svg
    ├── config.php
    ├── models
    │   └── Settings.php
    └── Vite.php
├── Makefile
├── LICENSE.md
├── composer.json
├── README.md
└── CHANGELOG.md


/phpstan.neon:
--------------------------------------------------------------------------------
1 | includes:
2 |     - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
3 | 
4 | parameters:
5 |     level: 5
6 |     paths:
7 |         - src
8 | 


--------------------------------------------------------------------------------
/ecs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use craft\ecs\SetList;
 4 | use Symplify\EasyCodingStandard\Config\ECSConfig;
 5 | 
 6 | return static function(ECSConfig $ecsConfig): void {
 7 |     $ecsConfig->paths([
 8 |         __DIR__ . '/src',
 9 |         __FILE__,
10 |     ]);
11 |     $ecsConfig->parallel();
12 |     $ecsConfig->sets([SetList::CRAFT_CMS_4]);
13 | };
14 | 


--------------------------------------------------------------------------------
/src/translations/en/vite.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Vite plugin for Craft CMS
 4 |  *
 5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 |  *
 7 |  * @link      https://nystudio107.com
 8 |  * @copyright Copyright (c) 2021 nystudio107
 9 |  */
10 | 
11 | /**
12 |  * @author    nystudio107
13 |  * @package   Vite
14 |  * @since     1.0.0
15 |  */
16 | return [
17 |     'Vite Cache' => 'Vite Cache',
18 |     '{name} plugin loaded' => '{name} plugin loaded',
19 | ];
20 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | MAJOR_VERSION?=5
 2 | PLUGINDEV_PROJECT_DIR?=/Users/andrew/webdev/sites/plugindev/cms_v${MAJOR_VERSION}/
 3 | VENDOR?=nystudio107
 4 | PROJECT_PATH?=${VENDOR}/$(shell basename $(CURDIR))
 5 | 
 6 | .PHONY: dev docs release
 7 | 
 8 | # Start up the buildchain dev server
 9 | dev:
10 | # Start up the docs dev server
11 | docs:
12 | 	${MAKE} -C docs/ dev
13 | # Run code quality tools, tests, and build the buildchain & docs in preparation for a release
14 | release: --code-quality --code-tests --buildchain-clean-build --docs-clean-build
15 | # The internal targets used by the dev & release targets
16 | --buildchain-clean-build:
17 | --code-quality:
18 | 	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- ecs check vendor/${PROJECT_PATH}/src --fix
19 | 	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- phpstan analyze -c vendor/${PROJECT_PATH}/phpstan.neon
20 | --code-tests:
21 | --docs-clean-build:
22 | 	${MAKE} -C docs/ clean
23 | 	${MAKE} -C docs/ image-build
24 | 	${MAKE} -C docs/ fix
25 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) nystudio107
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 6 | 
 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 8 | 
 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nystudio107/craft-vite",
 3 |   "description": "Allows the use of the Vite.js next generation frontend tooling with Craft CMS",
 4 |   "type": "craft-plugin",
 5 |   "version": "5.0.1",
 6 |   "keywords": [
 7 |     "craft",
 8 |     "cms",
 9 |     "craftcms",
10 |     "craft-plugin",
11 |     "vite"
12 |   ],
13 |   "support": {
14 |     "docs": "https://nystudio107.com/docs/vite/",
15 |     "issues": "https://nystudio107.com/plugins/vite/support",
16 |     "source": "https://github.com/nystudio107/craft-vite"
17 |   },
18 |   "license": "MIT",
19 |   "authors": [
20 |     {
21 |       "name": "nystudio107",
22 |       "homepage": "https://nystudio107.com"
23 |     }
24 |   ],
25 |   "require": {
26 |     "php": "^8.2",
27 |     "craftcms/cms": "^5.0.0",
28 |     "nystudio107/craft-plugin-vite": "^5.0.2"
29 |   },
30 |   "require-dev": {
31 |     "craftcms/cloud": "^2.0.0",
32 |     "craftcms/ecs": "dev-main",
33 |     "craftcms/phpstan": "dev-main",
34 |     "craftcms/rector": "dev-main"
35 |   },
36 |   "scripts": {
37 |     "phpstan": "phpstan --ansi --memory-limit=1G",
38 |     "check-cs": "ecs check --ansi",
39 |     "fix-cs": "ecs check --fix --ansi"
40 |   },
41 |   "config": {
42 |     "allow-plugins": {
43 |       "craftcms/plugin-installer": true,
44 |       "yiisoft/yii2-composer": true
45 |     },
46 |     "optimize-autoloader": true,
47 |     "sort-packages": true
48 |   },
49 |   "autoload": {
50 |     "psr-4": {
51 |       "nystudio107\\vite\\": "src/"
52 |     }
53 |   },
54 |   "extra": {
55 |     "changelogUrl": "https://raw.githubusercontent.com/nystudio107/craft-vite/v5/CHANGELOG.md",
56 |     "class": "nystudio107\\vite\\Vite",
57 |     "handle": "vite",
58 |     "name": "Vite"
59 |   }
60 | }
61 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-vite/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-vite/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-vite/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-vite/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-vite/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-vite/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-vite/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 2 | 
 3 | # Vite plugin for Craft CMS 5.x
 4 | 
 5 | Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 | 
 7 | ![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 8 | 
 9 | Related Article: [Vite.js Next Generation Frontend Tooling + Craft CMS](https://nystudio107.com/blog/using-vite-js-next-generation-frontend-tooling-with-craft-cms)
10 | 
11 | Most of the magic is actually in the [nystudio107/craft-plugin-vite](https://github.com/nystudio107/craft-plugin-vite) package, so that Craft CMS plugins can use it too.
12 | 
13 | ## Requirements
14 | 
15 | This plugin requires Craft CMS 5.0.0 or later.
16 | 
17 | **Installation**
18 | 
19 | 1. Install with Composer via `composer require nystudio107/craft-vite` from your project directory
20 | 2. Install the plugin via `php craft install/plugin vite` via the CLI -or- in the Craft Control Panel under Settings > Plugins
21 | 
22 | You can also install Vite via the **Plugin Store** in the Craft Control Panel.
23 | 
24 | ## Documentation
25 | 
26 | Click here -> [Vite Documentation](https://nystudio107.com/plugins/vite/documentation)
27 | 
28 | Brought to you by [nystudio107](http://nystudio107.com)
29 | 


--------------------------------------------------------------------------------
/src/services/ServicesTrait.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Vite plugin for Craft CMS
 4 |  *
 5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 |  *
 7 |  * @link      https://nystudio107.com
 8 |  * @copyright Copyright (c) 2022 nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\vite\services;
12 | 
13 | use nystudio107\pluginvite\services\ViteService;
14 | use nystudio107\vite\helpers\PluginConfig as PluginConfigHelper;
15 | use nystudio107\vite\services\Helper as HelperService;
16 | use yii\base\InvalidConfigException;
17 | 
18 | /**
19 |  * @author    nystudio107
20 |  * @package   Vite
21 |  * @since     4.0.4
22 |  *
23 |  * @property  ViteService $vite
24 |  * @property  HelperService $helper
25 |  */
26 | trait ServicesTrait
27 | {
28 |     // Public Static Methods
29 |     // =========================================================================
30 | 
31 |     /**
32 |      * @inheritdoc
33 |      */
34 |     public static function config(): array
35 |     {
36 |         return [
37 |             'components' => [
38 |                 'helper' => HelperService::class,
39 |                 'vite' => PluginConfigHelper::serviceDefinitionFromConfig('vite', ViteService::class),
40 |             ],
41 |         ];
42 |     }
43 | 
44 |     // Public Methods
45 |     // =========================================================================
46 | 
47 |     /**
48 |      * Returns the helper service
49 |      *
50 |      * @return HelperService The helper service
51 |      * @throws InvalidConfigException
52 |      */
53 |     public function getHelper(): HelperService
54 |     {
55 |         return $this->get('helper');
56 |     }
57 | 
58 |     /**
59 |      * Returns the vite service
60 |      *
61 |      * @return ViteService The helper service
62 |      * @throws InvalidConfigException
63 |      */
64 |     public function getVite(): ViteService
65 |     {
66 |         return $this->get('vite');
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Vite Changelog
 2 | 
 3 | All notable changes to this project will be documented in this file.
 4 | 
 5 | ## 5.0.1 - 2024.08.13
 6 | ### Added
 7 | * Added a `craft.vite.integrity()` method that will extract the integrity hash (for building a Content Security Policy)
 8 | * Added an `includeScriptOnloadHandler` config setting that allows you to disable the adding of an `onload` handler on the `<script>` tags (useful when implementing a Content Security Policy)
 9 | 
10 | ### Changed
11 | * Filter out empty attributes so they don't render on the `<script>` tags
12 | 
13 | ### Fixed
14 | * Use `strrpos` instead of `strpos` when attempting to extract a file name without the hash ([#28](https://github.com/nystudio107/craft-plugin-vite/pull/28))
15 | 
16 | ## 5.0.0 - 2024.04.16
17 | ### Added
18 | * Stable release for Craft CMS 5
19 | * Add `craft/cloud` to `composer.json` for CI
20 | 
21 | ## 5.0.0-beta.3 - 2024.03.02
22 | ### Added
23 | * Add documentation for Craft Cloud usage with Vite ([#83](https://github.com/nystudio107/craft-vite/pull/83))
24 | * Add support for clearing Vite caches in response to Craft Cloud's `UpController::EVENT_AFTER_UP` event ([#83](https://github.com/nystudio107/craft-vite/pull/83))
25 | 
26 | ### Fixed
27 | * Fixed an issue where the wrong CSS hash would be returned if you were using Vite 3 or earlier ([#80](https://github.com/nystudio107/craft-vite/issues/80))
28 | * Fixed an issue where `craft.vite.entry()` would fail if you were using Vite 5 or later, due to the `ManifestHelper::fileNameWithoutHash()` function not working correctly ([#24](https://github.com/nystudio107/craft-plugin-vite/issues/24))
29 | 
30 | ## 5.0.0-beta.2 - 2024.01.30
31 | ### Added
32 | * If the `devServer` is running, the `ViteService::fetch()` method will try to use the `devServerInternal` URL first, falling back on the `devServerPublic` so that `craft.vite.inline()` can pull from the `devServer` if it is running ([#22](https://github.com/nystudio107/craft-plugin-vite/issues/22))
33 | * Add `phpstan` and `ecs` code linting
34 | * Add `code-analysis.yaml` GitHub action
35 | 
36 | ### Changed
37 | * PHPstan code cleanup
38 | * ECS code cleanup
39 | 
40 | ## 5.0.0-beta.1 - 2024.01.21
41 | ### Added
42 | - Initial beta release
43 | 


--------------------------------------------------------------------------------
/src/variables/ViteVariable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Vite plugin for Craft CMS
 4 |  *
 5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 |  *
 7 |  * @link      https://nystudio107.com
 8 |  * @copyright Copyright (c) 2021 nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\vite\variables;
12 | 
13 | use craft\helpers\Template;
14 | use nystudio107\pluginvite\variables\ViteVariableInterface;
15 | use nystudio107\pluginvite\variables\ViteVariableTrait;
16 | use nystudio107\vite\Vite;
17 | use Twig\Error\LoaderError;
18 | use Twig\Markup;
19 | 
20 | /**
21 |  * @author    nystudio107
22 |  * @package   Vite
23 |  * @since     1.0.5
24 |  */
25 | class ViteVariable implements ViteVariableInterface
26 | {
27 |     use ViteVariableTrait;
28 | 
29 |     /**
30 |      * Returns the Critical CSS file for $template wrapped in <style></style>
31 |      * tags
32 |      *
33 |      * @param null|string $name
34 |      * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
35 |      *
36 |      * @return Markup
37 |      * @throws LoaderError
38 |      */
39 |     public function includeCriticalCssTags(?string $name = null, array $attributes = []): Markup
40 |     {
41 |         return Template::raw(
42 |             Vite::$plugin->helper->getCriticalCssTags($name, $attributes)
43 |         );
44 |     }
45 | 
46 |     /**
47 |      * Returns the passed in CSS file at the specified file system path or URL, wrapped in
48 |      * <style></style> tags
49 |      *
50 |      * @param string $path
51 |      * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
52 |      *
53 |      * @return string
54 |      */
55 |     public function getCssInlineTags(string $path, array $attributes = []): string
56 |     {
57 |         return Template::raw(
58 |             Vite::$plugin->helper->getCssInlineTags($path, $attributes)
59 |         );
60 |     }
61 | 
62 |     /**
63 |      * Return the hash value for the first CSS file bundled with the module specified via $path
64 |      *
65 |      * @param $path
66 |      * @return Markup
67 |      */
68 |     public function getCssHash($path): Markup
69 |     {
70 |         return Template::raw(
71 |             Vite::$plugin->helper->getCssHash($path)
72 |         );
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/src/helpers/PluginConfig.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Vite plugin for Craft CMS
 4 |  *
 5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 |  *
 7 |  * @link      https://nystudio107.com
 8 |  * @copyright Copyright (c) 2022 nystudio107
 9 |  */
10 | 
11 | namespace nystudio107\vite\helpers;
12 | 
13 | use Craft;
14 | use ReflectionClass;
15 | use ReflectionException;
16 | use ReflectionProperty;
17 | 
18 | /**
19 |  * @author    nystudio107
20 |  * @package   Vite
21 |  * @since     4.0.3
22 |  */
23 | class PluginConfig
24 | {
25 |     // Public static methods
26 |     // =========================================================================
27 | 
28 |     /**
29 |      * Return a service config definition pre-populated with settings from the
30 |      * $configHandle config/ file
31 |      *
32 |      * @param string $configHandle
33 |      * @param string $serviceClass
34 |      * @return array
35 |      */
36 |     public static function serviceDefinitionFromConfig(string $configHandle, string $serviceClass): array
37 |     {
38 |         $serviceAttrs = [];
39 |         // Get the available attributes from the $serviceClass
40 |         try {
41 |             $serviceAttrs = self::getClassAttributes($serviceClass);
42 |         } catch (ReflectionException $e) {
43 |             // That's fine
44 |         }
45 |         // Intersect the settings from the config file with the available service attributes
46 |         $serviceConfig = array_intersect_key(
47 |             Craft::$app->getConfig()->getConfigFromFile($configHandle),
48 |             $serviceAttrs
49 |         );
50 | 
51 |         return array_merge(
52 |             $serviceConfig,
53 |             ['class' => $serviceClass]
54 |         );
55 |     }
56 | 
57 |     /**
58 |      * Return the list of attribute names from a class name
59 |      *
60 |      * @return array list of attribute names.
61 |      * @throws ReflectionException
62 |      */
63 |     public static function getClassAttributes(string $className): array
64 |     {
65 |         $class = new ReflectionClass($className);
66 |         $names = [];
67 |         foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
68 |             if (!$property->isStatic()) {
69 |                 $name = $property->getName();
70 |                 $names[$name] = $name;
71 |             }
72 |         }
73 | 
74 |         return $names;
75 |     }
76 | }
77 | 


--------------------------------------------------------------------------------
/src/icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 25.2.3, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <svg version="1.1" id="gr_x5F_icon27_x5F_vite" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
 4 | 	 x="0px" y="0px" viewBox="0 0 250 250" enable-background="new 0 0 250 250" xml:space="preserve">
 5 | <path id="gr_7_" fill="#F3BA48" d="M237.666,172.701c0,9.543-6.757,21.247-15.022,26.019l-82.62,47.701
 6 | 	c-8.263,4.772-21.785,4.772-30.044,0L27.355,198.72c-8.263-4.772-15.022-16.476-15.022-26.019V77.299
 7 | 	c0-9.543,6.759-21.248,15.022-26.019l82.624-47.702c8.259-4.771,21.781-4.771,30.044,0l82.62,47.702
 8 | 	c8.266,4.771,15.022,16.476,15.022,26.019V172.701z"/>
 9 | <path fill="#FFFFFF" d="M188.889,85.139c-1.445-2.463-4.103-3.993-6.936-3.993c-0.489,0-0.983,0.045-1.469,0.133l-24.737,4.509
10 | 	l2.746-9.521c0.574-1.991,0.189-4.082-1.055-5.736c-1.229-1.633-3.178-2.608-5.214-2.608c0,0,0,0,0,0
11 | 	c-0.422,0-0.847,0.041-1.263,0.123l-41.716,8.174c-2.923,0.573-5.088,3.05-5.264,6.023l-0.304,5.128L69.49,81.262
12 | 	c-0.477-0.085-0.963-0.129-1.442-0.129c-2.847,0-5.512,1.541-6.953,4.022c-1.457,2.509-1.468,5.514-0.028,8.039l57.488,100.812
13 | 	c1.432,2.51,4.116,4.069,7.005,4.069c2.917,0,5.614-1.582,7.038-4.128l56.37-100.8C190.379,90.624,190.35,87.63,188.889,85.139z
14 | 	 M145.886,101.931c-0.289,1.001,0.478,1.957,1.465,1.957c0.097,0,0.196-0.009,0.297-0.029l11.955-2.307
15 | 	c0.102-0.02,0.203-0.029,0.301-0.029c1.097,0,1.881,1.177,1.359,2.219L127.27,171.58l-0.615,0.951
16 | 	c-0.319,0.493-0.792,0.706-1.26,0.706c-0.884,0-1.751-0.763-1.526-1.848l5.484-26.541c0.203-0.982-0.565-1.843-1.495-1.843
17 | 	c-0.147,0-0.299,0.022-0.451,0.068l-7.173,2.179c-0.152,0.046-0.303,0.068-0.451,0.068c-0.928,0-1.696-0.859-1.495-1.84
18 | 	l3.451-16.897c0.199-0.974-0.559-1.84-1.495-1.84c-0.115,0-0.232,0.013-0.35,0.04l-11.614,2.68c-0.117,0.027-0.234,0.04-0.348,0.04
19 | 	c-0.855,0-1.579-0.723-1.525-1.623l2.566-43.339c0.031-0.523,0.324-0.981,0.758-1.233c0.145-0.084,0.305-0.146,0.476-0.179
20 | 	l41.716-8.174c0.102-0.02,0.203-0.03,0.302-0.03c0.493,0,0.932,0.239,1.211,0.603c0.07,0.091,0.13,0.19,0.178,0.295
21 | 	c0.096,0.21,0.146,0.444,0.137,0.688c-0.005,0.122-0.024,0.246-0.06,0.372L145.886,101.931z M184.603,90.708l-56.37,100.799
22 | 	c-0.584,1.045-1.629,1.568-2.674,1.568c-1.036,0-2.073-0.515-2.661-1.546L65.41,90.718c-1.191-2.088,0.372-4.584,2.638-4.584
23 | 	c0.183,0,0.371,0.016,0.563,0.051l35.76,6.392l-1.958,33.068c-0.09,1.515,0.455,3.017,1.495,4.12c1.042,1.106,2.508,1.74,4.023,1.74
24 | 	c0.418,0,0.838-0.048,1.247-0.142l7.873-1.817l-2.682,13.135c-0.334,1.635,0.079,3.312,1.132,4.602
25 | 	c1.057,1.295,2.618,2.038,4.282,2.038c0.545,0,1.088-0.081,1.613-0.24l3.198-0.972l-4.643,22.472c-0.34,1.643,0.063,3.32,1.106,4.6
26 | 	c1.049,1.288,2.671,2.058,4.338,2.058c1.865,0,3.592-0.947,4.618-2.533l0.615-0.951c0.08-0.123,0.152-0.25,0.218-0.381
27 | 	l33.992-67.837c0.866-1.727,0.777-3.739-0.236-5.381c-1.017-1.647-2.773-2.631-4.698-2.631c-0.354,0-0.71,0.034-1.06,0.102
28 | 	l-7.999,1.544l2.255-7.816l28.28-5.154c0.195-0.036,0.386-0.052,0.573-0.052C184.206,86.146,185.771,88.619,184.603,90.708z"/>
29 | </svg>
30 | 


--------------------------------------------------------------------------------
/src/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Vite plugin for Craft CMS
 4 |  *
 5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 6 |  *
 7 |  * @link      https://nystudio107.com
 8 |  * @copyright Copyright (c) 2021 nystudio107
 9 |  */
10 | 
11 | use craft\helpers\App;
12 | 
13 | /**
14 |  * Vite config.php
15 |  *
16 |  * This file exists only as a template for the Vite settings.
17 |  * It does nothing on its own.
18 |  *
19 |  * Don't edit this file, instead copy it to 'craft/config' as 'vite.php'
20 |  * and make your changes there to override default settings.
21 |  *
22 |  * Once copied to 'craft/config', this file will be multi-environment aware as
23 |  * well, so you can have different settings groups for each environment, just as
24 |  * you do for 'general.php'
25 |  */
26 | 
27 | return [
28 | 
29 |     /**
30 |      * @var bool Should the dev server be used?
31 |      */
32 |     'useDevServer' => App::env('ENVIRONMENT') === 'dev' || App::env('CRAFT_ENVIRONMENT') === 'dev',
33 | 
34 |     /**
35 |      * @var string File system path (or URL) to the Vite-built manifest.json
36 |      */
37 |     'manifestPath' => '@webroot/dist/manifest.json',
38 | 
39 |     /**
40 |      * @var string The public URL to the dev server (what appears in `<script src="">` tags
41 |      */
42 |     'devServerPublic' => 'http://localhost:3000/',
43 | 
44 |     /**
45 |      * @var string The public URL to use when not using the dev server
46 |      */
47 |     'serverPublic' => App::env('PRIMARY_SITE_URL') . '/dist/',
48 | 
49 |     /**
50 |      * @var string|array The JavaScript entry from the manifest.json to inject on Twig error pages
51 |      *              This can be a string or an array of strings
52 |      */
53 |     'errorEntry' => '',
54 | 
55 |     /**
56 |      * @var string String to be appended to the cache key
57 |      */
58 |     'cacheKeySuffix' => '',
59 | 
60 |     /**
61 |      * @var string The internal URL to the dev server, when accessed from the environment in which PHP is executing
62 |      *              This can be the same as `$devServerPublic`, but may be different in containerized or VM setups.
63 |      *              ONLY used if $checkDevServer = true
64 |      */
65 |     'devServerInternal' => '',
66 | 
67 |     /**
68 |      * @var bool Should we check for the presence of the dev server by pinging $devServerInternal to make sure it's running?
69 |      */
70 |     'checkDevServer' => false,
71 | 
72 |     /**
73 |      * @var bool Whether the react-refresh-shim should be included
74 |      */
75 |     'includeReactRefreshShim' => false,
76 | 
77 |     /**
78 |      * @var bool Whether the modulepreload-polyfill shim should be included
79 |      */
80 |     'includeModulePreloadShim' => true,
81 | 
82 |     /**
83 |      * @var string File system path (or URL) to where the Critical CSS files are stored
84 |      */
85 |     'criticalPath' => '@webroot/dist/criticalcss',
86 | 
87 |     /**
88 |      * @var string the suffix added to the name of the currently rendering template for the critical css file name
89 |      */
90 |     'criticalSuffix' => '_critical.min.css',
91 | 
92 |     /**
93 |      * @var bool Whether an onload handler should be added to <script> tags to fire a custom event when the script has loaded
94 |      */
95 |     'includeScriptOnloadHandler' => true,
96 | ];
97 | 


--------------------------------------------------------------------------------
/src/models/Settings.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Vite plugin for Craft CMS
  4 |  *
  5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
  6 |  *
  7 |  * @link      https://nystudio107.com
  8 |  * @copyright Copyright (c) 2021 nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\vite\models;
 12 | 
 13 | use craft\base\Model;
 14 | 
 15 | /**
 16 |  * @author    nystudio107
 17 |  * @package   Vite
 18 |  * @since     1.0.0
 19 |  */
 20 | class Settings extends Model
 21 | {
 22 |     // Public Properties
 23 |     // =========================================================================
 24 | 
 25 |     /**
 26 |      * @var bool Should the dev server be used for?
 27 |      */
 28 |     public bool $useDevServer = false;
 29 | 
 30 |     /**
 31 |      * @var string File system path (or URL) to the Vite-built manifest.json
 32 |      */
 33 |     public string $manifestPath = '';
 34 | 
 35 |     /**
 36 |      * @var string The public URL to the dev server (what appears in `<script src="">` tags
 37 |      */
 38 |     public string $devServerPublic = '';
 39 | 
 40 |     /**
 41 |      * @var string The public URL to use when not using the dev server
 42 |      */
 43 |     public string $serverPublic = '';
 44 | 
 45 |     /**
 46 |      * @var string|array The JavaScript entry from the manifest.json to inject on Twig error pages
 47 |      *              This can be a string or an array of strings
 48 |      */
 49 |     public string|array $errorEntry = '';
 50 | 
 51 |     /**
 52 |      * @var string String to be appended to the cache key
 53 |      */
 54 |     public string $cacheKeySuffix = '';
 55 | 
 56 |     /**
 57 |      * @var string The internal URL to the dev server, when accessed from the environment in which PHP is executing
 58 |      *              This can be the same as `$devServerPublic`, but may be different in containerized or VM setups.
 59 |      *              ONLY used if $checkDevServer = true
 60 |      */
 61 |     public string $devServerInternal = '';
 62 | 
 63 |     /**
 64 |      * @var bool Should we check for the presence of the dev server by pinging $devServerInternal to make sure it's running?
 65 |      */
 66 |     public bool $checkDevServer = false;
 67 | 
 68 |     /**
 69 |      * @var bool Whether the react-refresh-shim should be included
 70 |      */
 71 |     public bool $includeReactRefreshShim = false;
 72 | 
 73 |     /**
 74 |      * @var bool Whether the modulepreload-polyfill shim should be included
 75 |      */
 76 |     public bool $includeModulePreloadShim = true;
 77 | 
 78 |     /**
 79 |      * @var string File system path (or URL) to where the Critical CSS files are stored
 80 |      */
 81 |     public string $criticalPath = '';
 82 | 
 83 |     /**
 84 |      * @var string the suffix added to the name of the currently rendering template for the critical css file name
 85 |      */
 86 |     public string $criticalSuffix = '_critical.min.css';
 87 | 
 88 |     /**
 89 |      * @var bool Whether an onload handler should be added to <script> tags to fire a custom event when the script has loaded
 90 |      */
 91 |     public bool $includeScriptOnloadHandler = true;
 92 | 
 93 |     // Public Methods
 94 |     // =========================================================================
 95 | 
 96 |     /**
 97 |      * @inheritdoc
 98 |      */
 99 |     public function rules(): array
100 |     {
101 |         return [
102 |             [
103 |                 [
104 |                     'useDevServer',
105 |                     'checkDevServer',
106 |                     'includeReactRefreshShim',
107 |                     'includeModulePreloadShim',
108 |                     'includeScriptOnloadHandler',
109 |                 ],
110 |                 'boolean',
111 |             ],
112 |             [
113 |                 [
114 |                     'manifestPath',
115 |                     'devServerPublic',
116 |                     'serverPublic',
117 |                     'cacheKeySuffix',
118 |                     'devServerInternal',
119 |                 ],
120 |                 'string',
121 |             ],
122 |             [
123 |                 [
124 |                     'errorEntry',
125 |                 ],
126 |                 'string',
127 |             ],
128 |         ];
129 |     }
130 | }
131 | 


--------------------------------------------------------------------------------
/src/services/Helper.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Vite plugin for Craft CMS
  4 |  *
  5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
  6 |  *
  7 |  * @link      https://nystudio107.com
  8 |  * @copyright Copyright (c) 2021 nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\vite\services;
 12 | 
 13 | use Craft;
 14 | use craft\base\Component;
 15 | use craft\helpers\Html;
 16 | use nystudio107\pluginvite\helpers\FileHelper;
 17 | use nystudio107\pluginvite\helpers\ManifestHelper;
 18 | use nystudio107\vite\models\Settings;
 19 | use nystudio107\vite\Vite;
 20 | use Twig\Error\LoaderError;
 21 | 
 22 | /**
 23 |  * @author    nystudio107
 24 |  * @package   Vite
 25 |  * @since     1.0.5
 26 |  */
 27 | class Helper extends Component
 28 | {
 29 |     /**
 30 |      * Returns the Critical CSS file for $template wrapped in <style></style>
 31 |      * tags
 32 |      *
 33 |      * @param null|string $name
 34 |      * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
 35 |      *
 36 |      * @return string
 37 |      * @throws LoaderError
 38 |      */
 39 |     public function getCriticalCssTags(?string $name = null, array $attributes = []): string
 40 |     {
 41 |         // Resolve the template name
 42 |         $template = Craft::$app->getView()->resolveTemplate($name ?? Vite::$templateName ?? '');
 43 |         if ($template) {
 44 |             /** @var Settings $settings */
 45 |             $settings = Vite::$plugin->getSettings();
 46 |             $name = FileHelper::createUrl(
 47 |                 pathinfo($template, PATHINFO_DIRNAME),
 48 |                 pathinfo($template, PATHINFO_FILENAME)
 49 |             );
 50 |             $dirPrefix = 'templates/';
 51 |             if (defined('CRAFT_TEMPLATES_PATH')) {
 52 |                 $dirPrefix = CRAFT_TEMPLATES_PATH;
 53 |             }
 54 |             $name = strstr($name, $dirPrefix);
 55 |             $pos = strpos($name, $dirPrefix);
 56 |             if ($pos !== false) {
 57 |                 $name = (string)substr_replace($name, '', $pos, strlen($dirPrefix));
 58 |             }
 59 |             $path = FileHelper::createUrl(
 60 |                     $settings->criticalPath,
 61 |                     $name
 62 |                 ) . $settings->criticalSuffix;
 63 | 
 64 |             return $this->getCssInlineTags($path, $attributes);
 65 |         }
 66 | 
 67 |         return '';
 68 |     }
 69 | 
 70 |     /**
 71 |      * Returns the passed in CSS file at the specified file system path or URL, wrapped in
 72 |      * <style></style> tags
 73 |      *
 74 |      * @param string $path
 75 |      * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
 76 |      *
 77 |      * @return string
 78 |      */
 79 |     public function getCssInlineTags(string $path, array $attributes = []): string
 80 |     {
 81 |         /** @var Settings $settings */
 82 |         $settings = Vite::$plugin->getSettings();
 83 |         $result = FileHelper::fetch($path, null, $settings->cacheKeySuffix);
 84 |         if ($result) {
 85 |             $config = [];
 86 | 
 87 |             return Html::style($result, array_merge($config, $attributes));
 88 |         }
 89 | 
 90 |         return '';
 91 |     }
 92 | 
 93 |     /**
 94 |      * Return the hash value for the first CSS file bundled with the module specified via $path
 95 |      *
 96 |      * @param $path
 97 |      * @return string
 98 |      */
 99 |     public function getCssHash($path): string
100 |     {
101 |         /** @var Settings $settings */
102 |         $settings = Vite::$plugin->getSettings();
103 |         ManifestHelper::fetchManifest($settings->manifestPath);
104 |         $tags = ManifestHelper::manifestTags($path, false);
105 |         foreach ($tags as $tag) {
106 |             if (!empty($tag) && $tag['type'] === 'css') {
107 |                 // Extract only the Hash Value
108 |                 $modulePath = pathinfo($tag['url']);
109 |                 $moduleFilename = $modulePath['filename'];
110 |                 $hashPos = strpos($moduleFilename, '.') ?: strlen($moduleFilename);
111 |                 $moduleHash = substr($moduleFilename, $hashPos + 1);
112 |                 // Vite 5 now uses a `-` to separate the version hash, so account for that as well
113 |                 if (empty($moduleHash) && str_contains($moduleFilename, '-')) {
114 |                     $moduleHash = substr($moduleFilename, strpos($moduleFilename, '-') + 1);
115 |                 }
116 | 
117 |                 return $moduleHash;
118 |             }
119 |         }
120 | 
121 |         return '';
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/src/Vite.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Vite plugin for Craft CMS
  4 |  *
  5 |  * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
  6 |  *
  7 |  * @link      https://nystudio107.com
  8 |  * @copyright Copyright (c) 2021 nystudio107
  9 |  */
 10 | 
 11 | namespace nystudio107\vite;
 12 | 
 13 | use Craft;
 14 | use craft\base\Model;
 15 | use craft\base\Plugin;
 16 | use craft\cloud\cli\controllers\UpController;
 17 | use craft\events\CancelableEvent;
 18 | use craft\events\RegisterCacheOptionsEvent;
 19 | use craft\events\TemplateEvent;
 20 | use craft\utilities\ClearCaches;
 21 | use craft\web\twig\variables\CraftVariable;
 22 | use craft\web\View;
 23 | use nystudio107\vite\models\Settings;
 24 | use nystudio107\vite\services\ServicesTrait;
 25 | use nystudio107\vite\variables\ViteVariable;
 26 | use yii\base\Event;
 27 | 
 28 | /**
 29 |  * Class Vite
 30 |  *
 31 |  * @author    nystudio107
 32 |  * @package   Vite
 33 |  * @since     1.0.0
 34 |  */
 35 | class Vite extends Plugin
 36 | {
 37 |     // Traits
 38 |     // =========================================================================
 39 | 
 40 |     use ServicesTrait;
 41 | 
 42 |     // Static Properties
 43 |     // =========================================================================
 44 | 
 45 |     /**
 46 |      * @var Vite
 47 |      */
 48 |     public static Plugin $plugin;
 49 | 
 50 |     /**
 51 |      * @var string
 52 |      */
 53 |     public static string $templateName;
 54 | 
 55 |     // Public Properties
 56 |     // =========================================================================
 57 | 
 58 |     /**
 59 |      * @var string
 60 |      */
 61 |     public string $schemaVersion = '1.0.0';
 62 | 
 63 |     /**
 64 |      * @var bool
 65 |      */
 66 |     public bool $hasCpSettings = false;
 67 | 
 68 |     /**
 69 |      * @var bool
 70 |      */
 71 |     public bool $hasCpSection = false;
 72 | 
 73 |     // Public Methods
 74 |     // =========================================================================
 75 | 
 76 |     /**
 77 |      * @inheritdoc
 78 |      */
 79 |     public function init(): void
 80 |     {
 81 |         parent::init();
 82 |         self::$plugin = $this;
 83 |         // Add our event listeners
 84 |         $this->installEventListeners();
 85 |         // Log that the plugin has loaded
 86 |         Craft::info(
 87 |             Craft::t(
 88 |                 'vite',
 89 |                 '{name} plugin loaded',
 90 |                 ['name' => $this->name]
 91 |             ),
 92 |             __METHOD__
 93 |         );
 94 |     }
 95 | 
 96 |     /**
 97 |      * Clear all the caches!
 98 |      */
 99 |     public function clearAllCaches(): void
100 |     {
101 |         // Clear all of Vite's caches
102 |         $this->vite->invalidateCaches();
103 |     }
104 | 
105 |     // Protected Methods
106 |     // =========================================================================
107 | 
108 |     /**
109 |      * Install our event listeners.
110 |      */
111 |     protected function installEventListeners(): void
112 |     {
113 |         // Register our variable
114 |         Event::on(
115 |             CraftVariable::class,
116 |             CraftVariable::EVENT_INIT,
117 |             function(Event $event) {
118 |                 /** @var CraftVariable $variable */
119 |                 $variable = $event->sender;
120 |                 $variable->set('vite', [
121 |                     'class' => ViteVariable::class,
122 |                     'viteService' => $this->vite,
123 |                 ]);
124 |             }
125 |         );
126 |         // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
127 |         Event::on(
128 |             ClearCaches::class,
129 |             ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
130 |             function(RegisterCacheOptionsEvent $event) {
131 |                 Craft::debug(
132 |                     'ClearCaches::EVENT_REGISTER_CACHE_OPTIONS',
133 |                     __METHOD__
134 |                 );
135 |                 // Register our caches for the Clear Cache Utility
136 |                 $event->options = array_merge(
137 |                     $event->options,
138 |                     $this->customAdminCpCacheOptions()
139 |                 );
140 |             }
141 |         );
142 |         // Remember the name of the currently rendering template
143 |         // Handler: View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE
144 |         Event::on(
145 |             View::class,
146 |             View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE,
147 |             static function(TemplateEvent $event) {
148 |                 self::$templateName = $event->template;
149 |             }
150 |         );
151 |         // Clears cache after craft cloud/up is run, which Craft Cloud runs on deploy
152 |         // Handler: UpController::EVENT_AFTER_UP
153 |         if (class_exists(UpController::class)) {
154 |             Event::on(
155 |                 UpController::class,
156 |                 UpController::EVENT_AFTER_UP,
157 |                 function(CancelableEvent $event) {
158 |                     $this->clearAllCaches();
159 |                 }
160 |             );
161 |         }
162 |     }
163 | 
164 |     /**
165 |      * Returns the custom Control Panel cache options.
166 |      *
167 |      * @return array
168 |      */
169 |     protected function customAdminCpCacheOptions(): array
170 |     {
171 |         return [
172 |             // Manifest cache
173 |             [
174 |                 'key' => 'vite-file-cache',
175 |                 'label' => Craft::t('vite', 'Vite Cache'),
176 |                 'action' => [$this, 'clearAllCaches'],
177 |             ],
178 |         ];
179 |     }
180 | 
181 |     /**
182 |      * @inheritdoc
183 |      */
184 |     protected function createSettingsModel(): ?Model
185 |     {
186 |         return new Settings();
187 |     }
188 | }
189 | 


--------------------------------------------------------------------------------