willb335 / chessboardjsx

:black_square_button: Chessboard built for React

https://chessboardjsx.com

MIT License

267 stars 79 forks source link

Add TypeScript definitions. #34

Closed slig closed 5 years ago

slig commented 5 years ago

Following on #33, here's the PR.

There're a couple of things I'm not 100% sure, though.

I don't think that the types Square, Piece, Position and CustomPieces have to be exported, so I didn't export them. Also the roughSquare receives a squareElement which I believe the appropriate type is SVGElement.

Thank you for your time on this!

codecov-io commented 5 years ago

Codecov Report

Merging #34 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #34   +/-   ##
=======================================
  Coverage   62.86%   62.86%           
=======================================
  Files          10       10           
  Lines         272      272           
  Branches       62       62           
=======================================
  Hits          171      171           
  Misses         80       80           
  Partials       21       21

willb335 commented 5 years ago

I don't think that the types Square, Piece, Position and CustomPieces have to be exported, so I didn't export them.

That sounds fine if somebody needs them exported I can look into it.

Could you make a new pull request running npm run commit and then just follow the prompts and add it as a 'doc' change? This helps to integrate the new commits into versioning.

I'm afraid if I amend the commit myself then it won't recognize you as a contributor.

willb335 commented 5 years ago

on second thought, this won't affect versioning since it is not a feature change, I'll merge this in. Thanks!

slig commented 5 years ago

Thank you very much!

willb335 commented 5 years ago

:tada: This PR is included in version 2.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: