Typescript definitions

[mxl]

Fixes #363

Roadmap:

• wait for Add Calculator type to markerclustererplus. DefinitelyTyped/DefinitelyTyped#20322 to get merged
• improve https://github.com/mahnunchik/markerclustererplus definitions in DefinitelyTyped repository (tslint and some optimizations), see markerclustererplus: lint, ClusterIcon, tests, fixes. DefinitelyTyped/DefinitelyTyped#20337
• add definitions for https://github.com/lucasfs7/google-maps-infobox-module
• finish react-google-maps definitions

[tomchentw]

How do you generate these type definitions? By hand?

Could they be generate typed code from src/macro directly using jscodeshift API? That could save you lots of time.

[mxl]

I do not see any documentation on how to do this. I could possibly spend time and write definitions generator that uses jscodeshift API but it will take much more time than writing these definitions. Also I'm sure that it will still require some manual adjustments.

[mxl]

@tomchentw You can review definitions. The only thing left is to move InfoBox definitions to https://github.com/lucasfs7/google-maps-infobox-module or https://github.com/DefinitelyTyped/DefinitelyTyped.

[tomchentw]

Just had a quick review, it looks awesome! Thanks for the hard work!

@mxl : The only thing left is to move InfoBox definitions to https://github.com/lucasfs7/google-maps-infobox-module or https://github.com/DefinitelyTyped/DefinitelyTyped.

They both looks fine to me. Would you raise up a PR there?

[mxl]

@tomchentw Thanks for the review! I'm back! lucasfs7/google-maps-infobox-module#8

[mxl]

@tomchentw It's ready for a final review and merging.

[moorea]

@mxl, you are a lifesaver! If I could buy you a beer, I would 🍺

[NonMint]

Fantastic! I was just hoping for typescript definitions for this plugin. @mxl well done!

[tomchentw]

@mxl you're definitely awesome creating all those PRs with a clear roadmap! Great job!
I haven't tried this myself but I trust you.

[tomchentw]

Released v9.3.0

[mxl]

Guys, thank you for the kind words! @tomchentw if there will be any issue with definitions feel free to ping me.

[alecmev]

Should be boolean, no?

[mxl]

Yep, thanks! #710

[itsdouges]

@mxl hey mate, getting these errors when running:

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(77,29): error TS2304: Cannot find name 'Calculator'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(87,25): error TS2304: Cannot find name 'ClusterIconStyle'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(93,22): error TS2304: Cannot find name 'Calculator'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(103,18): error TS2304: Cannot find name 'ClusterIconStyle'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(107,27): error TS2304: Cannot find name 'Cluster'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(110,24): error TS2304: Cannot find name 'Cluster'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(111,25): error TS2304: Cannot find name 'Cluster'.

missing defs - oversight or something on my end?

[moorea]

@Madou, sounds like you need to install the latest version of MarkerClustererPlus. Check out mxl’s first comments on this PR. He had to add some stuff there as well. Best of luck 👍🏻

[itsdouges]

@moorea right you are, thanks!

[mxl]

@moorea I included @types/markerclustererplus and @types/googlemaps in peerDependencies to avoid unnecessary dependencies for those who does not use TypeScript.

[phillipj]

@mxl mind elaborating the added value of making those peerDependencies? I assume those type definitions isn't required for using this wonderful package?

$ npm install

..

npm WARN react-google-maps@9.4.2 requires a peer of @types/googlemaps@^3.0.0 but none was installed.
npm WARN react-google-maps@9.4.2 requires a peer of @types/markerclustererplus@^2.1.29 but none was installed.

As we're not using Typescript in that project (or any other for that matter), installing Typescript definitions is not something we want. Most importantly, we don't want to ignore npm warnings either 🤔

[mxl]

@phillipj Actually without those dependencies one will get compilation errors as @Madou did so we can not just remove them from package.json. Maybe it will be simpler for everyone to move them to dependencies. This will remove warnings for those who use JavaScript and errors for those who use TypeScript. WDYT?

[phillipj]

@mxl yupp, at first glance that sounds like a better option to me 👍 Although we non-typescript-users would have to download a couple of superfluous packages, we won't have to explicitly install them as our own dependencies.

[kentaromiura]

Just having this issue and searching bring me here as npm list will show peer dependencies as UNMET PEER DEPENDENCY;

@mxl I think that if you remove the type definitions from peerDependencies and just leave them in devDependencies should work and make everyone happy :)

[mxl]

@kentaromiura This will remove UNMET PEER DEPENDENCY warnings but will not install those dependencies. So developers will have to manually navigate this package package.json and install missing definitions. I see only two ways to make package work "out of the box" for both JS and TS developers:

1. move peerDependencies to dependencies;
2. move definitions to separate package.

@tomchentw WDYT?

[tomchentw]

@mxl I don't have strong opinion on this. Is there any disadvantage using dependencies over peerDependencies? I can think one is outdated dependencies. Any thoughts?

[tomchentw]

Let's move the typings discussion to #737

[AbhaysinghBhosale]

Is this issues still tracked. Not sure if this library is still maintained