metalsmith-concat-convention v1.2.1

Metalsmith Concat Convention Plugin

Metalsmith plugin to concatenate files through file conventions.

Installation

npm install --save metalsmith-concat-convention

CLI

If you are using the command-line version of Metalsmith, you can install via npm, and then add the metalsmith-concat-convention key to your metalsmith.json file:

{
  "plugins": {
    "metalsmith-concat-convention": {
      "extname": ".concat"
    }
  }
}

JavaScript

If you are using the JS Api for Metalsmith, then you can require the module and add it to your .use() directives:

var concat = require('metalsmith-concat-convention');

metalsmith.use(concat({
  extname: '.concat'
}));

Usage

Each concatenation is handled through naming the destination file <name>.concat. The file's metadata options are passed off to metalsmith-concat to output the concatenated files. All metalsmith-concat options apply, aside from output, which is provided by the filename itself.

Example

src/scripts.js.concat

---
files:
- script1.js
- script2.js
insertNewLine: false
---
// This is the collection of all scripts.

The above will result in scripts.js being script1.js, script2.js, along with the ending content comment.

License

MIT