TYPO3 Vendor Bundler config

Configuration for TYPO3 Vendor Bundler, a Composer library to bundle vendor libraries for TYPO3 extensions in classic mode

Type object
File match typo3-vendor-bundler.json typo3-vendor-bundler.yaml typo3-vendor-bundler.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/typo3-vendor-bundler-config/latest.json
Source https://raw.githubusercontent.com/eliashaeussler/typo3-vendor-bundler/refs/heads/main/res/typo3-vendor-bundler.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

autoload object
3 nested properties
enabled boolean

When enabled, the autoload bundler will be included when executing composer bundle.

Default: true
backup boolean

When enabled, original contents of the root composer.json file will be backed up in a separate file

Default: false
excludeFromClassMap string[]

Absolute or relative paths to files to remove from parsed vendor libraries class map

dependencies object
3 nested properties
enabled boolean

When enabled, the dependency bundler will be included when executing composer bundle.

Default: true
sbom object
4 nested properties
file string

Can be a JSON or XML file. Relative paths are resolved based on the vendor libraries path.

Default: "sbom.json"
version string

All BOM versions supported by CycloneDX can be used.

Default: "1.7"
includeDev boolean

When enabled, all dev dependencies will be included in the generated SBOM. Otherwise, only production dependencies will be included.

Default: true
overwrite boolean

When enabled, the configured SBOM file will be overwritten with serialized SBOM, if the file already exists.

Default: false
backup boolean

When enabled, original contents of the root composer.json file will be backed up in a separate file

Default: false
dependencyExtraction object
2 nested properties
enabled boolean

When enabled, vendor libraries will be extracted from root composer.json, if no separate composer.json for vendor libraries exists already.

Default: true
failOnProblems boolean

When enabled, extraction will fail if problems are encountered during extraction, e.g. if packages cannot be resolved.

Default: true
pathToVendorLibraries string
Default: "Resources/Private/Libs"
rootPath string

This path will be used to calculate paths to configured files if they are configured as relative paths. If the root path is configured as relative path, it is calculated based on the config file path.

Definitions

autoload object
enabled boolean

When enabled, the autoload bundler will be included when executing composer bundle.

Default: true
backup boolean

When enabled, original contents of the root composer.json file will be backed up in a separate file

Default: false
excludeFromClassMap string[]

Absolute or relative paths to files to remove from parsed vendor libraries class map

dependencies object
enabled boolean

When enabled, the dependency bundler will be included when executing composer bundle.

Default: true
sbom object
4 nested properties
file string

Can be a JSON or XML file. Relative paths are resolved based on the vendor libraries path.

Default: "sbom.json"
version string

All BOM versions supported by CycloneDX can be used.

Default: "1.7"
includeDev boolean

When enabled, all dev dependencies will be included in the generated SBOM. Otherwise, only production dependencies will be included.

Default: true
overwrite boolean

When enabled, the configured SBOM file will be overwritten with serialized SBOM, if the file already exists.

Default: false
backup boolean

When enabled, original contents of the root composer.json file will be backed up in a separate file

Default: false
sbom object
file string

Can be a JSON or XML file. Relative paths are resolved based on the vendor libraries path.

Default: "sbom.json"
version string

All BOM versions supported by CycloneDX can be used.

Default: "1.7"
includeDev boolean

When enabled, all dev dependencies will be included in the generated SBOM. Otherwise, only production dependencies will be included.

Default: true
overwrite boolean

When enabled, the configured SBOM file will be overwritten with serialized SBOM, if the file already exists.

Default: false
dependencyExtraction object
enabled boolean

When enabled, vendor libraries will be extracted from root composer.json, if no separate composer.json for vendor libraries exists already.

Default: true
failOnProblems boolean

When enabled, extraction will fail if problems are encountered during extraction, e.g. if packages cannot be resolved.

Default: true