# Bundles Output Bundler

This is a bundler plugin for use with [Bundles](https://github.com/brikcss/bundles-core). `bundles-output` outputs the data and content compiled by Bundles to disk. ## Environment support | Node | CLI | ES Module | Browser | UMD | | :--: | :-: | :-------: | :-----: | :-: | | ✓ | ✓ | ✓ | x | x | ## Install Make sure [Bundles core is installed](https://github.com/brikcss/bundles-core#install). ```sh npm install @bundles/bundles-output -D ``` ## Usage See [configuring Bundles](https://github.com/brikcss/bundles-core#configuration) for details on configuring Bundles. ### Configuration **IMPORTANT: Unless you know what you're doing, `bundles-output` should be the last bundler in the `config.bundlers` Array, since it should typically run after all other bundlers have run.** The following properties are available in `bundler.options`: - **`to`** _{String|Function}_ _(required)_ Directory to output compiled data to. Can be a callback Function which returns a String. If return value is falsy, or is not a String, the file will not be output. - **`root`** _{String}_ _(process.cwd())_ Root directory for source input paths. For example, settings of `{ to: 'output', root: 'my/dir' }` with a source input of `['my/dir/one.md', 'my/dir/subdir/two.md']` will output files to `output/one.md` and `output/subdir/two.md`. - **`incremental`** \{Boolean\} _[true]_ When watching files, whether to utilize the incremental build feature (`true`) or always output all files (`false`). - **`fs`** Options passed to [fs-extra's `outputFile` method](https://github.com/jprichardson/node-fs-extra), which are the same options passed to [node fs's `writeFile` method](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback). This, for example, gives user control over whether existing files are overwritten. _Note: The `encoding` option is automatically set based on whether the file type is text/utf8 or binary._ ### Example ```js // Outputs `src/my/file.md` to `my/dir/my/file.md`. const bundle = { input: 'src/my/file.md', bundlers: [ { run: '@bundles/bundles-output', options: { to: 'my/dir', root: 'src', incremental: true, }, }, ], }; ```