Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s2b/vite-asset-collector
Bundle your TYPO3 frontend assets with Vite
https://github.com/s2b/vite-asset-collector
build fluid frontend typo3 viewhelper vite watcher
Last synced: about 1 month ago
JSON representation
Bundle your TYPO3 frontend assets with Vite
- Host: GitHub
- URL: https://github.com/s2b/vite-asset-collector
- Owner: s2b
- License: gpl-2.0
- Created: 2023-05-04T16:14:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-19T09:36:47.000Z (2 months ago)
- Last Synced: 2024-03-19T10:50:54.621Z (2 months ago)
- Topics: build, fluid, frontend, typo3, viewhelper, vite, watcher
- Language: PHP
- Homepage:
- Size: 120 KB
- Stars: 26
- Watchers: 3
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-vite - vite-asset-collector for TYPO3 - Integration for TYPO3 CMS. (Integrations with Backends / TYPO3 CMS)
README
# Vite AssetCollector for TYPO3
[](https://codeclimate.com/github/s2b/vite-asset-collector/maintainability)
[](https://codeclimate.com/github/s2b/vite-asset-collector/test_coverage)
[](https://github.com/s2b/vite-asset-collector/actions/workflows/tests.yaml)
[](https://extensions.typo3.org/extension/vite_asset_collector)
[](https://extensions.typo3.org/extension/vite_asset_collector)
[](https://extensions.typo3.org/extension/vite_asset_collector)
Bundle your TYPO3 frontend assets with **[vite](https://vitejs.dev/)**, a modern
and flexible frontend tool. This TYPO3 extension provides a future-proof
integration for vite using TYPO3's AssetCollector API.
This means that you can use vite's hot reloading and hot module replacement features
(and many others) in your TYPO3 projects.
This extension is inspired by
[typo3-vite-demo](https://github.com/fgeierst/typo3-vite-demo) which was created
by [Florian Geierstanger](https://github.com/fgeierst/).
## Installation
Vite AssetCollector can be installed with composer:
```sh
composer req praetorius/vite-asset-collector
```
vite can be installed with the frontend package manager of your choice:
```sh
npm install --save-dev vite vite-plugin-auto-origin
```
*[vite-plugin-auto-origin](https://www.npmjs.com/package/vite-plugin-auto-origin)
is recommended as it simplifies configuration and daily usage of vite with TYPO3.*
## Getting Started
### 1. Vite Setup
To get things started, the extension provides a console command that generates a
ready-to-use `vite.config.js` file:
```sh
vendor/bin/typo3 vite:config --entry 'EXT:sitepackage/Resources/Private/Main.entry.js' --outputfile ./vite.config.js
```
The generated configuration makes sure that vite
* knows the location of your main JavaScript file, also known as *entrypoint*
* generates a `manifest.json` file
* outputs assets to a publicly accessible directory
Note that the console command is only intended as a kickstarter for your initial
vite configuration file.
More Options
* You can define multiple `--entry` options.
* You can add `--glob` to enable pattern matching for your entrypoint paths
([fast-glob](https://www.npmjs.com/package/fast-glob) required).
* If you omit `--outputfile`, the file content will be outputted instead.
* Add `--no-auto-origin` if you don't want to use
[vite-plugin-auto-origin](https://www.npmjs.com/package/vite-plugin-auto-origin).
Note that you need to specify `VITE_DEV_ORIGIN` manually then.
* `--help` shows all available options.
### 2. TYPO3 Setup
Then you can use the included ViewHelper to embed your assets. If you use the default
configuration, you only need to specify your entrypoint.
**Layouts/Default.html**:
```xml
...
```
### 3. Start Developing
Development environments can be highly individual. However, if ddev is your
tool of choice for local development, a few steps can get you started with
a ready-to-use development environment with vite, composer and TYPO3.
[Instructions for DDEV](./Documentation/DdevSetup.md)
## Configuration
If you use the setup as described above, no configuration should be necessary.
However, you can customize almost everything to create your individual development
setup:
Adjust vite dev server
The extension has two configuration options to setup the vite dev server.
By default, both are set to `auto`, which means:
* Dev server will only be used in `Development` context
* Dev server uri will be determined automatically for environments with
[vite-serve for DDEV](https://github.com/torenware/ddev-viteserve) set up
You can adjust both options in your `$TYPO3_CONF_VARS`, for example:
```php
// Setup vite dev server based on configuration in .env file
// TYPO3_VITE_DEV_SERVER='https://localhost:1234'
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['vite_asset_collector']['useDevServer'] = (bool) getenv('TYPO3_VITE_DEV_SERVER');
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['vite_asset_collector']['devServerUri'] = (string) getenv('TYPO3_VITE_DEV_SERVER');
```
Change location of default manifest.json
You can specify a default manifest file in the extension configuration.
By default, this is set to `_assets/vite/.vite/manifest.json`, so it will run
out-of-the-box with vite 5 if you generated your vite configuration with this
extension. If you still use vite < 5, you should to change this to
`_assets/vite/manifest.json`.
If you change the path here, please be aware that you may need to adjust your
the `outDir` in your `vite.config.js` as well:
```php
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['vite_asset_collector']['defaultManifest'] = 'EXT:sitepackage/Resources/Public/Vite/.vite/manifest.json';
```
If you use the `vite.config.js` provided by the extension:
```js
// Output path for generated assets
const VITE_OUTPUT_PATH = 'packages/sitepackage/Resources/Public/Vite/';
```
If you use your own `vite.config.js`:
```js
export default defineConfig({
// ...
outDir: 'path/to/sitepackage/Resources/Public/Vite/',
})
```
## ViewHelper Reference
### asset.vite ViteHelper
The `asset.vite` ViewHelper embeds all JavaScript and CSS belonging to the
specified vite `entry` using TYPO3's AssetCollector API.
Arguments
* `manifest` (type: `string`): Path to your manifest.json file. If omitted,
default manifest from extension configuration will be used instead.
* `entry` (type: `string`): Identifier of the desired vite entrypoint;
this is the value specified as `input` in the vite configuration file. Can be
omitted if manifest file exists and only one entrypoint is present.
* `devTagAttributes` (type: `array`): HTML attributes that should be added to
script tags that point to the vite dev server
* `scriptTagAttributes` (type: `array`): HTML attributes that should be added
to script tags for built JavaScript assets
* `cssTagAttributes` (type: `array`): HTML attributes that should be added to
css link tags for built CSS assets
* `priority` (type: `bool`, default: `false`): Include assets before other assets
in HTML
* `useNonce` (type: `bool`, default: `false`): Whether to use the global nonce value
* `addCss` (type: `bool`, default: `true`): If set to `false`, CSS files associated
with the entry point won't be added to the asset collector
Example
```xml
```
### resource.vite ViteHelper
The `resource.vite` ViewHelper extracts the uri to one specific asset file from a vite
manifest file.
Arguments
* `manifest` (type: `string`): Path to your manifest.json file. If omitted,
default manifest from extension configuration will be used instead.
* `file` (type: `string`): Identifier of the desired asset file for which a uri
should be generated
Example
This can be used to preload certain assets in the HTML `` tag:
```xml
```
## Vite Assets in Yaml Files
Besides ViewHelpers, the extension includes a processor for Yaml files, which allows you
to use assets generated by vite in your configuration files. This is especially useful for
[custom RTE presets](https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/Configuration/Examples.html):
```yaml
editor:
config:
contentsCss:
# Using the default manifest file
- "%vite('EXT:sitepackage/Resources/Private/Css/Rte.css')%"
# Using another manifest.json
- "%vite('EXT:sitepackage/Resources/Private/Css/Rte.css', 'path/to/manifest.json')%"
```
## TYPO3 Icon API
The extension includes a custom `SvgIconProvider` for the
[TYPO3 Icon API](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Icon/Index.html),
which allows you to register SVG icon files generated by vite. This works both in frontend
and backend context.
To register a new icon, add the following to the `Configuration/Icons.php` file:
```php
return [
'site-logo' => [
'provider' => \Praetorius\ViteAssetCollector\IconProvider\SvgIconProvider::class,
'source' => 'assets/Image/Icon/typo3.svg',
'manifest' => 'path/to/manifest.json', // optional, defaults to defaultManifest
],
];
```
Then you can use the [core:icon ViewHelper](https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/core/latest/Icon.html)
to use the icon in your templates.