Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.21 KB

STRATEGY_API.md

File metadata and controls

16 lines (10 loc) · 1.21 KB
Raw

Concat Strategies

broccoli-concat performs file concatenation by using an internal representation called a Strategy. You can provide a custom Strategy to change how concatenation is done and what features are supported.

By default, broccoli-concat ships with SimpleConcat as it's default concatenation strategy. It also includes fast-sourcemap-concat as a dependency to use when concatenating with sourcemaps.

Strategy API

To provide a custom Strategy, you must provide a class that includes the following methods:

  • addFile(file, content): Receives a path to a file and its contents to include in the concatenated output.
  • updateFile(file, content): Receives a path to a file and its contents that need to be updated in the previously concatenated output.
  • removeFile(file): Receives a path to a file that needs to be removed in the previously concatenated output.
  • result(): Is expected to return the concatenated result of the above operations as a string. It should also return undefined if there was no input to the operation.

The above methods are intended to represent a "patch-based" approach to concatenating files.