Skip to content

Bundlers: Print warnings if alphaTab plugins are not used #2314

@Danielku15

Description

@Danielku15

Current Situation: If a developer integrates alphaTab without reading the bundler docs, or if for unknown reasons a custom bundler config is not picked up, it can easily happen that alphaTab is "bundled" in the wrong way without the developer knowing what's going on.

Proposed improvement: We have some means of detecting that alphaTab is being bundled with WebPack or Vite thanks to some globals being injected by plugins. We should additionally inject some metadata into the bundler which allows us to detect if the respective alphaTab bundler plugin is active.

If the alphaTab plugin is missing, we should emit a warning during runtime that the plugin is missing so devs can act accordingly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-bundlersRelated to the bundler plugins like webpack and viteplatform-javascriptRelated to the JavaScript version of alphaTabstate-acceptedThis is a valid topic to work on.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions