Skip to content

Build Plugin Base

Use the ClientBuilderBase to implement a new stage or custom handling during the frontend build lifecycle. Note that this API is still under development and might change between minor Mountaineer versions.

mountaineer.client_compiler.base.ClientBuilderBase

ClientBuilderBase()

Bases: ABC

Base class for client builders. When mounted to an AppController, these build plugins will be called for every file defined in the view/app directory. It's up to the plugin whether to handle the incoming file.

metadata instance-attribute

metadata = None

dirty_files instance-attribute

dirty_files = set()

controllers instance-attribute

controllers = []

set_metadata

set_metadata(metadata)

register_controller

register_controller(controller, view_path)

mark_file_dirty

mark_file_dirty(file_path)

build_wrapper async

build_wrapper()

All internal users should use this instead of .build()

build abstractmethod async

build()

Builds the dirty files.

managed_views_from_paths

managed_views_from_paths(paths)

Given a list of paths, assume these fall somewhere within the view directories specified by the controllers. Returns the ManagedViewPath objects for all paths where a match is found.