aymericbeaumet/metalsmith-define

:speech_balloon: Metalsmith plugin to define values in the metadata

metalsmith-define

This plugin enables you to define custom values in the metadata. Why you would use it for is up to you, but here are some ideas:

• expose a node module (e.g.: Lodash) in the metadata to use it in a template
• expose process.env to your templates (NODE_ENV, etc)
• expose JSON files (e.g.: expose the package.json file similarly to how it could be done in a Gruntfile)
• expose your own JavaScript modules (e.g.: define custom helper functions)

Note that Metalsmith now has a metalsmith.metadata() method, which overlaps some areas covered by this plugin. Though metalsmith-define still proves valuable in some situations:

1. You want to define metadata but you only use the CLI version of Metalsmith (with no access to the API)
2. You use the API, but the source of your metadata is not an Object. This plugin, on the other hand, supports any iterable: Array, Class, Map, etc.

Install

npm install metalsmith-define

Usage

CLI

metalsmith.json

{
  "plugins": {
    "metalsmith-define": {
      "production": true
    }
  }
}

Node.js

const metalsmith = require('metalsmith')
const metalsmithDefine = require('metalsmith-define')

metalsmith(__dirname).use(
  metalsmithDefine({
    _: require('underscore'),
    development: true,
    pkg: require('./package.json'),
    helpers: require('./helpers.js'),
  })
)

API

metalsmithDefine(options)

options

Type: Enumerable (Array, Class, Map, Object, string, etc) Default: {}

This parameter will be iterated on all its key/value pairs either via:

• {type}.prototype.entries if the method exists (e.g., Map),
• or Object.entries for all the other types: Array, Object, etc

The pairs will be merged into the metadata object in the order in which they are being iterated on.

metalsmith-define's Issues

How to access rootPath from within application?

I have the following gulp task:

 app.use(
        msDefine({
            production: false,
            rootPath: '/'
        })
    );

    app.use(
        msIf(
            gutil.env.config === 'release',
            msDefine({
                production: true,
                rootPath: '/styleguide/'
            })
        )
    );

In my angular component, I wanna do something like:

import stuff from 'stuff';

export class IconCtrl ...
  ...
  _getIconPath(name: string, size: string): string {
       
        switch (this.version) {
            case 'current':
                return `${stuff.rootPath()}/current/icn-${name}-${size}.svg`;
            default:
                return `${stuff.rootPath()}/legacy/${name}.svg`;
        }
    }
   ...

How do I access the rootPath?

What extra features does this plugin provide over metalsmith.metadata() ?

Hi,

Could you explain how this plugin provides added value over metalsmith.metadata({ ... })?
It seems to do exactly the same?
Or perhaps add a deprecation notice if the features have been added to the core in the meantime?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

• CircleCI
• Travis CI
• Buildkite
• CodeShip
• Azure Pipelines
• TeamCity
• Buddy
• AppVeyor
  But Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.