Generate type definitions at build time

[sakai-akinobu]

Thank you for a nice module! Hearthstone is a nice game, isn't it?

I use this module with TypeScript, but it seems that it can not use FormatType as a value.

import {FormatType} from 'deckstrings';

FormatType.FT_STANDARD; // => 'FormatType' only refers to a type, but is being used as a value here. ts(2693)

On the other hand, when using it with JavaScript it was able to be used correctly.

const FormatType = require('deckstrings').FormatType;

FormatType.FT_STANDARD // => 2

I guess this is because the type definition does not match the contents of the actual module.

To solve this problem, I fixed to generate type definitions at build time. By doing so, we can handle it properly from TypeScript as well.

[sakai-akinobu]

This is to ignore the cache directory generated by rollup-plugin-typescript2.
https://github.com/ezolenko/rollup-plugin-typescript2#plugin-options

[sakai-akinobu]

This is the requirement of rollup-plugin-typescript2.
https://github.com/ezolenko/rollup-plugin-typescript2#requirements

[sakai-akinobu]

Since rollup-plugin-typescript seems to be unable to generate type definitions, I used rollup-plugin-typescript2.
https://github.com/rollup/rollup-plugin-typescript/issues/54

[sakai-akinobu]

This is the requirement of rollup-plugin-typescript2.
https://github.com/ezolenko/rollup-plugin-typescript2#some-compiler-options-have-more-than-one-compatible-value

[beheh]

Hi there, thank you for your pull request! We require a CLA to be signed for contributions to this (and other) repositories. We capture this using a private GitHub repository. I have sent you an invite, and the README on that repository contains instructions on how to proceed. Let me know if you have any questions.

[sakai-akinobu]

I signed it 😄

[sakai-akinobu]

By using this option, the following files are generated under the dist directory, and these will be included when distributing as npm package.

• base64.d.ts
• buffer.d.ts
• constants.d.ts
• index.d.ts

For example, index.d.ts has the following contents.

import { DeckDefinition, DeckList } from "../types";
import { FormatType } from "./constants";
export declare function encode(deck: DeckDefinition): string;
export declare function decode(deckstring: string): DeckDefinition;
export { FormatType, DeckDefinition, DeckList };

https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html