CPLAT-4109: Update documentation for dart2 #231

corwinsheahan-wf · 2019-02-07T00:01:52Z

Ultimate problem:

The transformer is gone and the boilerplate has changed, so we need to update documentation to reflect that.

How it was fixed:

Update documentation/transformer references.

Testing suggestions:

CI Passes

Potential areas of regression:

N/A

FYA: @greglittlefield-wf @aaronlademann-wf @kealjones-wk @evanweible-wf @maxwellpeterson-wf @sebastianmalysa-wf @smaifullerton-wk @georgelesica-wf

aviary3-wk · 2019-02-07T00:02:09Z

Security Insights

No security relevant content was detected by automated scans.

Action Items

Review PR for security impact; comment "security review required" if needed or unsure
Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

corwinsheahan-wf

Just one question

corwinsheahan-wf · 2019-02-07T00:55:43Z

CONTRIBUTING.md

+    Name | Branch
+    ---- | ------
+    over_react 2.x.x-dart1 | master_dart1
+    over_react 2.x.x-dart2 | master


Shouldn't these be +dart1 and +dart2? Also, I thought we had talked about dropping the suffix for dart2 and just have 2.x.x for Dart 2, and 2.x.x+dart1 for Dart 1. Is that still a thing?

I am 90% sure one of our internal release tools has an issue with the + character, so we've used - in the past. That's one of the reasons I want to do a dev release of 2.0 to make sure that works.

And yeah we had talked about that, I'd be cool with dropping the dart2 suffix

Cool. +1 on dropping the dart2 suffix.

README.md

evanweible-wf · 2019-02-07T00:46:53Z

README.md

@@ -184,25 +159,29 @@ or [as a typed view into an existing props map](#uiprops-as-a-map).
 ### UiProps

 __`UiProps` is a Map class__ that adds statically-typed getters and setters for each React component prop.
-It can also be invoked as a function, serving as a builder for its analogous component.
+It can also be invoked as a function, serving as a builder for its analogous component. 


trailing space

evanweible-wf · 2019-02-07T00:48:03Z

README.md

+* Note: The [builder] will make the concrete getters and setters available in a generated class which has the same name
+as the class annotated with `@State()`, but without the `_$` prefix (which would be `FooState` in the above code).
+The generated class will also have the same API. So, consumers who wish to extend the functionality of `_$FooState` should 
+use the generated version, `FooProps`.


Suggested change

use the generated version, `FooProps`.

use the generated version, `FooState`.

evanweible-wf · 2019-02-07T00:49:54Z

README.md

@@ -664,7 +647,8 @@ Now that we’ve gone over how to [use the `over_react` package in your project]
 the [anatomy of a component](#anatomy-of-an-overreact-component) and the [DOM components](#dom-components-and-props)
 that you get for free from OverReact, you're ready to start building your own custom React UI components.

-1. Start with one of the [component boilerplate templates](#component-boilerplate-templates) below.
+1. Start with one of the [component boilerplate templates](#component-boilerplate-templates) below 
+(Or, use OverReact's [code snippets for Intellij and Vs Code](snippets/README.md).


Need another closing paren ) at the end here

evanweible-wf · 2019-02-07T00:51:35Z

README.md

@@ -674,7 +658,7 @@ that you get for free from OverReact, you're ready to start building your own cu
 4. Run [the app you’ve set up to consume `over_react`](#using-it-in-your-project)

    ```bash
-    $ pub serve
+    $ pub run build_runner serve
    ```

    _That’s it! Code will be automatically generated on the fly by Pub!_


This isn't accurate anymore, the builder is generating the code not pub.

evanweible-wf · 2019-02-07T00:59:47Z

lib/src/builder/README.md

+
+    ```
+
+5. Finally, it the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our 


Suggested change

5. Finally, it the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our

5. Finally, the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our

…ct into update_readme_for_Dart2

…e_readme_for_Dart2

aaronlademann-wf

Few minor things.

aaronlademann-wf · 2019-02-07T19:39:18Z

README.md


    ```bash
-    $ pub run test --pub-serve=8081 test/your_test_file.dart
+    $ pub run build_runner test -- -p chrome test/your_test_file.dart


This doesn't work. Have to run

pub run build_runner test -- -P dartdevc

or

pub run build_runner test -r -- -P dart2js

Those presets apply to this project only, and may not be present in consumer repos. pub run build_runner test -- -p chrome test/your_test_file.dart should be valid for a generic case.

I'll update with a section for running tests in this repo as well as the more generic command.

aaronlademann-wf · 2019-02-07T19:40:19Z

README.md

-      - $dart2js
-    ```
+When running tests on code that uses our [builder] _(or any code that imports `over_react`)_,
+__you must run your tests using build_runner__.


Should add a huge, bold callout here that any running build_runner watch or build_runner serve tasks should be killed before running build_runner test to avoid destruction of the cached asset graph.

dart-lang/build#352 (comment)

aaronlademann-wf · 2019-02-07T19:44:50Z

README.md

@@ -664,7 +646,8 @@ Now that we’ve gone over how to [use the `over_react` package in your project]
 the [anatomy of a component](#anatomy-of-an-overreact-component) and the [DOM components](#dom-components-and-props)
 that you get for free from OverReact, you're ready to start building your own custom React UI components.

-1. Start with one of the [component boilerplate templates](#component-boilerplate-templates) below.
+1. Start with one of the [component boilerplate templates](#component-boilerplate-templates) below 
+(Or, use OverReact's [code snippets for Intellij and Vs Code](snippets/README.md)).


this relative link won't work when the readme is published, for instance, to pub.dartlang.org. It needs to be an absolute link to that readme.

Same thing on line 672

docs.yml

aaronlademann-wf

+1

…_readme_for_Dart2

aaronlademann-wf · 2019-02-07T20:31:26Z

+1 refresh

docs.yml

Co-Authored-By: corwinsheahan-wf <corwin.sheahan@workiva.com>

evanweible-wf · 2019-02-07T23:04:51Z

QA +1

CI passes (mostly documentation changes)

@Workiva/release-management-p

remove last vestiges of transformer mentions

70efd7d

corwinsheahan-wf requested a review from a team as a code owner February 7, 2019 00:01

rmconsole-wf added the Merge Requirements Unmet label Feb 7, 2019

corwinsheahan-wf changed the title ~~CPLAT-4109: Update readme for dart2~~ CPLAT-4109: Update documentation for dart2 Feb 7, 2019

Add dual-release line instructions to CONTRIBUTING.md

2064c89

corwinsheahan-wf commented Feb 7, 2019

View reviewed changes

evanweible-wf requested changes Feb 7, 2019

View reviewed changes

corwinsheahan-wf and others added 5 commits February 6, 2019 18:17

address review feedback

ce6e3aa

No -dart2 suffix for the dart2 release

6b4fdea

Merge branch 'update_readme_for_Dart2' of github.com:Workiva/over_rea…

99273f7

…ct into update_readme_for_Dart2

Merge branch 'dart2_only' into update_readme_for_Dart2

79e5ea5

Merge branch 'dart2_only' of github.com:Workiva/over_react into updat…

6d7aa31

…e_readme_for_Dart2

aaronlademann-wf requested changes Feb 7, 2019

View reviewed changes

corwinsheahan-wf added 2 commits February 7, 2019 13:07

address review comments

e004c2e

Fix rendering of test preset examples in README

19dea7b

aaronlademann-wf approved these changes Feb 7, 2019

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Feb 7, 2019

Merge branch '2.0.0-dev' of github.com:Workiva/over_react into update…

6737b5a

…_readme_for_Dart2

rmconsole-wf added Merge Requirements Unmet and removed Merge Requirements Met labels Feb 7, 2019

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Feb 7, 2019

maxwellpeterson-wf approved these changes Feb 7, 2019

View reviewed changes

aaronlademann-wf reviewed Feb 7, 2019

View reviewed changes

docs.yml Outdated Show resolved Hide resolved

Update docs.yml

b79771e

Co-Authored-By: corwinsheahan-wf <corwin.sheahan@workiva.com>

rmconsole-wf added Merge Requirements Unmet and removed Merge Requirements Met labels Feb 7, 2019

evanweible-wf approved these changes Feb 7, 2019

View reviewed changes

rmconsole-wf added the RM Ready label Feb 7, 2019

evanweible-wf added the dart2 PRs targeting our effort to get to Dart SDK 2.0 compatibility label Feb 7, 2019

evanweible-wf added this to the 2.0.0 (Dart 1 and Dart 2 compatibility) milestone Feb 7, 2019

maxwellpeterson-wf approved these changes Feb 7, 2019

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Feb 7, 2019

rmconsole7-wk merged commit 5b26361 into 2.0.0-dev Feb 7, 2019

rmconsole7-wk deleted the update_readme_for_Dart2 branch February 7, 2019 23:58

rmconsole-readonly-wk mentioned this pull request Feb 8, 2019

CPLAT-246 CPLAT-245 Release over_react 2.0.0-alpha #239

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CPLAT-4109: Update documentation for dart2 #231

CPLAT-4109: Update documentation for dart2 #231

corwinsheahan-wf commented Feb 7, 2019

aviary3-wk commented Feb 7, 2019

corwinsheahan-wf left a comment

corwinsheahan-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

corwinsheahan-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

evanweible-wf Feb 7, 2019

aaronlademann-wf left a comment

aaronlademann-wf Feb 7, 2019

corwinsheahan-wf Feb 7, 2019

aaronlademann-wf Feb 7, 2019

aaronlademann-wf Feb 7, 2019

aaronlademann-wf Feb 7, 2019

aaronlademann-wf left a comment

aaronlademann-wf commented Feb 7, 2019

evanweible-wf commented Feb 7, 2019

	use the generated version, `FooProps`.
	use the generated version, `FooState`.


		```

		5. Finally, it the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our

	5. Finally, it the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our
	5. Finally, the initializer for our factory (_$Foo) is generated with a function that returns a new instance of our

CPLAT-4109: Update documentation for dart2 #231

CPLAT-4109: Update documentation for dart2 #231

Conversation

corwinsheahan-wf commented Feb 7, 2019

Ultimate problem:

How it was fixed:

Testing suggestions:

Potential areas of regression:

aviary3-wk commented Feb 7, 2019

Security Insights

Action Items

corwinsheahan-wf 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

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

aaronlademann-wf 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronlademann-wf left a comment

Choose a reason for hiding this comment

aaronlademann-wf commented Feb 7, 2019

evanweible-wf commented Feb 7, 2019