Add flow type definitions #91
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
v2.1.0 includes a semver-major change to protocol-buffers-schema that changes how enums are handled (mafintosh/protocol-buffers-schema#24) and breaks the tests.
anandthakker
force-pushed
the
add-flow-typedefs
branch
from
3ec540c
to
f203abd
Compare
7 tasks
anandthakker
force-pushed
the
add-flow-typedefs
branch
from
f203abd
to
0f368e3
Compare
mourner
requested changes
Jul 27, 2018
| @@ -37,13 +37,14 @@ | |||
| "homepage": "https://github.com/mapbox/pbf", | |||
| "dependencies": { | |||
| "ieee754": "^1.1.6", | |||
| "resolve-protobuf-schema": "^2.0.0" | |||
| "resolve-protobuf-schema": "~2.0.0" | |||
There was a problem hiding this comment.
What's the reason for the range change?
There was a problem hiding this comment.
Explained in the commit comment here: 8c01f6b
| readBytes(): Uint8Array; | ||
| } | ||
|
|
||
| declare module.exports: typeof Pbf |
There was a problem hiding this comment.
This only covers a fraction of the methods, mostly ones for reading, while there are also many for writing. We need to cover all the methods to be able to merge the PR.
|
|
||
|
|
||
|
|
||
| Found 1 error |
There was a problem hiding this comment.
Thinking about this further, I'm not comfortable with this approach to testing the existence of flow types.
- It will constantly break between flow versions when the output changes in subtle ways.
- It doesn't really test whether the library provides all the necessary flow types — only a few selected ones in
flow.input.js.flow.
Instead, is there a way to test flow through the actual tests that exercise all the code paths in the library?
|
Closing -- as @mourner points out, this will be brittle unless we're using Flow more comprehensively in the repo. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.