README

TYPO3 Vendor Bundler

A Composer plugin to bundle vendor libraries of TYPO3 extensions for use in classic mode. It allows to easily prepare dependencies, which are not part of TYPO3's bundled dependencies, in order to make TYPO3 extensions fully usable in classic mode installations.

🚀 Features

• Autoload bundler: Bundles autoload information from vendor libraries in root composer.json file. This enables deep integration of vendor libraries directly into TYPO3, e.g. for use with dependency injection.
• Dependency bundler: Bundles dependency information of shipped vendor libraries. Uses the standardized CycloneDX format to generate a Software Bill of Materials (SBOM).
• Automatic dependency extraction: Allows to automatically extract used vendor libraries from the root composer.json file of an extension.
• Various configuration options: Provides an extensive configuration system, which allows to customize several parts of the bundling system.
• Composer integration: Built as Composer plugin, the package provides a smooth integration in your Composer workflow. Bundlers can be executed directly by using dedicated Composer commands, e.g. composer bundle to execute all available bundlers.

🔥 Installation

composer require --dev eliashaeussler/typo3-vendor-bundler

⚡ Quickstart

Add a typo3-vendor-bundler.yaml config file:

# typo3-vendor-bundler.yaml

autoload:
  target:
    file: 'composer.json'
    overwrite: true
  backupSources: false
  excludeFromClassMap:
    - 'vendor/composer/InstalledVersions.php'

dependencies:
  sbom:
    file: 'sbom.json'
    version: '1.7'
    includeDev: false
    overwrite: true

dependencyExtraction:
  enabled: true
  failOnProblems: true

pathToVendorLibraries: 'Resources/Private/Libs'

Execute the main bundler:

composer bundle

You can also execute a single bundler. Read more about available console commands.

Tip

You can use the composer validate-bundler-config command to validate your config file.

📝 Documentation

• Features
  • Autoload bundler
  • Dependencies bundler
  • Automatic dependency extraction
• Usage
  • Console commands
  • Continuous Integration
  • PHP API
• Configuration
  • Config file
  • Schema

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

⭐ License

This project is licensed under GNU General Public License 3.0 (or later).