Add Flow Type Support #57

maicki · 2017-05-30T05:21:40Z

Further details #56

TODOs:

Add flow type verification step for integration test
Add non nullable and non optional id field

Follow Up (No blocker):

Add documentation for flow support
- Update CLI help command
- Add documentation for the website
- Change tagline of project
Add dynamic spaces support (JS usually uses 2 spaces) Add custom indentation support #61
Generate an index.js file that exports all the flow types

bradencanderson · 2017-05-30T23:33:55Z

Examples/JS/flow/ImageType.js

+//  DO NOT EDIT - EDITS WILL BE OVERWRITTEN
+//  @generated
+//
+//  @flow


Does this work? I think Flow only looks at the first 10 tokens in a file by default. (Might want to move // @flow to the top just in case)

Just for reference, what does @flow do for us?

// @flow tells Flow to typecheck the file. Otherwise it will ignore it and assume everything coming out of it is any.

In my testing it works but I will move it to the top.

bradencanderson · 2017-05-30T23:34:33Z

Examples/JS/flow/ImageType.js

+import type { PlankDate, PlankURI } from "./runtime.flow.js";
+
+
+export type ImageType = {


should this be an exact object type?

bradencanderson · 2017-05-30T23:36:05Z

Examples/JS/flow/PinType.js

+
+export type PinType = {
+    +note?: string | null,
+    +media?: { [string]: string } | null,


The contents of media, counts, etc should be read-only as well: +media?: { +[string]: string }.

Yes, thanks :)

bradencanderson · 2017-06-12T21:49:11Z

Can you also generate an index.js file that exports all these types? That way, we can do

import type { BoardType, ImageType } from 'plank-schemas';

instead of

import type { BoardType } from 'plank-schemas/BoardType';
import type { ImageType } from 'plank-schemas/ImageType';

Also, make sure this index.js file only exports flowtypes -- we don't want to increase bundle size.

bradencanderson · 2017-06-12T21:58:14Z

Try to use import type { DomainType } from "./DomainType.js"; instead of import type DomainType from "./DomainType.js";.

A few more nits:

2-space indents. This will make it easier for JS developers to dive in and read the code without messing with their editor configs.
Single quotes('), for the same reason.

If you want, you can try running prettier on your output.

bradencanderson · 2017-06-12T23:18:04Z

Examples/JS/flow/BoardType.js

+import type { ImageType } from './ImageType.js';
+
+export type BoardType = $Shape<{|
+    +name: ?string,


should there be an id field on all these objects?

update: I think there has to be, since a lot of our JS code depends on id being a field on pins, boards, users, etc.

I just pushed a commit that added support for an id field.

rahul-malik

Do we need to update any of the CLI help command?

rahul-malik · 2017-06-14T05:57:00Z

Utility/integration-test.sh

@@ -6,6 +6,9 @@ JSON_FILES=`ls -d Examples/PDK/*.json`
 # Generate Objective-C models
 .build/debug/plank  --output_dir=Examples/Cocoa/Sources/objc/ $JSON_FILES

+#Generate flow types for models
+.build/debug/plank --lang flow  --output_dir=Examples/JS/flow/ $JSON_FILES


is there anything we can run to validate these are correct flow definitions since they are not compiled?

We can add a .flowconfig to the JS repo and run flow-bin CLI command over the output. We need to check if flow-bin is available globally on the dev's machine though.

I just did that. I added plain .flowconfig file for now to the example folder and run flow on the directory if flow is globally installed.

maicki · 2017-06-14T14:30:25Z

@rahul-malik We could add some comment to the --lang command which languages are supported e.g.:

--lang - Comma separated list of target language(s) for generating code. Default: objc - Supported: objc, flow

levi · 2017-06-14T15:27:23Z

Before you land this, could you add documentation for the website? @rmalik we will need to change the tag line of the project whenever an official release is cut.

maicki · 2017-06-15T14:01:01Z

@rahul-malik Ready for next review.

As we talked about yesterday we should treat the flow support as experimental for now. Therefore I moved adding documentation as well as some other non blocking improvements like creating an index.js file or adding support for variable spaces support to next steps.

ghost · 2017-06-15T22:53:27Z

🚫 CI failed with log

ghost · 2017-06-15T22:55:13Z

🚫 CI failed with log

ghost · 2017-06-15T22:59:15Z

	2 Warnings
⚠️	This is a big PR, please consider splitting it up to ease code review.
⚠️	Any source code changes should have an entry in CHANGELOG.md or have #trivial in their title.

Generated by 🚫 Danger

rahul-malik · 2017-06-16T06:57:38Z

@maicki - Did you want to resolve the 2-space implementation within this patch or follow up?

maicki · 2017-06-16T13:52:08Z

@rahul-malik I'm currently working on a separate branch that will integrate dynamic indentation support to plank and I will get up a PR soon. In my opinion for this PR it's not necessary and would just bloat up the diff.

maicki · 2017-06-16T15:06:11Z

@rahul-malik PR for adding custom indentation support: #61

maicki mentioned this pull request May 30, 2017

Flow Type Support #56

Closed

bradencanderson reviewed May 30, 2017

View reviewed changes

bradencanderson reviewed Jun 12, 2017

View reviewed changes

rahul-malik reviewed Jun 14, 2017

View reviewed changes

maicki mentioned this pull request Jun 15, 2017

Don't camel case the description for EnumValue by default #60

Merged

Initial support for Flow types

4ee9293

Kick CI

df6ab52

rahul-malik approved these changes Jun 16, 2017

View reviewed changes

rahul-malik merged commit 12db0da into pinterest:master Jun 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Flow Type Support #57

Add Flow Type Support #57

maicki commented May 30, 2017 •

edited

Loading

bradencanderson May 30, 2017

rahul-malik May 31, 2017

bradencanderson May 31, 2017

maicki Jun 12, 2017

bradencanderson May 30, 2017

maicki Jun 12, 2017

bradencanderson May 30, 2017 •

edited

Loading

rahul-malik May 31, 2017

bradencanderson May 31, 2017

maicki Jun 12, 2017

bradencanderson commented Jun 12, 2017

bradencanderson commented Jun 12, 2017

bradencanderson Jun 12, 2017

bradencanderson Jun 13, 2017

maicki Jun 15, 2017

rahul-malik left a comment

rahul-malik Jun 14, 2017

maicki Jun 14, 2017

maicki Jun 14, 2017

maicki commented Jun 14, 2017

levi commented Jun 14, 2017

maicki commented Jun 15, 2017

ghost commented Jun 15, 2017

ghost commented Jun 15, 2017

ghost commented Jun 15, 2017

rahul-malik commented Jun 16, 2017

maicki commented Jun 16, 2017

maicki commented Jun 16, 2017

		import type { PlankDate, PlankURI } from "./runtime.flow.js";


		export type ImageType = {

Add Flow Type Support #57

Add Flow Type Support #57

Conversation

maicki commented May 30, 2017 • edited Loading

TODOs:

Follow Up (No blocker):

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradencanderson May 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradencanderson commented Jun 12, 2017

bradencanderson commented Jun 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rahul-malik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maicki commented Jun 14, 2017

levi commented Jun 14, 2017

maicki commented Jun 15, 2017

ghost commented Jun 15, 2017

ghost commented Jun 15, 2017

ghost commented Jun 15, 2017

rahul-malik commented Jun 16, 2017

maicki commented Jun 16, 2017

maicki commented Jun 16, 2017

maicki commented May 30, 2017 •

edited

Loading

bradencanderson May 30, 2017 •

edited

Loading