metalsmith-env

    2.2.0 • Public • Published

    Metalsmith Enviromental Variables Plugin npm version

    Build Status Dependency Status Greenkeeper badge

    Metalsmith plugin to register all environmental variables as metadata.

    Installation

    npm install --save metalsmith-env
    

    CLI

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

    {
      "plugins": {
        "metalsmith-env": {}
      }
    }

    JavaScript

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

    var env = require('metalsmith-env');
    
    metalsmith.use(env());

    Usage

    Once installed, all environment variables, from process.env, become available as Metalsmith metadata.

    Options

    opts.variables

    An array of default variables that will be available. Environmental variables will then override the default set.

    opts.overrides

    An array of variables that will completely override the given set of environmental variables.

    opts.env

    The assumed environmental variables, defaults to process.env.

    opts.metadatakey

    Store the environmental variables under a metadata[metadatakey] instead of merging into metadata.

    Example

    The following example uses Jade and Metalsmith JSTransformer:

    index.pug

    ---
    title: Environmental Variables
    ---
    doctype html
    html(lang="en")
      head
        title= title
      body
        h1= title
        p This is the environmental variable "NODE_ENV":
        code
          pre= NODE_ENV

    Build

    $ NODE_ENV=production node_modules/.bin/metalsmith
    

    Result

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <title>Environmental Variables</title>
      </head>
      <body>
        <h1>Environmental Variables</h1>
        <p>This is the environmental variable "NODE_ENV":</p>
        <code><pre>production</pre></code>
      </body>
    </html>

    License

    MIT

    Keywords

    Install

    npm i metalsmith-env

    DownloadsWeekly Downloads

    130

    Version

    2.2.0

    License

    MIT

    Unpacked Size

    6.37 kB

    Total Files

    5

    Last publish

    Collaborators

    • robloach