over_react

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This minor release includes the following changes:

Bug Fixes

• #1009 FED-4777 Remove dart_style dep, fix builder AOT compilation
  • FED-4777 Remove dart_style dep, fix builder AOT compilation

Miscellaneous

• #1010 RM-389600 RM-389599 Release over_react 5.7.0
  • RM-389599 RELEASE over_react 5.7.0
  • RM-389600 CONSUME over_react 5.7.0

Notes created on Monday, July 06 10:26 PM UTC

• Remove dart:mirrors usage in builder to fix AOT compilation used in newer build_runner versions
• Remove dart_style and pub_semver dependencies, remove generated code formatter step
  • Generated code was already pretty well-formatted before it was passed to dart_style, and since consumers don't interact with generated code much, this should have very little impact.

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Bug Fixes

• #1002 FED-4507 Analyzer plugin: fix in Dart 3, support analyzer 6.x
  • FED-4507 Analyzer plugin doesn't work in Dart 3 due to dart:mirrors

Miscellaneous

• #1007 RM-384995 RM-384994 Release over_react 5.6.2
  • RM-384994 RELEASE over_react 5.6.2
  • RM-384995 CONSUME over_react 5.6.2

Notes created on Wednesday, March 25 07:52 PM UTC

• Analyzer plugin
  • Fix startup error (AOT compilation) in Dart 3
  • Allow analyzer 6.x, allowing parsing language versions <=3.7

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Miscellaneous

• #1004 Raise the w_common dependency max to v5.0.0

• #1005 RM-381224 RM-381223 Release over_react 5.6.1

  • RM-381223 RELEASE over_react 5.6.1
  • RM-381224 CONSUME over_react 5.6.1

Notes created on Wednesday, March 04 01:32 AM UTC

• Allow w_common 4 #1004 https://github.com/Workiva/over_react/pull/1004

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This minor release includes the following changes:

Miscellaneous

• #991 FED-4308 Add dart2js output benchmarks
  • FED-4308 Add dart2js output benchmarks
• #997 FED-4405 Allow analyzer 8.x, 9.x, 10.x
  • FED-4405 Allow analyzer 8.x, 9.x, 10.x
• #998 FED-4419 Migrate builder test to functional test, refactor gold file setup
  • FED-4419 Migrate builder test to functional test, refactor gold file setup
• #999 FED-4418 Vendor transformer utils
  • FED-4418 Vendor transformer utils
• #1000 RM-373139 RM-373138 Release over_react 5.6.0
  • RM-373138 RELEASE over_react 5.6.0
  • RM-373139 CONSUME over_react 5.6.0

Notes created on Monday, February 16 05:01 PM UTC

• Update analyzer dependency to >=5.13.0 <11.0.0 (allow 8, 9, and 10)
• Remove dependency on transformer_utils

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This minor release includes the following changes:

New Features and Improvements

• #989 FED-4215 Low-hanging dart2js code side optimizations
  • FED-4215 over_react generated code size quick wins

Miscellaneous

• #992 FED-4304 Fix stable ci, make generated accessor mixins true mixins
  • FED-4304 Fix stable ci, make generated accessor mixins true mixins
• #995 RM-351836 RM-351835 Release over_react 5.5.0
  • RM-351835 RELEASE over_react 5.5.0
  • RM-351836 CONSUME over_react 5.5.0

Notes created on Tuesday, January 06 10:05 PM UTC

• [#989] Optimize generated code to decrease dart2js compile size, saving ~577 bytes per component (when using -03 --csp --minify)
• [#992] Fix compilation errors for legacy boilerplate defined in libraries with a Dart language version of >=3.0

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Miscellaneous

• #984 Rollout React 18 to tests and example apps

• #985 no_entrypoint_imports

• #986 FED-4063 Set up gha-dart-oss

  • FED-4063 Set up gha-dart-oss in over_react

• #987 Consume react-dart 7.3.1

• #988 RM-343175 RM-343174 Release over_react 5.4.6

  • RM-343174 RELEASE over_react 5.4.6
  • RM-343175 CONSUME over_react 5.4.6

Notes created on Tuesday, August 26 10:05 PM UTC

• [#986] Set up gha-dart-oss
• [#985] Remove entrypoint imports
• [#984] Rollout React 18 to tests and example apps

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

New Features and Improvements

• #979 FED-3730 Exclude images when publishing, reducing tarball from 5.9MB to 1.3MB
  • FED-3730 Exclude images when publishing, reducing tarball from 5.9MB to 1.3MB

Miscellaneous

• #978 Consume react-dart 7.3.0

• #982 FED-3977 Allow analyzer 7

  • FED-3977 Dart 3 - Allow analyzer 7 in over_react

• #983 RM-326642 RM-326641 Release over_react 5.4.5

  • RM-326641 RELEASE over_react 5.4.5
  • RM-326642 CONSUME over_react 5.4.5

Notes created on Wednesday, July 16 10:55 PM UTC

• Update analyzer dependency to >=5.13.0 <8.0.0 (allow v8)
• Update dart_style dependency to >=2.0.0 <4.0.0 (allow v3)
• Pub package tarball: exclude documentation image files, optimizing download size from ~5.9MB to ~1.3MB
• Consume react-dart 7.3.0 (React 18 compatible)

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Bug Fixes

• #972 FED-3476 Adjust builder for Dart 3
  • FED-3476 over_react builder fails on doc comment analysis warnings

Miscellaneous

• #976 RM-323591 RM-323590 Release over_react 5.4.4
  • RM-323590 RELEASE over_react 5.4.4
  • RM-323591 CONSUME over_react 5.4.4

Notes created on Monday, April 14 10:25 PM UTC

• [#972] Generate parts even when there are analysis warnings/errors in the source file's unresolved AST
  • For example, the new doc_directive_unknown warning on doc comments in Dart 3

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Bug Fixes

• #974 FED-3585 Fix fragment type check assert
  • FED-3585 Passing Fragment ReactElements into utilities causes false positive assertion

Miscellaneous

• #966 Revert "FEDX-1997: adjust manageAndReturnTypedDisposable"

  • FEDX-1997 Update over_react to ensure it is compatible with FEDX-1991

• #969 dart_dependency_validator_config

• #973 FED-3274 React 18 Prep

  • FED-3274 React 18 discovery: over_react

• #975 RM-298715 RM-298714 Release over_react 5.4.3

  • RM-298714 RELEASE over_react 5.4.3
  • RM-298715 CONSUME over_react 5.4.3

Notes created on Wednesday, March 26 03:15 PM UTC

• [#966] Revert #964 (an attempt to fix manageAndReturnTypedDisposable typing)
• [#969] Use a dart_dependency_validator.yaml config file
• [#973] React 18 Prep
  • Bumps the minimum Dart SDK from 2.17.0 to 2.19.0
• [#974] Fix fragment type check assert

Info

Build: (waiting for build to complete)
Skynet Results: (waiting for Skynet results)
Pipeline: (waiting for pipeline to start)
This patch release includes the following changes:

Miscellaneous

• #959 FED-3249 Update docs about migrator companion codemod

  • FED-3249 Update migration guide about migrator companion codemod

• #963 Raise the meta dependency min to v1.16.0

• #964 FEDX-1997: adjust manageAndReturnTypedDisposable

  • FEDX-1997 Update over_react to ensure it is compatible with FEDX-1991

• #965 RM-291641 RM-291640 Release over_react 5.4.2

  • RM-291640 RELEASE over_react 5.4.2
  • RM-291641 CONSUME over_react 5.4.2

Notes created on Wednesday, November 20 09:19 PM UTC

• [#964] Fix bad override of manageAndReturnTypedDisposable caused by w_common 3.3.0

• [#958] Officially support Dart 3, raise SDK constraint explicitly

  • This did not involve any changes that would affect consumers; previous null-safe versions should also work in Dart 3.

  • Note: there's a known bug in Dart >=3.3.0 <3.5.0 that breaks behavior in DDC of certain functions passed to components, such as refs and potentially JS callback props: https://github.com/dart-lang/sdk/issues/56897.

    During development, we recommend either avoiding those Dart versions or compiling with dart2js.

• [#960] Raise analyzer upper bound to allow 6.x

• [#957] Docs: add more details around connect vs hooks

• [#941] Add Dart wrapper for React lazy
• [#952] Docs: fix diagram formatting in null safety migration guide

• [#951] Internal CI fixes

• [#944] Analyzer plugin: Don't lint for required props that are specified due to prop forwarding

• [#937] Use and export a new, more expressive typedef for Object? called ReactNode

• [#934] Tighten dependency ranges following null-safety release
• [#935] Docs: update null safety migration guide with required props codemod instructions

• [#920] Support conversion of prop values via annotations: @ConvertProp, @convertJsMapProp, @convertJsRefProp
• [#925] Remove publish action that always fails due to dry run warnings
• [#928] Fix num keys incorrectly linting as not unique
• [#930] Fix Analyzer Plugin error when typing keys
• [#932] Update the null safety migration documentation

• Consume over_react_test 3.0.0

• Migrate to null safety
• Support generating code for null-safe libraries (while retaining support for non-null-safe libraries)
• Add ability to declare required, optionally-non-nullable props and state fields using Dart's late keyword (AKA "late required props")
  • Stay tuned for fully baked null safety documentation for this library!

Analyzer plugin

• Add new lint, over_react_required_prop (#896)
  • Warns for missing late required props
  • Supports linting for missing @requiredProp required props (these are deprecated in favor of late), but this is disabled by default
• Add new lint, over_react_unsafe_required_prop_access, that warns when accessing required props on potentially incomplete maps
• Reinstate functionality that had to be disabled in over_react 4.8.3 since it wasn't fully null-safe
  • Lints (AKA diagnostics)
    • over_react_boilerplate_error, over_react_boilerplate_warning
    • over_react_incorrect_doc_comment_location
  • Assist for toggling class component statefulness
• Update diagnostics, fixes, and assists to work on null-safe code, add null-safe test cases

API additions

• Add members to UiProps to support late required props (stay tuned for more documentation on these)
  • Extension methods: getPropKey, containsProp, getRequiredProp(OrNull)
  • disableRequiredPropValidation
  • Internal use only: validateRequiredProps, requiredPropNamesToSkipValidation
• Add createContextInit for creating contexts with non-nullable values
• Add isLate field to PropDescriptor and StateDescriptor

Breaking changes

• Deprecated API removals:
  • BuiltReduxUiComponent, BuiltReduxUiProps
  • package:over_react/experimental.dart (only exported built_redux APIs)
  • forwardRef (not to be confused with uiForwardRef)
  • The displayName argument of registerComponent and registerComponent2
• The following props classes can no longer be extended or instantiated directly (like most components). To instantiate them, use the factory instead.
  • FragmentProps
  • StrictModeProps
  • ReduxProviderProps (for extension, mix in ReduxProviderPropsMixin instead)
  • ProviderProps (factory: Context.Provider)
  • ConsumerProps (factory: Context.Consumer)
• The following props are now required:
  • FluxUiPropsMixin.actions, FluxUiPropsMixin.store
  • ProviderProps.value (ProviderProps is the return type of Context.Provider)
  • ReduxMultiProviderProps.storesByContext
  • ReduxProviderProps.store
• UiPropsMapView (deprecated)
  • is now abstract and requires subclasses to override selfFactory
  • now extends directly from UiProps, and longer implements MapView (it still implements Map)
  • props now returns the backing map instead of this
• react_dom.render arg loosened from ReactElement to dynamic
• Other changes that we don't expect to affect consumers:
  • PropsMeta/StateMeta constructor arguments fields and keys are now required
  • ProviderProps.props type has been widened from JsMap to Map (now matches ConsumerProps and other props classes)
  • ConnectPropsMixin now implements UiProps (the one exported from package:over_react/over_react.dart) instead of UiProps's superclass of the same name, component_base.UiProps.

• [#881] Fix disableRequiredPropValidation annotation and add test

• [#879] Backpatch @Props(disableRequiredPropValidation) annotation arg

• [#853] Allow react 7 and w_flux 3

• [#846] Update internals to prepare for react-dart 7.0.0

• [#835] Upgrade dependencies, notably jumping to analyzer 5.x
  • analyzer: ^5.1.0 (was >=1.7.2 <3.0.0)
  • dart_style: ^2.0.0 (was >=1.2.5 <3.0.0)
  • w_common: ^3.0.0 (was >=2.0.0 <4.0.0)

• [#829] Add improved prop forwarding methods (UiProps.getPropsToForward/.addPropsToForward)
• [#809], [#826], [#827] Example app dependency updates

• [#824] Update 3rd party dependencies

• [#820] Add Suspense Component
• [#819] More dependency updates

• [#815] Dependency updates: dart_dev: '>=3.0.0 <5.0.0'
• [#816] Dependency updates: w_common: '>=2.0.0 <4.0.0'

• 4.8.3 was missing the analyzer plugin in the published package for some reason, and this release should hopefully include it again.

• [#807] Allow analyzer 2.x, fix analyzer plugin not starting in newer SDKs

• [#804] Dependencies: raise analyzer to ^1.7.2, unpin meta
• [#805] Internal CI and dev_dependencies updates

• [#802] Raise platform_detect upperbound to allow 2.x
• [#800] (Docs) Add Redux DevTools integration documentation

• [#797] Add overReactReduxDevToolsMiddlewareFactory for constructing middleware with a name, allowing store instances to be separated in the Redux Dev Tools

• [#795] Add jsifyMapListProp and unjsifyMapListProp conversion utils

Analyzer Plugin

• [#788] Add new over_react_hooks_exhaustive_deps diagnostic that validates the dependency lists of React hooks such as useEffect, useMemo, and useCallback.

  Ported/forked from the JS eslint-plugin-react-hooks react-hooks/exhaustive-deps rule (info from the React docs, package, source), this Dart diagnostic aims to provide parity with the dev experience of the JS lint rule, with some tweaks to work better with Dart and over_react's flavor of React APIs.

• [#785] Add utilities for jsifying/unsifying context props

• [#782] w_common v2 rollout (part 1)
• [#783] w_common v2 rollout (part 2)

• [#774] Make error message when component failed to initialize more helpful
• [#778] Allow w_common 2

• [#770] Fix component names not showing in Error Boundary stacks for class-based components
• [#769] Add documentation for wrapping JS components using uiJsComponent

• [#764] (Example app) Widen uuid dependency

• [#743] Add js_component.dart entrypoint with utilities for wrapping JS React components. More in-depth documentation around how to use these APIs and best practices is coming soon.

Analyzer Plugin

• Fix diagnostics not working in Dart >=2.13, by upgrading to analyzer_plugin 0.6.0
• Diagnostics can be configured with custom severity, including disabling them (docs)
• New diagnostics:
  • over_react_create_ref_usage - Warns when using createRef in a function component instead of useRef
  • over_react_non_defaulted_prop - Warns when using a prop in a function component instead of a local variable that defaults the prop
  • over_react_rules_of_hooks - Warns when calling hooks conditionally or using hooks outside of function components or custom hook functions
  • over_react_style_camel_case - Warns when using non-camelCased keys in style maps, which get ignored by React
• New assists:
  • Convert between function and class component syntax (only moves code around and doesn't migrate lifecycle methods, state, hooks, etc.)
• Improvements to existing features:
  • over_react_invalid_render_return_type - Update to work with function components
  • over_react_duplicate_prop_cascade - Fix duplicate DOM props not linting in certain cases
  • "Add ref" assist and ref object quick fixes - Update to work with function components
• Migrate most code to null safety, fix several potential null errors
• Improve test coverage

• [#736] Raise dependency upper bounds to allow analyzer 1.x, built_redux 8.x, dart_style 2.x, and quiver 3.x

• [#742] Update AriaPropsMixin
• [#737] Temporarily disable the mockito builder for better build perf
• [#741] Replace deprecated commands with new dart commands

• [#733] Update SafeRenderManager to not be retained by the React tree it renders, to aid in memory leak testing. Outside of that context, this change has negligible effects.

• [#729] Raise built_value lower bound to ^8.0.0

• [#730] Fix bug where components using the React Redux useSelector and createSelectorHook hook APIs would rerender on every store update, even when there were no changes to selected values

• [#722] Dependency upgrades

• [#720] Auto-tear-down ConnectFluxAdapterStores when backing Flux stores dispose
• Bump react lower bound to 6.1.4

Internal Tech Debt:

• Dev dependencies: remove dart2_constant, update test_html_builder and dependency_validator to latest
• CI: Don't run main build in Dart 2.14 until we can upgrade pkg:analyzer and get it passing again
• CI: Fix analyzer plugin build

• [#710] Support type-checking directly from the UiFactory to better support JS components

• [#708] Add 2.13.4 to CI matrix
• [#709] Raise the Dart SDK minimum to at least 2.11.0

• Reinstate null-aware isDisposedOrDisposing (removed in [#703]/4.2.1) to support tests with mocked stores

• [#703] Improve FluxUiComponent logging when attempting to subscribe to a disposed store

• [#701] Add elementType convenience getter to UiFactory, Change meta dependency lower-bound to 1.1.6 to prevent dependency gridlock (missed in [#695]).

• [#698] Conditionally unconvert style and children props

• [#689] Copy language version comments to generated part files
• [#695] Widen Dependency Ranges Blocking Dart 2.13

• [#685] Remove deprecated authors field from pubspec.yaml
• [#691] Enable resolution of build_web_compilers 2.12.0, fix Dart stable build

• [#679] Update boilerplate to be compatible with Dart >=2.9.0.

  This introduced a new component factory syntax that future proofs the boilerplate syntax through Dart 2.12! For more information and migration instructions, refer to the PR description.

• [#674] Add Redux hooks.

  Introducing new Redux hook APIs! OverReact consumers also using OverReact Redux can now use the useDispatch, useSelector, and useStore hooks. For more information, refer to the documenation.

• [#655] Add the capability to configure ComponentTypeMeta on functional components via setComponentMeta.

  Those who used class based components were accustomed to being able to modify meta data by using the @Component2() annotation. Previously, there was no way to do this on functional components. However, the new setComponentMeta API fixes this and allows for similar capabilities on functional components.

This stable, major release of over_react includes:

ReactJS 17.x Support

The underlying .js files provided by this package are now ReactJS version 17.0.1.

Full List of Breaking Changes

• [#643] Use propsOrStateMapsEqual in memo so that function tearoffs don't cause unnecessary rerenders.