Lumis NPM | npm.io

npm

Lumis

Automatically create factory and fake data from typescript interfaces

Please note, this is still very early development and has not been tested in a production envirnoment!

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Lumis
Apache 2.0 License © Nicholas Mordecai

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install the library, run:

$ npm install --save-dev lumis

Or if you prefer using Yarn:

$ yarn add --dev lumis

Usage

To run Lumis on your project, add the command to your package.json scripts:

"script": {
      "...": "...",
      "lumis": "lumis -f ./src/**/*{.d.ts,.ts}"
}

and execute the above script like so:

$ npm run lumis
# or
$ yarn lumis

or if you have it installed globally:

$ lumis --files=./**/*.ts

Examples

Create the following file, saving the example below inside.

  export interface Example {
    str: string;
    num: number;
    literal: {
        key1: string;
        key2: string;
    };
    arraySimple: string[];
    arrayComplex: Array<{key1: string, key2: number}>;

    tupSimple: [string, string, number];
    tupComplex: [number, string, {key1: string}];
    address: Address;
  }

  interface Address {
      streetName: string;
      houseNumber: number;
  }

Now run your npm command:

$ npm run lumis
# or
$ yarn lumis

Now in any other Typescript file in your project, you can get the factory.

import { Example, Address } from 'lumis';

const newExample = Example.create({...});

// note, this is currently being implemented
const fakedExample = Example.fake();