Add typescript definitions #303

gpbl · 2017-04-20T16:13:20Z

add react-day-picker.d.ts from DefinitelyTyped
add entry in package.json
upgrade to last version (don't forget Add modifiers-styles #296)
add dtslint tests (see what moment is doing)

See #299 and DefinitelyTyped/DefinitelyTyped#16010

coveralls · 2017-04-20T16:15:55Z

Coverage remained the same at 100.0% when pulling a4a4c4f on typescript-definitions into 17f707e on master.

adidahiya

Consider adding dtslint as well. I haven't tried it yet but it looks fairly self-contained (installs typescript & tslint for you) and applicable here.

cc @giladgray

adidahiya · 2017-04-20T16:23:04Z

react-day-picker.d.ts

+// Type definitions for react-day-picker 5.2
+// Project: https://github.com/gpbl/react-day-picker
+// Definitions by: Giampaolo Bellavite <https://github.com/gpbl>, Jason Killian <https://github.com/jkillian>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped


I don't think you need the above 4 lines, just the TypeScript compiler version

giladgray · 2017-04-21T22:00:24Z

package.json

@@ -62,6 +62,7 @@
  "peerDependencies": {
    "react": "~0.13.x || ~0.14.x || ^15.0.0"
  },
+  "types": "./react-day-picker.d.ts",


i'd say this belongs up near main and style keys as it's a distributable file

giladgray · 2017-04-21T22:01:16Z

react-day-picker.d.ts

+            React.ComponentClass<WeekdayElementProps> |
+            React.SFC<WeekdayElementProps>;
+        weekdaysLong?: [string, string, string, string, string, string, string];
+        weekdaysShort?: [string, string, string, string, string, string, string];


real game changing feature would be to include /** docs */ on each of these props. i know you have great docs for every prop already... but that could easily be added in a future release.

coveralls · 2017-04-25T17:03:50Z

Coverage remained the same at 100.0% when pulling 532d8c6 on typescript-definitions into 17f707e on master.

commit 0dcc6cd Author: Giampaolo Bellavite <gpbellavite@gmail.com> Date: Tue Apr 25 12:30:01 2017 -0500 Remove prop quick reference commit fbc3979 Author: Giampaolo Bellavite <gpbellavite@gmail.com> Date: Tue Apr 25 12:29:38 2017 -0500 Make example’s code cleaner commit 536c8d0 Author: Giampaolo Bellavite <gpbellavite@gmail.com> Date: Tue Apr 25 12:25:08 2017 -0500 Add docs for modifiersStyles commit f96e389 Merge: 17f707e 461d377 Author: Giampaolo Bellavite <io@gpbl.org> Date: Thu Apr 20 11:13:56 2017 -0500 Merge pull request #302 from gpbl/fix-function-modifier Fix function modifiers commit 461d377 Author: Giampaolo Bellavite <gpbellavite@gmail.com> Date: Thu Apr 20 11:02:39 2017 -0500 Add example commit f997d6b Author: Giampaolo Bellavite <gpbellavite@gmail.com> Date: Thu Apr 20 10:59:02 2017 -0500 Accept function in array of modifiers

coveralls · 2017-04-25T17:33:02Z

Coverage remained the same at 100.0% when pulling 5f8a74d on typescript-definitions into 17f707e on master.

adidahiya · 2017-04-25T18:39:36Z

docs/API.md

@@ -1,47 +1,4 @@
 # Component API

 * [Component props](APIProps.md)
-* [Component methods](APIMethods.md)
-
-## Props quick reference


I think you might want to add a link to types/index.d.ts here? People might not know to look for that immediately

Sure 👍🏽 However, aren't the definitions inferred by the tools using them?

PS. thanks @adidahiya @giladgray for the help! I never used TypeScript and I'm happy to learn something new!

not exactly: the tools rely on package.json "types" key to tell them where to find an entry .d.ts file, and the node_modules/@types scope directory to list all the available external modules.

coveralls · 2017-04-25T18:56:37Z

Coverage remained the same at 100.0% when pulling 6d0b9e7 on typescript-definitions into 17f707e on master.

giladgray · 2017-04-25T19:10:48Z

package.json

  "files": [
    "DayPicker.js",
    "lib",
    "moment.js",
-    "utils.js"
+    "utils.js",
+    "./types/index.d.ts"


for consistency i'd omit the ./ but whatever 🚢

(also above in "types")

coveralls · 2017-04-25T21:46:43Z

Coverage remained the same at 100.0% when pulling 2384a62 on typescript-definitions into 17f707e on master.

coveralls · 2017-04-25T21:54:26Z

Coverage remained the same at 100.0% when pulling 40f02c7 on typescript-definitions into 17f707e on master.

…cker into typescript-definitions

coveralls · 2017-04-25T21:58:52Z

Coverage remained the same at 100.0% when pulling 59a0aad on typescript-definitions into e40c06a on master.

coveralls · 2017-04-25T21:59:05Z

Coverage remained the same at 100.0% when pulling 59a0aad on typescript-definitions into e40c06a on master.

Add react-day-picker.d.ts

a4a4c4f

gpbl added this to the v5.3.0 milestone Apr 20, 2017

gpbl mentioned this pull request Apr 20, 2017

[react-day-picker] add DayModifiers for onDay* callbacks DefinitelyTyped/DefinitelyTyped#16010

Closed

6 tasks

adidahiya reviewed Apr 20, 2017

View reviewed changes

giladgray reviewed Apr 21, 2017

View reviewed changes

gpbl added 2 commits April 25, 2017 11:32

Move types file into /types dir

c81cf93

Add index.d.ts to files

532d8c6

gpbl added 2 commits April 25, 2017 12:38

Add modifiersStyles prop

1adbedc

Specify TypeScript Version: 2.2

f26ea5e

adidahiya reviewed Apr 25, 2017

View reviewed changes

Add dtslint

6d0b9e7

giladgray reviewed Apr 25, 2017

View reviewed changes

giladgray approved these changes Apr 25, 2017

View reviewed changes

Use node 7

2384a62

Remove ./

40f02c7

gpbl and others added 4 commits April 25, 2017 16:55

Add link to index.d.ts

01d4898

Add dtslint script

023ea06

Merge branch 'master' into typescript-definitions

fb399c1

Merge branch 'typescript-definitions' of github.com:gpbl/react-day-pi…

59a0aad

…cker into typescript-definitions

gpbl merged commit 72bb679 into master Apr 25, 2017

gpbl deleted the typescript-definitions branch April 25, 2017 22:00

Bhanditz mentioned this pull request Dec 1, 2023

[Snyk] Fix for 1 vulnerabilities Bhanditz/react-day-picker#71

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add typescript definitions #303

Add typescript definitions #303

gpbl commented Apr 20, 2017 •

edited

coveralls commented Apr 20, 2017

adidahiya left a comment

adidahiya Apr 20, 2017

giladgray Apr 21, 2017

giladgray Apr 21, 2017

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

adidahiya Apr 25, 2017

gpbl Apr 25, 2017

giladgray Apr 25, 2017

coveralls commented Apr 25, 2017

giladgray Apr 25, 2017 •

edited

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

Add typescript definitions #303

Add typescript definitions #303

Conversation

gpbl commented Apr 20, 2017 • edited

coveralls commented Apr 20, 2017

adidahiya left a comment

Choose a reason for hiding this comment

adidahiya Apr 20, 2017

Choose a reason for hiding this comment

giladgray Apr 21, 2017

Choose a reason for hiding this comment

giladgray Apr 21, 2017

Choose a reason for hiding this comment

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

adidahiya Apr 25, 2017

Choose a reason for hiding this comment

gpbl Apr 25, 2017

Choose a reason for hiding this comment

giladgray Apr 25, 2017

Choose a reason for hiding this comment

coveralls commented Apr 25, 2017

giladgray Apr 25, 2017 • edited

Choose a reason for hiding this comment

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

coveralls commented Apr 25, 2017

gpbl commented Apr 20, 2017 •

edited

giladgray Apr 25, 2017 •

edited