mock-ql-sculptor

mock-ql-sculptor is a powerful npm library that transforms GraphQL queries into mock data. It's designed to help developers quickly generate realistic test data based on their GraphQL schema, streamlining the development and testing process for GraphQL-based applications.

Features

• Parse GraphQL queries and generate corresponding mock data
• Support for nested fields and complex query structures
• Customizable mock data generation
• Command-line interface (CLI) for quick mock data generation from GraphQL files
• Built with the latest ES features, including top-level await, arrow functions, and destructuring

Installation

Install mock-ql-sculptor using npm:

npm install mock-ql-sculptor

Usage

As a Library

import generateMockData from "mock-ql-sculptor";

const query = `
  query {
    user {
      id
      name
      email
      age
    }
  }
`;

const mockData = generateMockData(query);
console.log(mockData);

Using the CLI

You can use mock-ql-sculptor directly from the command line:

npx mock-ql-sculptor path/to/your/query.graphql

This will output the generated mock data as JSON to the console.

API Documentation

generateMockData(query: string): object

Generates mock data based on the provided GraphQL query string.

• query: A string containing a valid GraphQL query
• Returns: An object containing mock data that matches the structure of the query

Testing

To run the tests for mock-ql-sculptor, use the following command:

npm test

This will run both the library tests and the CLI tests.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.