Rmwc: Flow types definitions in npm package

[romanlv]

Even though RMWC sources have Flow type definitions, it's not present in ES5 version when library module is installed with yarn (npm).

What's the correct (possible) way to include/define those types?
Currently, I'm just forced to create empty stubs e.g. flow-typed create-stub rmwc/[email protected]...

[romanlv]

https://github.com/facebook/flow/issues/1996

[jamesmfriedman]

Thanks for that! Been wondering this myself, definitely want to support this

[jamesmfriedman]

This will hopefully be fixed in the MDC 32 release that is pending right now. I've included the ES6 src as well as a workaround that is supposed to export the flow types.

[jamesmfriedman]

@romanlv check this out in 1.4.0 and let me know if it fixes your issue.

[romanlv]

@jamesmfriedman it looks like it works only when components are imported from root namespace e.g.

import { Switch } from 'rmwc'; but not with selective import import { Switch } from 'rmwc/Switch'; (which I want to keep)

Indeed, when I inspect rmwc folder in node_modules it has only one index.js.flow file in root

[jamesmfriedman]

That’s great to know. I’m guessing this fix is as simple as adding index.flow files to the individual directories as well. I’ll look into this more for the next release but at least moving in the right direction.

[jamesmfriedman]

Made a change for the next release, I'm now exporting a flow index file from every module, so you should be able to import rmwc/Button, but it will pull the flow types from rmwc/src/Button.

[jamesmfriedman]

@romanlv 1.5 was just released. Let me know if the changes helped your workflow.

[romanlv]

@jamesmfriedman I run into several issues with *.flow files in this release (and most likely it didn't work in the previous one, sorry, it must have used stub which was saved in `flow-typed' dir)

I did some investigation, it looks like using flow-copy-source can be an easier solution, instead of commiting *.flow file to the repo (which didn't work for me)

I tried to experiment with it in test-repo using something like

find node_modules/rmwc/ -name '*.flow' -exec rm {} \;
npx flow-copy-source -v node_modules/rmwc/src/ node_modules/rmwc/

yarn flow check

Which picked up definitions, but it looks like there are some errors with flow in the rmwc project itself, indeed npx flow check gives me 113 errors, I think you should add this check to circleci config ...

I can try to create a PR that uses flow-copy-source but there should be no flow errors in the project to begin with...

[jamesmfriedman]

@romanlv thanks for the tip. A few things.

• I'm going to fix all of the type errors in RMWC, and make sure I add a flow check to the tests
• I'm going to do a bit more research into deploying packages with types. It looks like a libdef might be a solution
• I'm interested in getting this right because as soon as I do, I'm going to automate transforming flowdefs into typescript ones so I can publish both #40

[jamesmfriedman]

Good news @romanlv, this should be fixed in 1.6!.

I've tested with VScode and I'm getting autocomplete (although the prop descriptions don't come through).

Take a look, let me know if it's working for you