Add flow typing: Part One #20

somewhatabstract · 2019-09-24T00:00:52Z

This is the first part of adding flow typing to react-render-server.

I decided to submit this PR now as it was getting pretty darn big. In this PR we:

Add flow-bin and flow-typed
Add linting to ensure files declare @flow or @noflow
Add flow-types to arguments.js, logging.js, secret.js and main.js
Reworked arguments.js to make mocking argument values easier
Reworked secret.js tests to use async/await
Setup chai-as-promised for all tests rather than just render_test.js

During this work, I've noticed that flow typing of Winston stuff seems pretty weak. There are also no flow-typed files for some of our other dependencies, including google cloud things. I have filled in some typing gaps for chai-as-promised and winston, but nothing serious; just copy/paste/edit from the typescript files. Another reason for getting this out now is so that subsequent typing edits, which may be more substantial, are clear and easy to review.

Since we don't publish this as a package, we don't ship the dist folder, so our consumer needs to build it on install

This also adds suppressions to the express definition file because it uses Subtype

.eslintrc

.vscode/settings.json

flow-typed/npm/chai_v4.x.x.js

flow-typed/npm/winston_v3.x.x.js

package.json

src/arguments.js

src/main.js

src/render_apollo_test.js

src/render_test.js

src/secret.js

src/secret_test.js

jeresig

Nice! This seems like a great start! A couple questions inline, but nothing blocking.

.eslintrc

src/logging.js

src/main.js

src/secret.js

src/secret_test.js

src/types.js

kevinbarabash

This is awesome. It's great to see Flow being used in more of our projects.

src/fetch_package_test.js

src/arguments.js

.flowconfig

src/types.js

Also added eslint-plugin-disable to disable react plugin, and added a react plugin version setting so that it stops complaining about react in the output

somewhatabstract · 2019-09-25T20:04:05Z

Thanks for the feedback, folks. I've addressed all the comments, I believe. I'm going to merge this in and continue with the rest of the changes.

somewhatabstract added 24 commits September 18, 2019 13:57

Tidy up package.json

3c7e4d4

Tidy up package.json

5e97de8

Get setup with babel transpilation

0a83906

Add postinstall script to run build

66a6d10

Babel needs to be a package dep so that the build can occur on install

0b6a0cb

Since we don't publish this as a package, we don't ship the dist folder, so our consumer needs to build it on install

Ensure arg parsing works for our built version too

b72c412

Address review commentary

df32f3c

Use require instead of compilers

253f117

Reinstate postinstall script

48de338

Remove trailing comma

4053843

Add flow

d7ee482

Add flow-typed definitions that are available

90bf1dd

This also adds suppressions to the express definition file because it uses Subtype

Run eslint with the correct config

446cab4

Lint for flow/noflow and update files

3f64c86

Remove unsupported argument

4b677ea

Add types to arguments.js

19cbe58

Fix a trailing comma in json and add more things to .prettierignore

f56f321

Update chai and sinon

1c3cd9c

Add types for secret.js

ea3d869

Expand chai types to cover chai-as-promised expansions

8c222e2

Make sure chai-as-promised is setup

eab9e24

Tidy up secret_test.js

acdb6d7

Add flow types to logging.js

a519f07

Add types for main.js

2c82ed7

somewhatabstract requested review from jeresig and kevinbarabash September 24, 2019 00:00