bunqCommunity / bunqJSClient

A javascript SDK for the bunq API

MIT License

58 stars 23 forks source link

TypeScript improvements for IDEs #30

Closed ties-s closed 5 years ago

ties-s commented 5 years ago

This PR will:

enable generating typings files in /dist
set the main property of package.json to ./dist/BunqJSClient.js
set the types property of package.json to ./dist/BunqJSClient.d.ts and removes the typings as they are interchangeable.
prevent committing build files to git by adding /dist to .gitignore, this prevents cluttering commits with build files
prevent publishing source files to npm by adding /src to .npmignore this keeps download size while installing the package low
moves @types/* dependencies to devDependencies because they are only needed during development

codecov[bot] commented 5 years ago

Codecov Report

Merging #30 into master will increase coverage by 0.05%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #30      +/-   ##
==========================================
+ Coverage   97.26%   97.31%   +0.05%     
==========================================
  Files          61       61              
  Lines        1972     1972              
  Branches      391      391              
==========================================
+ Hits         1918     1919       +1     
+ Misses         53       52       -1     
  Partials        1        1

Impacted Files	Coverage Δ
src/Crypto/Aes.ts	`100% <0%> (+2.85%)`	:arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f6f4c5d...59bef77. Read the comment docs.

Crecket commented 5 years ago

Thanks 👍 I have some basic Typescript experience but setting up the types correctly was giving me a ton of issues when I tried it early on.

ties-s commented 5 years ago

This should enable support for auto complete in VSCode and other editors.

You may also want to move @babel/* to devDependencies. As far as I know they also only needed for building.

ties-s commented 5 years ago

Will you publish to npm or should I install from the repo for now?

Crecket commented 5 years ago

I'll publish it now 👍

ties-s commented 5 years ago

I think you forgot to build before publishing

Crecket commented 5 years ago

Should be good now on 0.35.2, it looks like the npmignore file also needs to include a bunch of the files/folders listed in the gitignore file.