@husam287/mocker v1.0.4

Mocker

Mocker is a developer-friendly CLI tool for generating mock data in JSON format. It allows you to set up an initial template folder, customize mock data, and generate JSON files based on your template.

Features

• Template Initialization: Create a mock-template folder with predefined structure for easy customization.
• Mock Data Generation: Create a mock-data and generate JSON mocked data files based on your custom templates.
• Developer-Friendly: Designed for use as a development dependency.

Installation

Install Mocker as a development dependency in your project:

npm install @husam287/mocker --save-dev

Usage

1. Initialize the Mock Template

To set up an initial mock-template folder, use the following command:

npx mocker init

This command creates a mock-template folder in your current working directory. Inside, you can define your mock data templates in JSON files.

2. Customize Your Templates

Edit the files inside the mock-template folder to define your mock data. Each file should export a JavaScript or TypeScript object.

Example Template: user.mock.json

{
  "type": "list",
  "count": 10,
  "payload": [
    {
      "name": "username",
      "type": "text"
    }
  ]
}

This will create a list of 10 users each user is an object has username (text)

3. Generate Mock Data

Once your templates are ready, generate the mock data JSON files with:

npx mocker g

This command processes all .mock.json files in the mock-template folder and creates corresponding JSON files in the mock-data folder in src if exists otherwise on current directory

Folder Structure

your-project/
├── mock-template/
│   ├── user.mock.json
├── mock-data/ (generated after `npx mocker g`)

CLI Commands

• npx mocker init Initializes the mock-template folder with example files.

• npx mocker g Generates JSON files from the mock templates in the mock-template folder.

Mock Template JSON Types

Types Enum

Examples

Complex Nested Template JSON Example

{
  // whole list of 10 entries
  "type": "list",
  "count": 10,
  "payload": [
    // Username field
    // will generate => username: "Hossam Sherif"
    {
      "name": "username",
      "type": "text"
    },
    // Address Object field
    // will generate => address: { street_number:21, street_name: "st 123" }
    {
      "name": "address",
      "type": "object",
      "payload": [
        {
          "name": "street_number",
          "type": "number"
        },
        {
          "name": "street_name",
          "type": "text"
        }
      ]
    },
    // posts list with 3 entries
    // will generate => [{id:1, title:"test"}, ....]
    {
      "name": "posts",
      "type": "list",
      "count": 3,
      "payload": [
        {
          "name": "id",
          "type": "number"
        },
        {
          "name": "title",
          "type": "text"
        }
      ]
    },
  ]
}

Single Object Template JSON Example

{
  // This generate single object
  // will generate => {title: "Hi there", description: "test random text"}
  "type": "object",
  "payload": [
    {
      "name": "title",
      "type": "text"
    },
    {
      "name": "description",
      "type": "text"
    }
  ]
}

Text Type

// Template
{
  "name": "test",
  "type": "text"
}
// Result
{
  "test": "Hossam Sherif"
}

Number Type

// Template
{
  "name": "test",
  "type": "number"
}
// Result
{
  "test": 28
}

Date Type

// Template
{
  "name": "test",
  "type": "date"
}
// Result
{
  "test": "2022-07-31T01:33:29.567Z"
}

Birthday Type

// Template
{
  "name": "test",
  "type": "birthday"
}
// Result
{
  "test": "1998-07-28T01:33:29.567Z"
}

User Avatar Type

// Template
{
  "name": "test",
  "type": "user_avatar"
}
// Result
{
  "test": "https://avatars.githubusercontent.com/u/97165289"
}

Phone number Type

// Template
{
  "name": "test",
  "type": "phone"
}
// Result
{
  "test": "+15551234567"
}

Egyptian Location Type

// Template
{
  "name": "test",
  "type": "egyptian_location"
}
// Result
{
  "test": [30.78663, 31.82924] // [lng, lat]
}

Image Type

// Template
{
  "name": "test",
  "type": "image"
}
// Result
{
  "test": "https://loremflickr.com/500/500"
}