https://github.com/s2b/vite-plugin-typo3

Vite Plugin that collects entrypoints from TYPO3 extensions
https://github.com/s2b/vite-plugin-typo3

build frontend typo3 vite vitejs

Last synced: 3 months ago
JSON representation

Vite Plugin that collects entrypoints from TYPO3 extensions

• Host: GitHub
• URL: https://github.com/s2b/vite-plugin-typo3
• Owner: s2b
• License: mit
• Created: 2024-05-10T20:28:16.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-19T15:23:47.000Z (4 months ago)
• Last Synced: 2024-10-19T18:54:26.942Z (4 months ago)
• Topics: build, frontend, typo3, vite, vitejs
• Language: TypeScript
• Homepage:
• Size: 119 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• fucking-awesome-vite - vite-plugin-typo3 - Frontend integration for TYPO3 CMS. (Integrations with Backends / TYPO3 CMS)
• awesome-vite - vite-plugin-typo3 - Frontend integration for TYPO3 CMS. (Integrations with Backends / TYPO3 CMS)

README

        
# TYPO3 Vite Plugin

This vite plugin collects entrypoints from TYPO3 extensions in a composer-based

TYPO3 setup.

## Installation

```sh

npm install --save-dev vite-plugin-typo3

```

This plugin is intended to be used together with

**[vite_asset_collector](https://github.com/s2b/vite-asset-collector)**.

## Setup

Setup vite in your TYPO3 project:

**vite.config.js:**

```js

import { defineConfig } from "vite";

import typo3 from "vite-plugin-typo3";

export default defineConfig({

    plugins: [typo3()],

});

```

Provide entrypoints from an installed TYPO3 extension:

**EXT:my_extension/Configuration/ViteEntrypoints.json:**

```json

[

    "../Resources/Private/JavaScript/Main.entry.js",

    "../Resources/Private/Entrypoints/*.entry.js"

]

```

Wildcards are possible, relative paths are relative to the location of the json file.

## Configuration

### Vite Configuration

The plugin tries to be as unintrusive as possible by only setting configuration

values if they haven't been set already by the user. For example, if you want to

use a custom manifest file name, you can set it as usual in your **vite.config.js**:

```js

export default defineConfig({

    plugins: [typo3()],

    build: {

        manifest: ".vite/custom-manifest-name.json",

    },

});

```

### Plugin Configuration

You can provide additional configuration to the plugin, for example:

```js

    plugins: [typo3({ debug: true })],

```

-   `target` (string, default `project`): If set to `extension`, vite can be used to bundle

    asset files for a singular TYPO3 extension. By default, they will be put into

    `Resources/Public/Vite/` and retain their original file names. For JS files, both ESM and CJS

    variants will be generated. This mode can only be used with `vite build`, not with the dev

    server.

-   `debug` (boolean, default `false`): Show TYPO3-related debugging information in vite's

    cli output

-   `entrypointFile` (string, default `Configuration/ViteEntrypoints.json`): Use a different

    file to provide entrypoints from extensions.

-   `entrypointIgnorePatterns` (array, default: `["**/node_modules/**", "**/.git/**"]`): Files

    that should be ignored when using wildcards in `ViteEntrypoints.json`.