ariatemplates/git-release-notes

TS types support

Closed this issue · 4 comments

mapleeit commented

Noticed that there is no types definition either in the package nor on the DefinitelyTyped.

It would be a nice experience if we provide types define files. I could help to do that.

piuccio commented

I'm not very keen on defining types inside the files. I don't want to use compilers/transpilers/whatevers.
If there's a way to generate types while at the same time guarantee that the module can be used simply with node 8, I'm happy

mapleeit commented

Defining types doesn't mean using TS compilers. ; )

There are two ways to achieve this:

  1. Add a typing file like index.d.ts to the root directory without any other change. People could enjoy the convenience of types out of box. E.g. axios

  2. Post it on DefinitelyTyped. This way doesn't change anything within this package. It will create a new npm package named @types/git-release-notes. People must install it before use TS types.

I prefer the first one, but could do with the other.

piuccio commented

I like the first one too!

mapleeit commented

Close.