@g749/plugin-node-faker/index.js

A plugin for Pattern Lab that allows Faker in the data.json file

'use strict';

var packageJson = require('./package.json')

var pluginName = packageJson['@pattern-lab-plugin'].name
var pluginModuleName = packageJson.name

const faker = require('faker');



function convertFakerData(data) {
  // Convert data to JSON string and process. Then, return it to an object.
  var stringData = JSON.stringify(data, (key, value) => {
    // find all the fakers
    if (typeof value === 'string') {
      return value.replace(/@faker\.[a-z]+\.[a-z][a-zA-Z]+(\([^\)]*\))?@/g, (match) => {
        var dot = match.indexOf('.', 8),
            brace = match.indexOf('('),
            end = match.length -1,
            fakerObject = match.slice(7, dot),
            fakerFunction = match.slice(dot + 1, brace >= 0? brace: end),
            fakerOptions = [];
        if(brace >= 0) {
          fakerOptions = JSON.parse('[' + match.slice(brace+1, end -1) + ']');
        }
        try {
          return faker[fakerObject][fakerFunction].apply(faker[fakerObject], fakerOptions);
        } catch (e) {
          console.log(`'${match}' could not be processed: `, e);
          return match;
        }
      });
    }
    return value;
  });
  return JSON.parse(stringData);
}

function addMainFakerData(patternlab) {
  patternlab.data = convertFakerData(patternlab.data);
  patternlab.listitems = convertFakerData(patternlab.listitems);
}

function addPatternFakerData(patternlab, pattern) {
  // Tried changing listitems here, but it doesn't want to appear in patterns at this event.
  // Probably tarketing wrong object data.
  // More research later. For now, two separate events.
  pattern.jsonFileData = convertFakerData(pattern.jsonFileData);
}

/**
 * Define what events you wish to listen to here
 * For a full list of events - check out https://github.com/pattern-lab/patternlab-node/wiki/Creating-Plugins#events
 * @param patternlab - global data store which has the handle to the event emitter
   */
function registerEvents(patternlab) {
  //register our handler at the appropriate time of execution
  patternlab.events.on('patternlab-build-global-data-end', addMainFakerData);
  patternlab.events.on('patternlab-pattern-before-data-merge', addPatternFakerData);
}

/**
* A single place to define the frontend configuration
* This configuration is outputted to the frontend explicitly as well as included in the plugins object.
*
*/
function getPluginFrontendConfig() {
  return {
    'name':'pattern-lab\/' + pluginName
  };
}

/**
* The entry point for the plugin. You should not have to alter this code much under many circumstances.
* Instead, alter getPluginFrontendConfig() and registerEvents() methods
  */
function pluginInit(patternlab) {

  if (!patternlab) {
    console.error('patternlab object not provided to plugin-init');
    process.exit(1);
  }

  //write the plugin json to public/patternlab-components
  var pluginConfig = getPluginFrontendConfig();

  //add the plugin config to the patternlab-object
  if (!patternlab.plugins) {
    patternlab.plugins = [];
  }
  patternlab.plugins.push(pluginConfig);

  //setup listeners if not already active. we also enable and set the plugin as initialized
  if (!patternlab.config.plugins) {
    patternlab.config.plugins = {};
  }

  //attempt to only register events once
  if (patternlab.config.plugins[pluginModuleName] !== undefined &&
     patternlab.config.plugins[pluginModuleName].enabled &&
     !patternlab.config.plugins[pluginModuleName].initialized) {

    //register events
    registerEvents(patternlab);

    //set the plugin initialized flag to true to indicate it is installed and ready
    patternlab.config.plugins[pluginModuleName].initialized = true;
    console.log(`Loaded ${pluginModuleName} as ${pluginName}.`)
  }

}

module.exports = pluginInit;