json-lorem

Easy to use ( Javascript based templating ), very extensible ( add your own function ), fully loaded(faker, chancejs, lodash and momentjs are already added) custom JSON generator with fake data

This is in beta stage, there are bugs and functions are still unstable. Please use with caution !

Features

• JS based templating system ( you can use JS functions or ES6 template literals - still need to decide if we still want to keep them )
• Easy to add your own functions or libraries to be use inside templates
• Already packed with good stuff: faker, chancejs, lodash and momentjs ( more to come )
• Allow inline functions in template with access to current generated element ( this ), parentObject ( this.getParent() ), or root ( this.getRoot() )

Install

$ npm install --save json-lorem

Use

 
   import {generate} from 'json-lorem';
 
  const template = `{
    person: {
      name: '${firstName()} ${lastName()}',
      phone: phone(),
      company: company(),
      avatar: () => faker.image.avatar()
    },
    messages: [
    {
      'repeat(5)': {
        _id: objectID(),
        idx: index(),
        sender: function(){
          return this.getRoot().person.name
        },
        msg: lorem('paragraphs', 2)
      }
    }
    ]
  }`
 
  const json = generate(template);
 

API

• generate(string, {optios})
• generateFromFile( filename, {options} )

options :

{
  functions: {
    /* injected functions, libraries or vars
     * ex:
     * myFunc: () => { return 'myValue' },
     * myVar: 'myValue'
     */
  }
  }

Functions

• repeat( [min], max )
• index()
• objectID()
• lorem([type], [count=1]) // type are supported types from faker: word, words, paragraph, paragraphs, stentence, senteces, etc
• email()
• firstName()
• lastName()
• name()
• phone()
• company()
• uuid()
• bool()
• city()
• country()
• pastDate()
• futureDate()
• number([min], [max])
• radom(array)
• state()
• street()
• _
• moment
• chance
• faker

Example

You can see a complete example here

Tests

AVA is used as test runner. To run the tests, run

npm test

TO DO

• add more tests
• ES6 template literals are very tricky. Need to decide if we are keeping them

Contributors

• Tiberiu Craciun