package
Helper base class for Broccoli plugins that map input files into output files one-to-many
npm install broccoli-multi-filterGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Latest published Aug 16, 2016
Helper base class for Broccoli plugins that map input files into output files
one-to-many. This class is a drop-in replacement for broccoli-filter.
class MultiFilter {
/**
* Abstract base-class for filtering purposes.
*
* Enforces that it is invoked on an instance of a class which prototypically
* inherits from Filter, and which is not itself Filter.
*/
constructor(inputNode: BroccoliNode, options: FilterOptions): MultiFilter;
/**
* Abstract method `processString`: must be implemented on subclasses of
* MultiFilter.
*
* The `addOutputFile` callback accepts two arguments `(contents: string, outputRelativeFilename: string)`
* this file must be called to generate any side-effect files and make sure they are handled properly with
* the caching layer.
*
* The return value is written as the contents of the output file
*/
abstract processString(contents: string, relativePath: string, addOutputFile: Function): string;
/**
* Virtual method `getDestFilePath`: determine whether the source file should
* be processed, and optionally rename the output file when processing occurs.
*
* Return `null` to pass the file through without processing. Return
* `relativePath` to process the file with `processString`. Return a
* different path to process the file with `processString` and rename it.
*
* By default, if the options passed into the `MultiFilter` constructor contain a
* property `extensions`, and `targetExtension` is supplied, the first matching
* extension in the list is replaced with the `targetExtension` option's value.
*/
virtual getDestFilePath(relativePath: string): string;
}extensions: An array of file extensions to process, e.g. ['md', 'markdown'].targetExtension: The file extension of the corresponding output files, e.g.
'html'.inputEncoding: The character encoding used for reading input files to be
processed (default: 'utf8'). For binary files, pass null to receive a
Buffer object in processString.outputEncoding: The character encoding used for writing output files after
processing (default: 'utf8'). For binary files, pass null and return a
Buffer object from processString.name, annotation: Same as
broccoli-plugin;
see there.All options except name and annotation can also be set on the prototype
instead of being passed into the constructor.
var MultiFilter = require('broccoli-multi-filter');
Awk.prototype = Object.create(MultiFilter.prototype);
Awk.prototype.constructor = Awk;
function Awk(inputNode, search, replace, options) {
options = options || {};
MultiFilter.call(this, inputNode, {
annotation: options.annotation
});
this.keepOriginal = options.keepOriginal;
this.search = search;
this.replace = replace;
}
Awk.prototype.extensions = ['txt'];
In Brocfile.js, use your new Awk plugin like so:
var node = new Awk('docs', 'ES6', 'ECMAScript 2015');
module.exports = node;broccoli-filterbroccoli-multi-filter.addOutputFile argument to your implementation of processString.addOutputFile to generate any additional files you need to generate.Estimated unpacked size across 27 packages.
5.0 MB
Includes dependencies.
9 direct · 6 outdated
^3.0.18
4.8.5
^2.2.0
4.4.3
^0.5.1
3.0.1
^0.2.6
4.0.2
^1.0.0
6.0.0
0.3.1