Add flow type annotations. #51
Conversation
|
|
||
| [include] | ||
|
|
||
| [options] |
There was a problem hiding this comment.
@vmx guessing that these .flowconfig files will be removed in your effort to add flow directly to aegir, correct?
There was a problem hiding this comment.
I don't believe that would be possible given that flow uses .flowconfig to detect the root what needs to be type-checked.
There was a problem hiding this comment.
Huh, is there no way for us to specify where the config file is located? Feels very suboptimal if we have to add this to every repository...
There was a problem hiding this comment.
Huh, is there no way for us to specify where the config file is located? Feels very suboptimal if we have to add this to every repository...
As far as I know it's still the case (at least there is no documented parameter to a flow command). Please note that it's not as much of an issue about specifying a config (.flowconfig could be a blank file) but rather about not being able to specify a root from which to type-check.
There was a problem hiding this comment.
@victorbjelkholm I hope to have it go away. @garrensmith will have a look.
There was a problem hiding this comment.
Reading here, it doesn't seem like we can remove the flowconfig file. It should be a very simple file for each project. I don't think it would be to much of an issue having it in each repo. We could maybe look at having AEgir generate a generic .flowconfig file for a repo.
There was a problem hiding this comment.
This looks good to me! Thanks :)
Can we have a review from the captain as well? Ping @diasdavid
|
@victorbjelkholm, @vmx is leading this endeavor ipfs/js-ipfs#1260, I'll wait for his advice in what to do here. |
|
I think it would make sense to wait for multiformats/js-multihash#49 to be merged and then rework this PR to do the same thing. |
|
Closing this as we currently support Typescript typings. |
As dive into ipfs / libp2p code base I struggle to guess what are all the things passed around. Types as in flow (or typescript for that matter) simplify learning of how things are connected significantly. There for I decided to contribute type signatures to the code base as I digg through it.
What's up with all these .js.flow files ?
Unfortunately flow project has yet to come up with coherent story of how to provide type annotations for third party libraries. In my experience adding
.js.flowfiles works best out of all options, that is because flow type checker when gives a precedent to/path/to/file.js.flowover/path/to/file.jswhich essentially provides a way to provide type annotations for non-flow typed package such that just using it as dependency will satisfy both type checker and run-time.It's far from ideal given that
.jsand.js.flowfiles can get out of sync but then again unless you're open to adopt flow this is the best option IMO.