trucks-plugin-write

Write output files to disc

Usage no npm install needed!

<script type="module">
  import trucksPluginWrite from 'https://cdn.skypack.dev/trucks-plugin-write';
</script>

README

Write

Write output files to disc

Writes the output files created by the compiler plugins to disc.

Install

npm i trucks-plugin-write --save-dev

Usage

This plugin is bundled with the core trucks-compiler library.

You can configure this plugin using the write field:

const options {
  conf: {
    plugins: {
      write: {
        /* write plugin configuration */
      }
    }
  }
}

Or as a convenient shortcut use the top-level write field:

const options {
  force: true,
  write: {
    manifest: false
  }
}

API

write

public write(state, conf)

Write output files to disc.

For each file in the output of the compiler state write the file to disc creating parent directories as needed unless the mkdirs option is disabled.

When exclude is given it should be a regular expression or array or patterns to compare against the absolute file path for each file to be written, if a pattern matches the file is not written to disc.

If the manifest option is enabled a manifest object is created on the compiler state which maps file paths to checksums for each file written. Each manifest entry contains size and checksum fields.

The force option is inherited from the computed options when not defined on the plugin configuration.

Returns plugin closure.

  • state Object compiler state.
  • conf Object plugin configuration.

Options

  • force Boolean=false force overwrite existing files.
  • exclude Array list of regexp patterns to exclude.
  • mkdirs Boolean=true create parent directories.
  • manifest Boolean=true generate manifest checksums.
  • hash String=sha256 checksum hash algorithm.

License

MIT

Created by mkdoc on August 5, 2016