Add diff2html typings and tests

[rtfpessoa]

case 1. Add a new type definition.

• checked compilation succeeds with --target es6 and --noImplicitAny options.
• has correct naming convention
• has a test file with the suffix of -tests.ts or -tests.tsx.

[paulvanbrenk]

Can you export these functions in the namespace directly:

export function getJsonFromDiff( ... )

Then export the namespace from:

export = Diff2Html

this way both the module based usage and the global usage work as expected.

[rtfpessoa]

@paulvanbrenk The module is exported in a weird way. If you look at here https://github.com/rtfpessoa/diff2html/blob/master/src/diff2html.js#L104

Are you sure I should really remove that?

FYI I am completely new to Typescript.

[DanielRosenwasser]

The reason @paulvanbrenk and I are suggesting this is that if you don't do it that way, then your consumers won't be able to reference the types you're exporting (like Diff2Html.Options).

[DanielRosenwasser]

Basically export = captures the namespace, value, and type meanings at any given location. You want to make some of those things you've defined accessible to others, so it'd be something like

namespace Diff2Html {
    export interface Options { /*...*/ }
    // ...
    export functon getPrettyHtml(input: any, configuration?: Options): string;
}

declare module "diff2html" {
    export = Diff2Html;
}

Now your consumers can actually write

import d2h = require("diff2html");

let opts: d2h.Options = {
    // ...
}

[rtfpessoa]

@DanielRosenwasser I do not think I understand you.

I know what you want. But it does not seem that what you are suggesting me to do will compile to valid JS code that will work with the module.

currently the code compiles to:

var Diff2Html = require("diff2html")
var d2h = Diff2Html.Diff2Html

and in d2h will the the public api of my library.

If in the typescript definition I remove that when the code compiles it will not run since if I do just:

var d2h = require("diff2html")

d2h will not have the methods. Do you understand my question? Or am I being somehow confusing?

[rtfpessoa]

@DanielRosenwasser please confirm here: https://github.com/rtfpessoa/diff2html/blob/master/src/diff2html.js#L104
and here: https://github.com/rtfpessoa/diff2html#node-module

fyi, I have no problem in changing I just think it will not work as expected. But I am new to TypeScript.

[paulvanbrenk]

@DanielRosenwasser can you take a look here?

[rtfpessoa]

@paulvanbrenk @DanielRosenwasser since I am new to Typescript, can you point me to a guide where I can very this?

By verify I mean run the diff2html-test.ts and check the library mapping is ok.

[rtfpessoa]

@paulvanbrenk @DanielRosenwasser fyi, I already compiled it with tsc and the output is what I would write in plain JS.

[vvakame]

LGTM. @DanielRosenwasser sorry, I merged this PR.