Type Config
File match .shopware-extension.yml .shopware-extension.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/shopware-cli-extension-store-configuration/latest.json
Source https://raw.githubusercontent.com/shopware/shopware-cli/main/shopware-extension-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: Config

Definitions

ChangelogConfig object
enabled boolean

Specifies whether the changelog should be generated.

pattern string

Specifies the pattern to match the commits.

template string

Specifies the template to use for the changelog.

variables Record<string, string>

Specifies the variables to use for the changelog.

Config object
compatibility_date string

Controls date-based compatibility behavior, formatted as YYYY-MM-DD.

format=date
store object
18 nested properties
availabilities string[]

Specifies the visibility in stores.

default_locale string

Specifies the default locale.

Values: "de_DE" "en_GB"
localizations string[]

Specifies the languages the extension is translated.

categories string[]

Specifies the categories.

type string

Specifies the type of the extension.

Values: "extension" "theme"
icon string

Specifies the Path to the icon (256x256 px) for store.

automatic_bugfix_version_compatibility boolean

Specifies whether the extension should automatically be set compatible with Shopware bugfix versions.

Specifies the meta title of the extension in store.

meta_description ConfigTranslated%5Bstring%5D

Specifies the meta description of the extension in store.

Specifies the description of the extension in store.

installation_manual ConfigTranslated%5Bstring%5D

Installation manual of the extension in store.

Specifies the tags of the extension.

Specifies the links of YouTube-Videos to show or describe the extension.

Specifies the highlights of the extension.

Specifies the features of the extension.

Specifies Frequently Asked Questions for the extension.

Specifies images for the extension in the store.

image_directory string

Specifies the directory where the images are located.

build object
3 nested properties
extraBundles ConfigExtraBundle[]

ExtraBundles can be used to declare additional bundles to be considered for building

shopwareVersionConstraint string

Override the shopware version constraint for building, can be used to specify the version of the shopware to use for building

zip object

Configuration for zipping.

4 nested properties
composer object
assets object
pack object
checksum object

Configuration for checksum calculation.

changelog object
4 nested properties
enabled boolean

Specifies whether the changelog should be generated.

pattern string

Specifies the pattern to match the commits.

template string

Specifies the template to use for the changelog.

variables Record<string, string>

Specifies the variables to use for the changelog.

validation object

ConfigValidation is used to configure the extension validation.

2 nested properties
store_compliance boolean
ConfigBuild object
extraBundles ConfigExtraBundle[]

ExtraBundles can be used to declare additional bundles to be considered for building

shopwareVersionConstraint string

Override the shopware version constraint for building, can be used to specify the version of the shopware to use for building

zip object

Configuration for zipping.

4 nested properties
composer object
4 nested properties
enabled boolean

When enabled, a vendor folder will be created in the zip build

before_hooks string[]

Commands to run before the composer install

after_hooks string[]

Commands to run after the composer install

excluded_packages string[]

Composer packages to be excluded from the zip build

assets object
8 nested properties
enabled boolean

When enabled, the shopware-cli build the assets

before_hooks string[]

Commands to run before the assets build

after_hooks string[]

Commands to run after the assets build

enable_es_build_for_admin boolean

When enabled, builtin esbuild will be used for the admin assets

enable_es_build_for_storefront boolean

When enabled, builtin esbuild will be used for the storefront assets

disable_sass boolean

When disabled, builtin sass support will be disabled

npm_strict boolean

When enabled, npm will install only production dependencies

Additional paths to include in asset caching

pack object
2 nested properties
excludes object
before_hooks string[]

Commands to run before the pack

checksum object

Configuration for checksum calculation.

1 nested properties
ignore string[]

Following files will be excluded from the checksum calculation

ConfigBuildZip object

Configuration for zipping.

composer object
4 nested properties
enabled boolean

When enabled, a vendor folder will be created in the zip build

before_hooks string[]

Commands to run before the composer install

after_hooks string[]

Commands to run after the composer install

excluded_packages string[]

Composer packages to be excluded from the zip build

assets object
8 nested properties
enabled boolean

When enabled, the shopware-cli build the assets

before_hooks string[]

Commands to run before the assets build

after_hooks string[]

Commands to run after the assets build

enable_es_build_for_admin boolean

When enabled, builtin esbuild will be used for the admin assets

enable_es_build_for_storefront boolean

When enabled, builtin esbuild will be used for the storefront assets

disable_sass boolean

When disabled, builtin sass support will be disabled

npm_strict boolean

When enabled, npm will install only production dependencies

Additional paths to include in asset caching

pack object
2 nested properties
excludes object
1 nested properties
paths string[]

Paths to exclude from the zip build

before_hooks string[]

Commands to run before the pack

checksum object

Configuration for checksum calculation.

1 nested properties
ignore string[]

Following files will be excluded from the checksum calculation

ConfigBuildZipAssets object
enabled boolean

When enabled, the shopware-cli build the assets

before_hooks string[]

Commands to run before the assets build

after_hooks string[]

Commands to run after the assets build

enable_es_build_for_admin boolean

When enabled, builtin esbuild will be used for the admin assets

enable_es_build_for_storefront boolean

When enabled, builtin esbuild will be used for the storefront assets

disable_sass boolean

When disabled, builtin sass support will be disabled

npm_strict boolean

When enabled, npm will install only production dependencies

Additional paths to include in asset caching

ConfigBuildZipAssetsAdditionalCache object
path string

The output path to cache, relative to extension root

source_paths string[]

Source paths to hash for the cache key, relative to extension root

ConfigBuildZipChecksum object

Configuration for checksum calculation.

ignore string[]

Following files will be excluded from the checksum calculation

ConfigBuildZipComposer object
enabled boolean

When enabled, a vendor folder will be created in the zip build

before_hooks string[]

Commands to run before the composer install

after_hooks string[]

Commands to run after the composer install

excluded_packages string[]

Composer packages to be excluded from the zip build

ConfigBuildZipPack object
excludes object
1 nested properties
paths string[]

Paths to exclude from the zip build

before_hooks string[]

Commands to run before the pack

ConfigBuildZipPackExcludes object
paths string[]

Paths to exclude from the zip build

ConfigExtraBundle object
path string

Path to the bundle, relative from the extension root (src folder)

name string

Name of the bundle, if empty the folder name of path will be used

ConfigStore object
availabilities string[]

Specifies the visibility in stores.

default_locale string

Specifies the default locale.

Values: "de_DE" "en_GB"
localizations string[]

Specifies the languages the extension is translated.

categories string[]

Specifies the categories.

type string

Specifies the type of the extension.

Values: "extension" "theme"
icon string

Specifies the Path to the icon (256x256 px) for store.

automatic_bugfix_version_compatibility boolean

Specifies whether the extension should automatically be set compatible with Shopware bugfix versions.

Specifies the meta title of the extension in store.

meta_description ConfigTranslated%5Bstring%5D

Specifies the meta description of the extension in store.

Specifies the description of the extension in store.

installation_manual ConfigTranslated%5Bstring%5D

Installation manual of the extension in store.

Specifies the tags of the extension.

Specifies the links of YouTube-Videos to show or describe the extension.

Specifies the highlights of the extension.

Specifies the features of the extension.

Specifies Frequently Asked Questions for the extension.

Specifies images for the extension in the store.

image_directory string

Specifies the directory where the images are located.

ConfigStoreFaq object
question string
answer string
position integer
ConfigStoreImage object
file string

File path to image relative from root of the extension

activate object
2 nested properties
de boolean
en boolean
preview object
2 nested properties
de boolean
en boolean
priority integer

Specifies the order of the image ascending the given priority.

ConfigStoreImageActivate object
de boolean
en boolean
ConfigStoreImagePreview object
de boolean
en boolean
ConfigTranslated[ConfigStoreFaq] object
ConfigTranslated[[]string] object
de string[]
en string[]
ConfigTranslated[string] object
de string
en string
ConfigValidation object

ConfigValidation is used to configure the extension validation.

store_compliance boolean
ConfigValidationList ToolConfigIgnore[]
ToolConfigIgnore object | string