gulp-json-to-tsd

A gulp plugin to generate typescript definition file that represents a shape of JSON

For each JSON file a typescript interface will be generated that represents a shape of a JSON. Name of an interface is based on JSON file name. E.g. UserGroup interface (or IUserGroup, see below) will be generated for any of file names: user-group.json, user_group.json, userGroup.json, UserGroup.json.

Please, note that only basic latin letters and digits are currently supported. Any other character are ignored.

Install

$ npm install --save-dev gulp-json-to-tsd

Usage

const gulp = require('gulp');
const jsonToTsd = require('gulp-json-to-tsd');
 
gulp.task("default", () => {
    gulp.src("src/foo.json")
        .pipe(jsonToTsd())
        .pipe(gulp.dest("dist"))
);

Let's assume that src/foo.json has the following contents:

{
    "foo": "Lorem ipsum sid amet",
    "bar": 7009,
    "baz": {
        "fizz": null,
        "buzz": false
    }
}

Then by default plugin will generate the following definition:

declare interface Foo {
    "foo": string;
    "bar": number;
    "baz": {
        "fizz": null|undefined;
        "buzz": boolean;
    };
}

If we switch on namespaces and variable declarations (see options below), we will get:

declare namespace example {
    interface Foo {
        "foo": string;
        "bar": number;
        "baz": {
            "fizz": null|undefined;
            "buzz": boolean;
        };
    }
}
declare const foo: example.Foo;

API

jsonToTsd([options])

options

useInterfacePrefix

Type: boolean
Default: false

If true, all interfaces will be prefixed with I letter. Let's assume that we have user-group.json file. Then if useInterfacePrefix = true, an IUserGroup interface will be generated. And if useInterfacePrefix = false, an interface will be UserGroup.

namespace

Type: string | undefined
Default: undefined

If specified, all interface declarations will be put into namespace with a given name.

declareVariable

Type: boolean
Default: false

Specifies if a variable of a generated interface must be declared. A declaration is put after an interface out of a namespace block (if any).

identStyle

Type: "tab" | "space"
Default: "tab"

Specifies identiation style.

identSize

Type: number
Default: 1

Specifies how many tabs/spaces will be used for one level of identiation.

License

MIT © 2017 Roman Liberov