[
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is. \nShow the code you wrote as completely as possible.\n```dart\n/// your code here\n``` \n\n**To Reproduce**\nSteps to reproduce the behavior.\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Additional context**\n1. The version of fish-redux which you are using.\n2. The information from flutter doctor.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/custom.md",
"content": "---\nname: Custom issue template\nabout: Describe this issue template's purpose here.\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n"
},
{
"path": ".gitignore",
"content": ".DS_Store\n.atom/\n.idea/\n.vscode/\n.packages\n.pub/\n.dart_tool/\nbuild/\npubspec.lock\nandroid/\nios/\n.gradle/\nbuild.gradle\ngradle/\ngradlew\ngradlew.bat\nlocal.properties\nredux.iml\npubspec.lock\nandroid/local.properties\n\n# docs\nnode_modules/\n"
},
{
"path": ".metadata",
"content": "# This file tracks properties of this Flutter project.\n# Used by Flutter tool to assess capabilities and perform upgrades etc.\n#\n# This file should be version controlled and should not be manually edited.\n\nversion:\n revision: 5391447fae6209bb21a89e6a5a6583cac1af9b4b\n channel: stable\n\nproject_type: package\n"
},
{
"path": ".travis.yml",
"content": "os:\n - linux\nsudo: false\naddons:\n apt:\n sources:\n - ubuntu-toolchain-r-test\n packages:\n - libstdc++6\n # - fonts-droid\nbefore_script:\n - git clone https://github.com/flutter/flutter.git -b stable --depth 1\n - ./flutter/bin/flutter doctor\nscript:\n - ./flutter/bin/flutter test --coverage --coverage-path=lcov.info\nafter_success:\n - bash <(curl -s https://codecov.io/bash)\ncache:\n directories:\n - $HOME/.pub-cache\n"
},
{
"path": "CHANGELOG.md",
"content": "## [0.3.7]\n- fix test .\n- revert issue 613\n\n## [0.3.6]\n- fix some dos .\n\n## [0.3.5]\n- fix deprecated using of api - inheritFromWidgetOfExactType .\n\n## [0.3.4]\n- fix PureViewComponent's dispatch bug\n\n## [0.3.3]\n- fix Page name duplication\n- easy to use reselect\n- add keep-alive-client wrapper\n- fix spell error on pure-view-widget\n- add default widget for component.buildComponent api\n- add docsify to view docs\n- add unit test for collection utils and maplike connector\n\n## [0.3.2]\n- fix Page name duplication\n\n## [0.3.1]\n- rename AdapterSource’s api \n- add PureViewComponent \n- deprecate broadcastEffect \n- \n## [0.3.0]\n- add SourceFlowAdapter\n- Use SourceFlowAdapter instead of DynamicFlowAdapter in example\n- deprecate DynamicFlowAdapter\n\n## [0.2.8]\n- fix item-bean clone bug #493\n\n## [0.2.7]\n- add StateKey #461\n- reselect optimization #482\n\n## [0.2.6]\n- add TickerProviderMixin\n- let dispatch return whatever result in effect. #462 \n- fix Reselect's _listEquals bug #457 \n- fix SingleTickerProviderMixin & TickerProviderMixin’s dispose bug #461 \n- add ClearOnDependenciesChanged \n\n## [0.2.5]\n- add ctx.listen api\n- rename LocalState to LocalProps\n- correct some comments \n\n## [0.2.4]\n- fix Context.broadcast bug #375\n- fix PrivateReducerMixin bug #380 \n- add LocalState\n\n## [0.2.3]\n- Reconstruct Context\n- Breaking-change \n - Reconstruct dependencies\n - Remove OOP style\n - Remove higherEffect\n - Remove deprecated api(Connector, createMixedStore, AutoDispose:follow, AutoDispose:follower)\n - Remove unused DisposedException\n- Hide widgets.dart's Action to compate with flutter1.7\n- Compate with flutter_web\n\n## [0.2.2]\n- add congruent conn \n- fields mainCtx & viewUpdater in ComponentState become public \n- fix bug when a store recived action after teardown\n\n## [0.2.1]\n- add forceUpdate api on context\n- fix bug in adapter’s appear & disappear if items are recycled\n- fix bug in connectStores api if page has no reducer\n\n## [0.2.0]\n- force update if driven by outside observable \n- fix inverter bugs & optimization connectStores api \n- modify the use of global state in example \n\n## [0.1.9]\n- add mixed-store's batch notification feature\n\n## [0.1.8]\n- add api to subscribe app-store for page-store\n- add api to subscribe app-store for component\n- add viewMiddleware\n- add adapterMiddleware\n- add effectMiddleware\n- add protected attribute method, more friendly to OOP\n- remove debug_report\n\n## [0.1.7]\n- reconstruct mixed-store\n- reconstruct communication\n- rename appBroadcast to broadcast\n- rename pageBroadcast to broadcastEffect\n- add dispatch-bus\n- enhance dispatch-api\n- add some docs\n- move test to dev_dependencies\n\n## [0.1.6]\n- fix bug if component has no reducer in app-routes\n- reconstruct createStore\n- app-routes's store to be visible\n\n## [0.1.5]\n- fix bug if notified on building\n- reconstruct test\n- add mergeMiddleware\\$\n\n## [0.1.4]\n- add support for AppStore\n- add routes\n- move middleware/aop to the top dir\n- add PrivateReducerMixin\n- add reselect\n- add docs\n\n## [0.1.3]\n- add support for immutable-state #111\n- fix the same type of state component reuse in listview #107\n- remove warnings in logMiddleware for debug-actions #98\n- correct spelling\n- modify bindAction #73\n\n## [0.1.2]\n- add stfState field in Context #58\n- add batchedNotify feature in page-store\n- add some docs\n- correct spelling\n\n## [0.1.1]\n- fix hot-reload bug\n- add excluedSelf in broadcast\n- rename sample to example\n- rename docs to doc\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
},
{
"path": "LICENSE",
"content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2019 Alibaba, Inc.\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License."
},
{
"path": "README.md",
"content": "
\n
Fish Redux
\n\n[](https://travis-ci.org/alibaba/fish-redux) [](https://pub.dartlang.org/packages/fish_redux) [](https://codecov.io/gh/alibaba/fish-redux)\n\n## What is Fish Redux ?\n\nFish Redux is an assembled flutter application framework based on Redux state management.\nIt is suitable for building medium and large applications.\n\nIt has four characteristics:\n\n> 1. Functional Programming\n\n> 2. Predictable state container\n\n> 3. Pluggable componentization\n\n> 4. Non-destructive performance\n\n## Architecture diagram\n\n\n\n## Installation\n\n[Go](https://pub.dartlang.org/packages/fish_redux#-installing-tab-)\n\n## Documentation\n\nLanguage: [English](doc/README.md) | [中文简体](doc/README-cn.md)\n\n## Examples\n\n- [todo list](example) - a simple todo list demo.\n- run it:\n\n```\ncd ./example\nflutter create .\nflutter run\n```\n\n## What's the difference between 'Fish Redux' and 'Redux' ?\n\n- [answers](doc/concept/what's-the-diiference.md)\n\n## Plugins\n\n### Code Template\n\n- [Fish Redux Template For Android Studio](https://github.com/BakerJQ/FishReduxTemplateForAS), by BakerJQ.\n- [Fish Redux Template For VSCode](https://github.com/huangjianke/fish-redux-template), by huangjianke.\n\n### Dev-Tools\n\n- Redux Inspector (using [Flutter Debugger](https://github.com/blankapp/flutter-debugger) and [flipperkit_fish_redux_middleware](https://pub.dartlang.org/packages/flipperkit_fish_redux_middleware)) for Fish Redux apps, by [JianyingLi](https://github.com/lijy91)\n\n## License\n\n- Fish Redux is released under the Apache 2.0 license. See [LICENSE](LICENSE) for details.\n\n\n## 关于我们\n阿里巴巴-闲鱼技术是国内最早也是最大规模线上运行Flutter的团队。\n\n我们在公众号中为你精选了Flutter独家干货，全面而深入。\n\n内容包括：Flutter的接入、规模化应用、引擎探秘、工程体系、创新技术等教程和开源信息。\n\n**架构／服务端／客户端／前端／质量工程师 在公众号中投递简历，名额不限哦**\n\n欢迎来闲鱼做一个好奇、幸福、有影响力的程序员，简历投递：tino.wjf@alibaba-inc.com\n\n订阅地址\n\n\n\n[For English](https://twitter.com/xianyutech \"For English\")\n"
},
{
"path": "analysis_options.yaml",
"content": "# Specify analysis options.\n#\n# Until there are meta linter rules, each desired lint must be explicitly enabled.\n# See: https://github.com/dart-lang/linter/issues/288\n#\n# For a list of lints, see: http://dart-lang.github.io/linter/lints/\n# See the configuration guide for more\n# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer\n#\n# There are four similar analysis options files in the flutter repos:\n# - analysis_options.yaml (this file)\n# - packages/flutter/lib/analysis_options_user.yaml\n# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml\n# - https://github.com/flutter/engine/blob/master/analysis_options.yaml\n#\n# This file contains the analysis options used by Flutter tools, such as IntelliJ,\n# Android Studio, and the `flutter analyze` command.\n#\n# The flutter/plugins repo contains a copy of this file, which should be kept\n# in sync with this file.\n\nanalyzer:\n language:\n enableSuperMixins: true\n strong-mode:\n implicit-dynamic: false\n errors:\n # treat missing required parameters as a warning (not a hint)\n missing_required_param: warning\n # treat missing returns as a warning (not a hint)\n missing_return: warning\n # allow having TODOs in the code\n todo: ignore\n\n exclude:\n - 'bin/cache/**'\n - 'flutter/**'\n # the following two are relative to the stocks example and the flutter package respectively\n # see https://github.com/dart-lang/sdk/issues/28463\n - 'lib/i18n/stock_messages_*.dart'\n - 'lib/src/http/**'\n\nlinter:\n rules:\n # these rules are documented on and in the same order as\n # the Dart Lint rules page to make maintenance easier\n # https://github.com/dart-lang/linter/blob/master/example/all.yaml\n - always_declare_return_types\n - always_put_control_body_on_new_line\n # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219\n - always_require_non_null_named_parameters\n - always_specify_types\n - annotate_overrides\n # - avoid_annotating_with_dynamic # conflicts with always_specify_types\n - avoid_as\n # - avoid_bool_literals_in_conditional_expressions # not yet tested\n # - avoid_catches_without_on_clauses # we do this commonly\n # - avoid_catching_errors # we do this commonly\n - avoid_classes_with_only_static_members\n - avoid_empty_else\n - avoid_function_literals_in_foreach_calls\n - avoid_init_to_null\n - avoid_null_checks_in_equality_operators\n # - avoid_positional_boolean_parameters # not yet tested\n # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)\n - avoid_relative_lib_imports\n - avoid_renaming_method_parameters\n - avoid_return_types_on_setters\n # - avoid_returning_null # we do this commonly\n # - avoid_returning_this # https://github.com/dart-lang/linter/issues/842\n # - avoid_setters_without_getters # not yet tested\n # - avoid_single_cascade_in_expression_statements # not yet tested\n - avoid_slow_async_io\n # - avoid_types_as_parameter_names # https://github.com/dart-lang/linter/pull/954/files\n # - avoid_types_on_closure_parameters # conflicts with always_specify_types\n # - avoid_unused_constructor_parameters # https://github.com/dart-lang/linter/pull/847\n - await_only_futures\n - camel_case_types\n - cancel_subscriptions\n # - cascade_invocations # not yet tested\n # - close_sinks # https://github.com/flutter/flutter/issues/5789\n # - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153\n # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204\n - control_flow_in_finally\n - directives_ordering\n - empty_catches\n - empty_constructor_bodies\n - empty_statements\n - hash_and_equals\n - implementation_imports\n # - invariant_booleans # https://github.com/flutter/flutter/issues/5790\n - iterable_contains_unrelated_type\n # - join_return_with_assignment # not yet tested\n - library_names\n - library_prefixes\n - list_remove_unrelated_type\n # - literal_only_boolean_expressions # https://github.com/flutter/flutter/issues/5791\n - no_adjacent_strings_in_list\n - no_duplicate_case_values\n - non_constant_identifier_names\n # - omit_local_variable_types # opposite of always_specify_types\n # - one_member_abstracts # too many false positives\n # - only_throw_errors # https://github.com/flutter/flutter/issues/5792\n - overridden_fields\n - package_api_docs\n - package_names\n - package_prefixed_library_names\n # - parameter_assignments # we do this commonly\n - prefer_adjacent_string_concatenation\n - prefer_asserts_in_initializer_lists\n - prefer_bool_in_asserts\n - prefer_collection_literals\n - prefer_conditional_assignment\n - prefer_const_constructors\n - prefer_const_constructors_in_immutables\n - prefer_const_declarations\n - prefer_const_literals_to_create_immutables\n # - prefer_constructors_over_static_methods # not yet tested\n - prefer_contains\n # - prefer_equal_for_default_values # not yet tested\n # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods\n - prefer_final_fields\n - prefer_final_locals\n - prefer_foreach\n # - prefer_function_declarations_over_variables # not yet tested\n - prefer_initializing_formals\n # - prefer_interpolation_to_compose_strings # not yet tested\n - prefer_is_empty\n - prefer_is_not_empty\n - prefer_single_quotes\n - prefer_typing_uninitialized_variables\n - recursive_getters\n - slash_for_doc_comments\n # - sort_constructors_first\n - sort_unnamed_constructors_first\n - super_goes_last\n - test_types_in_equals\n - throw_in_finally\n # - type_annotate_public_apis # subset of always_specify_types\n - type_init_formals\n # - unawaited_futures # https://github.com/flutter/flutter/issues/5793\n - unnecessary_brace_in_string_interps\n - unnecessary_getters_setters\n # - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498\n - unnecessary_null_aware_assignments\n - unnecessary_null_in_if_null_operators\n - unnecessary_overrides\n # - unnecessary_parenthesis\n # - unnecessary_statements # not yet tested\n - unnecessary_this\n - unnecessary_new\n - unnecessary_const\n - unrelated_type_equality_checks\n - use_rethrow_when_possible\n # - use_setters_to_change_properties # not yet tested\n # - use_string_buffers # https://github.com/dart-lang/linter/pull/664\n # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review\n - valid_regexps\n"
},
{
"path": "doc/README-cn.md",
"content": "- **简介**\n - [关于](introduction/README-cn.md)\n - [演进](concept/evolution-of-fish-redux.md)\n - [特性](concept/features.md)\n- **核心概念**\n - [Redux](concept/redux-cn.md)\n - [Action](concept/action-cn.md)\n - [Connector](concept/connector-cn.md)\n - [Reducer](concept/reducer-cn.md)\n - [Middleware](concept/middleware-cn.md)\n - [Component](concept/component-cn.md)\n - [View](concept/view-cn.md)\n - [Reducer](concept/reducer-cn.md)\n - [Effect](concept/effect-cn.md)\n - [HigherEffect](concept/higher-effect-cn.md)\n - [Lifecycle](concept/lifecycle-cn.md)\n - [Dependencies](concept/dependencies-cn.md)\n - [Dependent](concept/dependent-cn.md)\n - [ShouldUpdate](concept/should-update-cn.md)\n - [OnError](concept/on-error-cn.md)\n - [Filter](concept/filter-cn.md)\n - [OOP](concept/oop-cn.md)\n - [WidgetWrapper](concept/widget-wrapper-cn.md)\n - [Page](concept/page-cn.md)\n - [Adapter](concept/adapter-cn.md)\n - [StaticFlowAdapter](concept/static-flow-adapter-cn.md)\n - [DynamicFlowAdapter](concept/dynamic-flow-adapter-cn.md)\n - [CustomAdapter](concept/custom-adapter-cn.md)\n- **其他**\n - [What's the difference between 'Fish Redux' and 'Redux' ?](concept/what's-the-diiference-cn.md)\n - [What's-adapter](concept/what's-adapter.md)\n - [What's-connector](concept/what's-connector.md)\n - [Mechanism](concept/mechanism-cn.md)\n - [Directory](concept/directory-cn.md)\n"
},
{
"path": "doc/README.md",
"content": "- **Introduction**\n - [About](introduction/README.md)\n - [Evolution](concept/evolution-of-fish-redux.md)\n - [Features](concept/features.md)\n- **Core Concepts**\n - [Redux](concept/redux.md)\n - [Action](concept/action.md)\n - [Connector](concept/connector.md)\n - [Reducer](concept/reducer.md)\n - [Middleware](concept/middleware.md)\n - [Component](concept/component.md)\n - [View](concept/view.md)\n - [Reducer](concept/reducer.md)\n - [Effect](concept/effect.md)\n - [HigherEffect](concept/higher-effect.md)\n - [Lifecycle](concept/lifecycle.md)\n - [Dependencies](concept/dependencies.md)\n - [Dependent](concept/dependent.md)\n - [ShouldUpdate](concept/should-update.md)\n - [OnError](concept/on-error.md)\n - [Filter](concept/filter.md)\n - [OOP](concept/oop.md)\n - [WidgetWrapper](concept/widget-wrapper.md)\n - [Page](concept/page.md)\n - [Adapter](concept/adapter.md)\n - [StaticFlowAdapter](concept/static-flow-adapter.md)\n - [DynamicFlowAdapter](concept/dynamic-flow-adapter.md)\n - [CustomAdapter](concept/custom-adapter.md)\n- **Others**\n - [What's the difference between 'Fish Redux' and 'Redux' ?](concept/what's-the-diiference.md)\n - [What is an adapter?](concept/what's-adapter.md)\n - [What is a connector?](concept/what's-connector.md)\n - [Communication mechanism of fish-redux](concept/mechanism.md)\n - [Recommended directory structure](concept/directory.md)\n"
},
{
"path": "doc/concept/action-cn.md",
"content": "# Action\n\n- Action 包含两个字段\n - type\n - payload\n- 推荐的写法是\n - 为一个组件|适配器创建一个 action.dart 文件，包含两个类\n - 为 type 字段起一个枚举类\n - 为 Action 的创建起一个 ActionCreator 类，这样利于约束 payload 的类型。\n - Effect 接受处理的 Action，以 on{Verb} 命名\n - Reducer 接受处理的 Action，以{verb} 命名\n - 示例代码\n\n```dart\nenum MessageAction {\n onShare,\n shared,\n}\n\nclass MessageActionCreator {\n static Action onShare(Map payload) {\n return Action(MessageAction.onShare, payload: payload);\n }\n\n static Action shared() {\n return const Action(MessageAction.shared);\n }\n}\n```\n"
},
{
"path": "doc/concept/action.md",
"content": "# Action\n\n- Action contains two fields\n - type\n - payload\n- Recommended way of writing action\n - Create an action.dart file for a component|adapter that contains two classes\n - An enumeration class for the type field\n - An ActionCreator class is created for the creator of the Action, which helps to constrain the type of payload.\n - Effect Accepted Action which's type is named after `on{verb}`\n - Reducer Accepted Action which's type is named after `{verb}`\n - Sample code\n\n```dart\nenum MessageAction {\n onShare,\n shared,\n}\n\nclass MessageActionCreator {\n static Action onShare(Map payload) {\n return Action(MessageAction.onShare, payload: payload);\n }\n\n static Action shared() {\n return const Action(MessageAction.shared);\n }\n}\n```\n"
},
{
"path": "doc/concept/adapter-cn.md",
"content": "# Adapter\n\n- 我们在基础 Component 的概念外，额外增加了一种组件化的抽象 Adapter。它的目标是解决 Component 模型在 ListView 的场景下的 3 个问题\n - 1）将一个\"Big-Cell\"放在 ListView 里，无法享受 ListView 代码的性能优化。\n - 2）Component 无法区分 appear|disappear 和 init|dispose 事件。\n - 3）Effect 的生命周期和 View 的耦合，在 ListView 的有些场景下不符合直观的预期。\n- 一个 Adapter 和 Component 几乎都是一致的，除了以下几点\n - Component 生成一个 Widget，Adapter 生成一个 ListAdapter，ListAdapter 有能力生成一组 Widget。\n - 不具体生成 Widget，而是一个 ListAdapter，能非常大的提升页面帧率和流畅度。\n - Effect-Lifecycle-Promote\n - Component 的 Effect 是跟着 Widget 的生命周期走的，Adapter 的 Effect 是跟着上一级的 Widget 的生命周期走。\n - Effect 提升，极大的解除了业务逻辑和视图生命的耦合，即使它的展示还未出现，的其他模块依然能通过 dispatch-api，调用它的能力。\n - appear|disappear 的通知\n - 由于 Effect 生命周期的提升，我们就能更加精细的区分 init|dispose 和 appear|disappear。而这在 Component 的模型中是无法区分的。\n - Reducer is long-lived, Effect is medium-lived, View is short-lived.\n- Adapter 的三种实现\n - [DynamicFlowAdapter](dynamic-flow-adapter-cn.md)\n - [StaticFlowAdapter](static-flow-adapter-cn.md)\n - [CustomAdapter](custom-adapter-cn.md)\n"
},
{
"path": "doc/concept/adapter.md",
"content": "# Adapter\n\n- In addition to the concept of the underlying Component, we have added a componentized abstract Adapter. Its goal is to solve the 3 problems of the Component model in the ListView scene.\n\n - 1）Putting a \"Big-Cell\" in the ListView does not enjoy the performance optimization of the ListView code.\n - 2）Component cannot distinguish between the appear|disappear and init|dispose events.\n - 3）The life cycle of the Effect and the coupling of the View do not meet the intuitive expectations in some scenes of the ListView.\n\n- An Adapter and a Component are almost identical except for the following points\n\n - Component generates a Widget, Adapter generates a ListAdapter, and ListAdapter has the ability to generate a list of Widgets.。\n - Not specifically generating a Widget but a ListAdapter can greatly improve the page frame rate and fluency.\n - Effect-Lifecycle-Promote\n - The Effect of Component follows the life cycle of the Widget, and the Adapter's Effect follows the life cycle of the parent Widget.\n - The improvement of the life cycle of the effect greatly removes the coupling between the business logic and the view life. Even if its display has not yet appeared, other modules can still call its capabilities through dispatch-api.\n - Appearance|disappear event notification\n - As the Effect lifecycle improves, we can more closely distinguish between init|dispose and appear|disappear. This is indistinguishable from the Model's model.\n - Reducer is long-lived, Effect is medium-lived, View is short-lived.\n\n- Three implementations of Adapter\n - [DynamicFlowAdapter](dynamic-flow-adapter.md)\n - [StaticFlowAdapter](static-flow-adapter.md)\n - [CustomAdapter](custom-adapter.md)\n"
},
{
"path": "doc/concept/auto-dispose-cn.md",
"content": "# Auto-Dispose\n\n- 它是一个非常简易管理生命周期对象的方式。一个 auto-dispose 对象可以自我主动释放，或者在它 follow 的 托管对象释放的时候，释放。\n- 在 Effect 中使用的 Context，以及 HigherEffect 中的 EffectPart，都是 auto-dispose 对象。所以我们可以方便的将自定义的需要做生命周期管理的对象托管给它们。\n- 示例代码\n\n```dart\nclass ItemWidgetBindingObserver extends WidgetsBindingObserver\n with AutoDispose {\n ItemWidgetBindingObserver() : super() {\n WidgetsBinding.instance.addObserver(this);\n }\n\n @override\n void didChangeAppLifecycleState(AppLifecycleState state) {\n if (AppConfig.flutterBinding.framesEnabled &&\n state == AppLifecycleState.resumed) {\n AppConfig.flutterBinding.performReassemble();\n }\n }\n\n @override\n void dispose() {\n super.dispose();\n WidgetsBinding.instance.removeObserver(this);\n }\n}\n\nvoid _init(Action action, Context ctx) {\n final ItemWidgetBindingObserver observer = ItemWidgetBindingObserver();\n observer.follow(ctx);\n}\n\n```\n"
},
{
"path": "doc/concept/auto-dispose.md",
"content": "# Auto-Dispose\n\n- AutoDispose is a very simple way to manage lifecycle objects. An auto-dispose object can be released on its own initiative or released when the managed object it follows is released.\n- The Context used in Effect and the EffectPart in HigherEffect are auto-dispose objects. So we can easily host custom objects that need to be managed for lifecycle management.\n- Sample Code\n\n```dart\nclass ItemWidgetBindingObserver extends WidgetsBindingObserver\n with AutoDispose {\n ItemWidgetBindingObserver() : super() {\n WidgetsBinding.instance.addObserver(this);\n }\n\n @override\n void didChangeAppLifecycleState(AppLifecycleState state) {\n if (AppConfig.flutterBinding.framesEnabled &&\n state == AppLifecycleState.resumed) {\n AppConfig.flutterBinding.performReassemble();\n }\n }\n\n @override\n void dispose() {\n super.dispose();\n WidgetsBinding.instance.removeObserver(this);\n }\n}\n\nvoid _init(Action action, Context ctx) {\n final ItemWidgetBindingObserver observer = ItemWidgetBindingObserver();\n observer.follow(ctx);\n}\n\n```\n"
},
{
"path": "doc/concept/component-cn.md",
"content": "# Component\n\n组件是对视图展现和逻辑功能的封装。\n面向当下，从 Redux 的视角看，我们对组件分为状态修改的功能(Reducer)和其他。\n面向未来，从 UI-Automation 的视角看，我们对组件分为展现表达和其他。\n结合上面两个视角，于是我们得到了，View、 Effect、Reducer 三部分，称之为组件的三要素，分别负责了组件的展示、非修改数据的行为、修改数据的操作。\n\n我们以显式配置的方式来完成大组件所依赖的小组件、适配器的注册，这份依赖配置称之为 Dependencies。\n\n所以有了这个公式\nComponent = View + Effect(可选) + Reducer(可选) + Dependencies(可选)\n\n分治：从组件的角度\n\n\n集中：从 Store 的角度\n\n"
},
{
"path": "doc/concept/component.md",
"content": "# Component\n\nComponent is the encapsulation of view presentation and logic functions.\nFor the moment, from the perspective of Redux, we divide the component into state-manage functions (Reducers) and others.\nLooking to the future, from the perspective of UI-Automation, we divide the component into presentations and others.\n\nCombining the above two perspectives, we got the three parts of View, SideEffect, and Reducer, which are called the three factors of the component.\n\nWe use explicit configuration to complete the registration of components and adapters on which large component depend. This dependency configuration is called Dependencies.\n\nSo with this formula:\nComponent = View + Effect(Optional) + Reducer(Optional) + Dependencies(Optional)\n\nDivision: From the perspective of the component\n\n\nConcentration: From the perspective of the Store\n\n"
},
{
"path": "doc/concept/connector-cn.md",
"content": "# Connector\n\n- 它表达了如何从一个大数据中读取小数据，同时对小数据的修改如何同步给大数据，这样的数据连接关系。\n- 它是将一个集中式的 Reducer，可以由多层次多模块的小 Reducer 自动拼装的关键。\n - 它大大降低了我们使用 Redux 的复杂度。我们不再关心组装过程，我们关心的核心是什么动作促使数据怎么变化。\n- 它使用在配置 Dependencies 中，在配置中我们就固化了大组件和小组件之间的连接关系(数据管道)，所以在我们使用小组件的时候是不需要传入任何动态参数的。\n- \n\n- Sample Code\n\n```dart\nclass DetialState {\n Profile profile;\n String message;\n}\n\nConnOp messageConnector() {\n return ConnOp(\n get: (DetialState state) => state.message,\n set: (DetialState state, String message) => state.message = message,\n );\n}\n```\n"
},
{
"path": "doc/concept/connector.md",
"content": "# Connector\n\n- It expresses a data connection relationship of how to read small data from a big data, and how to synchronize to big data when the small data is modified。\n- It is the key to a centralized Reducer that can be assembled automatically by a multi-level, multi-module, small Reducer\n - It greatly reduces the difficulty of using Redux. We no longer care about the assembly process, we care about what specific actions cause the state to change.\n- It is used in the configuration Dependencies, in the configuration we have solidified the connection between the large component and the small component, so we do not need to pass in any dynamic parameters when we use the small component.\n- \n\n- Sample Code\n\n```dart\nclass DetialState {\n Profile profile;\n String message;\n}\n\nConnOp messageConnector() {\n return ConnOp(\n get: (DetialState state) => state.message,\n set: (DetialState state, String message) => state.message = message,\n );\n}\n```\n"
},
{
"path": "doc/concept/custom-adapter-cn.md",
"content": "# CustomAdapter\n\n- 对大 Cell 的自定义实现\n- 要素和 Component 类似，不一样的地方是 Adapter 的视图部分返回的是一个 ListAdapter\n- 示例代码\n\n```dart\nclass CommentAdapter extends Adapter {\n CommentAdapter()\n : super(\n adapter: buildCommentAdapter,\n effect: buildCommentEffect(),\n reducer: buildCommentReducer(),\n );\n}\n\nListAdapter buildCommentAdapter(CommentState state, Dispatch dispatch, ViewService service) {\n final List builders = Collections.compact([]\n ..add((BuildContext buildContext, int index) =>\n _buildDetailCommentHeader(state, dispatch, service))\n ..addAll(_buildCommentViewList(state, dispatch, service))\n ..add(isEmpty(state.commentListRes?.items)\n ? (BuildContext buildContext, int index) =>\n _buildDetailCommentEmpty(state.itemInfo, dispatch)\n : null)\n ..add(state.commentListRes?.getHasMore() == true\n ? (BuildContext buildContext, int index) => _buildLoadMore(dispatch)\n : null));\n return ListAdapter(\n (BuildContext buildContext, int index) =>\n builders[index](buildContext, index),\n builders.length,\n );\n}\n\n///builds\n```\n"
},
{
"path": "doc/concept/custom-adapter.md",
"content": "# CustomAdapter\n\n- Custom implementation of large Cell in LisView.\n- The Factors of the Adapter are similar to the Component's. The difference is that the view part of the Adapter returns a ListAdapter.\n- Sample Code\n\n```dart\nclass CommentAdapter extends Adapter {\n CommentAdapter()\n : super(\n adapter: buildCommentAdapter,\n effect: buildCommentEffect(),\n reducer: buildCommentReducer(),\n );\n}\n\nListAdapter buildCommentAdapter(CommentState state, Dispatch dispatch, ViewService service) {\n final List builders = Collections.compact([]\n ..add((BuildContext buildContext, int index) =>\n _buildDetailCommentHeader(state, dispatch, service))\n ..addAll(_buildCommentViewList(state, dispatch, service))\n ..add(isEmpty(state.commentListRes?.items)\n ? (BuildContext buildContext, int index) =>\n _buildDetailCommentEmpty(state.itemInfo, dispatch)\n : null)\n ..add(state.commentListRes?.getHasMore() == true\n ? (BuildContext buildContext, int index) => _buildLoadMore(dispatch)\n : null));\n return ListAdapter(\n (BuildContext buildContext, int index) =>\n builders[index](buildContext, index),\n builders.length,\n );\n}\n\n///builds\n```\n"
},
{
"path": "doc/concept/dependencies-cn.md",
"content": "# Dependencies\n\n- Dependencies 是一个表达组件之间依赖关系的结构。它接收两个字段\n - slots\n - {}\n - [adapter](adapter-cn.md)\n- 它主要包含三方面的信息\n - slots，组件依赖的插槽。\n - adapter，组件依赖的具体适配器（用来构建高性能的 ListView）。\n - [Dependent](dependent-cn.md) 是 subComponent | subAdapter + [connector](connector-cn.md) 的组合。\n - 一个 组件的 [Reducer](reducer-cn.md) 由 Component 自身配置的 Reducer 和它的 Dependencies 下的所有子 Reducers 自动复合而成。\n- 示例代码\n\n```dart\n///register in component\nclass ItemComponent extends ItemComponent {\n ItemComponent()\n : super(\n view: buildItemView,\n reducer: buildItemReducer(),\n dependencies: Dependencies(\n slots: >{\n 'appBar': AppBarComponent().asDependent(AppBarConnector()),\n 'body': ItemBodyComponent().asDependent(ItemBodyConnector()),\n 'ad_ball': ADBallComponent().asDependent(ADBallConnector()),\n 'bottomBar': BottomBarComponent().asDependent(BottomBarConnector()),\n },\n ),\n );\n}\n\n///call in view\nWidget buildItemView(ItemState state, Dispatch dispatch, ViewService service) {\n return Scaffold(\n body: Stack(\n children: [\n service.buildComponent('body'),\n service.buildComponent('ad_ball'),\n Positioned(\n child: service.buildComponent('bottomBar'),\n left: 0.0,\n bottom: 0.0,\n right: 0.0,\n height: 100.0,\n ),\n ],\n ),\n appBar: AppbarPreferSize(child: service.buildComponent('appBar')));\n}\n```\n"
},
{
"path": "doc/concept/dependencies.md",
"content": "# Dependencies\n\n- Dependencies is a structure that expresses dependencies between components. It accepts two fields\n - slots\n - {}\n - [adapter](adapter.md)\n- It mainly contains three aspects of information\n - The slots that the component depends on.\n - The adapter that the component depends on (used to build a high-performance ListView).\n - [Dependent](dependent.md) Is a combination of subComponent | subAdapter + [connector](connector.md)。\n - A component's [Reducer](reducer.md) is automatically compounded by the Reducer configured by the Component itself and all of the Reducers under its Dependencies.\n- Sample Code\n\n```dart\n///register in component\nclass ItemComponent extends ItemComponent {\n ItemComponent()\n : super(\n view: buildItemView,\n reducer: buildItemReducer(),\n dependencies: Dependencies(\n slots: >{\n 'appBar': AppBarComponent().asDependent(AppBarConnector()),\n 'body': ItemBodyComponent().asDependent(ItemBodyConnector()),\n 'ad_ball': ADBallComponent().asDependent(ADBallConnector()),\n 'bottomBar': BottomBarComponent().asDependent(BottomBarConnector()),\n },\n ),\n );\n}\n\n///call in view\nWidget buildItemView(ItemState state, Dispatch dispatch, ViewService service) {\n return Scaffold(\n body: Stack(\n children: [\n service.buildComponent('body'),\n service.buildComponent('ad_ball'),\n Positioned(\n child: service.buildComponent('bottomBar'),\n left: 0.0,\n bottom: 0.0,\n right: 0.0,\n height: 100.0,\n ),\n ],\n ),\n appBar: AppbarPreferSize(child: service.buildComponent('appBar')));\n}\n```\n"
},
{
"path": "doc/concept/dependent-cn.md",
"content": "### Dependent\n\n- Dependent = connector + subComponent | subAdapter 的组合，它表达了小组件|小适配器是如何连接到 Component 的。\n- 示例代码\n\n```dart\n/// todo\n```\n"
},
{
"path": "doc/concept/dependent.md",
"content": "### Dependent\n\n- Dependent = connector + subComponent | subAdapter\n- It expresses how the small component or adapter are connected to it's parent component.\n- Sample Code\n\n```dart\n/// todo\n```\n"
},
{
"path": "doc/concept/directory-cn.md",
"content": "# Directory\n\n推荐的目录结构会是这样\n\n```\nsample_page\n -- action.dart /// define action types and action creator\n -- page.dart /// config a page or component\n -- view.dart /// define a function which expresses the presentation of user interface\n -- effect.dart /// define a function which handles the side-effect\n -- reducer.dart /// define a function which handles state-change\n -- state.dart /// define a state and some connector of substate\n components\n sample_component\n -- action.dart\n -- component.dart\n -- view.dart\n -- effect.dart\n -- reducer.dart\n -- state.dart\n```\n\n上层负责组装，下层负责实现。\n"
},
{
"path": "doc/concept/directory.md",
"content": "# Directory\n\nThe recommended directory structure\n\n```\nsample_page\n -- action.dart /// define action types and action creator\n -- page.dart /// config a page or component\n -- view.dart /// define a function which expresses the presentation of user interface\n -- effect.dart /// define a function which handles the side-effect\n -- reducer.dart /// define a function which handles state-change\n -- state.dart /// define a state and some connector of substate\n components\n sample_component\n -- action.dart\n -- component.dart\n -- view.dart\n -- effect.dart\n -- reducer.dart\n -- state.dart\n```\n\nThe upper layer is responsible for assembly and the lower layer is responsible for implementation.\n"
},
{
"path": "doc/concept/dynamic-flow-adapter-cn.md",
"content": "# DynamicFlowAdapter\n\n- 模版是一个 Map，接受一个数组类型的数据驱动\n- 示例代码\n\n```dart\nclass RecommendAdapter extends DynamicFlowAdapter {\n RecommendAdapter()\n : super(\n pool: >{\n 'card_0': RecommendTitleComponent(),\n 'card_1': RecommendRowComponent(),\n },\n connector: RecommendCardListConnector(),\n );\n}\n```\n\n"
},
{
"path": "doc/concept/dynamic-flow-adapter.md",
"content": "# DynamicFlowAdapter\n\n- The template is a Map that accepts an array-like data driven\n- Sample Code\n\n```dart\nclass RecommendAdapter extends DynamicFlowAdapter {\n RecommendAdapter()\n : super(\n pool: >{\n 'card_0': RecommendTitleComponent(),\n 'card_1': RecommendRowComponent(),\n },\n connector: RecommendCardListConnector(),\n );\n}\n```\n\n\n"
},
{
"path": "doc/concept/effect-cn.md",
"content": "# Effect\n\nEffect顾名思义，用于处理Action的副作用。\n\n我估摸着有人就要问我了，副作用是啥玩意？\n\n打个比方吧，假如我拥有一个函数 `f()`\n\n```text\nfn f(x):\n return x * 1\n```\n\n此时此刻，另一个函数 `g()`\n\n```text\nfn g(x):\n changeSystemEntropy()\n return ax ^ 2 + bx + c\n```\n\n我们可以发现，`g()`里边有个改变系统熵的行为。这在函数式编程思想中，就叫做副作用，因为它可能影响到除了这个函数内部自身状态以外的其他状态。\n\n在Fish-Redux中同样，我们通过 `dispatch()` 一些action实现状态修改，但是相对于状态来说，对外部的操作，类似于 `SystemChrome.setSystemUIOverlayStyle()`这样的操作，都是副作用。\n\n现在介绍完了副作用，也没啥可介绍的了。\n\nEffect用法跟Reducer差不太多，但是作用完全不同。\n\n除了上面介绍的场景之外，异步请求也是一个经常会有的情况，这时候Effect可以帮你方便的解决这些问题。\n\n你可以通过控制effect的返回值来达到某些目的，默认情况下，effect会在reducer之前被执行。\n\n当前effect返回 `true` 的时候，就会停止后续的effect和reducer的操作\n\n当前effect返回 `false` 的时候，后续effect和reducer继续执行\n\n- Effect 是一个处理所有副作用的函数。它接收下面的参数\n - Action action\n - Context context\n - BuildContext context\n - T state\n - dispatch\n - isDisposed\n \nEffect会接收来自 View 的“意图”，包括对应的生命周期的回调，然后做出具体的执行。\n - 它的处理可能是一个异步函数，数据可能在过程中被修改，所以我们应该通过 context.state 获取最新数据。\n - 如果它要修改数据，应该发一个 Action 到 Reducer 里去处理。它对数据是只读的，不能直接去修改数据。\n - 如果它的返回值是一个非空值，则代表自己优先处理，不再做下一步的动作；否则广播给其他组件的 Effect 部分，同时发送给 Reducer。\n\n> Self-First-Broadcast。\n> \n\n- 示例代码\n\n```dart\n/// one style of writing\nFutureOr
![](\"https://img.alicdn.com/tfs/TB1r74NJyLaK1RjSZFxXXamPFXa-1024-1024.png\")
![](\"https://img.alicdn.com/tfs/TB1pkhoJr2pK1RjSZFsXXaNlXXa-1004-1370.png\")
\n\n## Installation\n\n[Go](https://pub.dartlang.org/packages/fish_redux#-installing-tab-)\n\n## Documentation\n\nLanguage: [English](doc/README.md) | [中文简体](doc/README-cn.md)\n\n## Examples\n\n- [todo list](example) - a simple todo list demo.\n- run it:\n\n```\ncd ./example\nflutter create .\nflutter run\n```\n\n## What's the difference between 'Fish Redux' and 'Redux' ?\n\n- [answers](doc/concept/what's-the-diiference.md)\n\n## Plugins\n\n### Code Template\n\n- [Fish Redux Template For Android Studio](https://github.com/BakerJQ/FishReduxTemplateForAS), by BakerJQ.\n- [Fish Redux Template For VSCode](https://github.com/huangjianke/fish-redux-template), by huangjianke.\n\n### Dev-Tools\n\n- Redux Inspector (using [Flutter Debugger](https://github.com/blankapp/flutter-debugger) and [flipperkit_fish_redux_middleware](https://pub.dartlang.org/packages/flipperkit_fish_redux_middleware)) for Fish Redux apps, by [JianyingLi](https://github.com/lijy91)\n\n## License\n\n- Fish Redux is released under the Apache 2.0 license. See [LICENSE](LICENSE) for details.\n\n\n## 关于我们\n阿里巴巴-闲鱼技术是国内最早也是最大规模线上运行Flutter的团队。\n\n我们在公众号中为你精选了Flutter独家干货，全面而深入。\n\n内容包括：Flutter的接入、规模化应用、引擎探秘、工程体系、创新技术等教程和开源信息。\n\n**架构／服务端／客户端／前端／质量工程师 在公众号中投递简历，名额不限哦**\n\n欢迎来闲鱼做一个好奇、幸福、有影响力的程序员，简历投递：tino.wjf@alibaba-inc.com\n\n订阅地址\n\n![](\"https://img.alicdn.com/tfs/TB17Ki5XubviK0jSZFNXXaApXXa-656-656.png\")
\n\n[For English](https://twitter.com/xianyutech \"For English\")\n"
},
{
"path": "analysis_options.yaml",
"content": "# Specify analysis options.\n#\n# Until there are meta linter rules, each desired lint must be explicitly enabled.\n# See: https://github.com/dart-lang/linter/issues/288\n#\n# For a list of lints, see: http://dart-lang.github.io/linter/lints/\n# See the configuration guide for more\n# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer\n#\n# There are four similar analysis options files in the flutter repos:\n# - analysis_options.yaml (this file)\n# - packages/flutter/lib/analysis_options_user.yaml\n# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml\n# - https://github.com/flutter/engine/blob/master/analysis_options.yaml\n#\n# This file contains the analysis options used by Flutter tools, such as IntelliJ,\n# Android Studio, and the `flutter analyze` command.\n#\n# The flutter/plugins repo contains a copy of this file, which should be kept\n# in sync with this file.\n\nanalyzer:\n language:\n enableSuperMixins: true\n strong-mode:\n implicit-dynamic: false\n errors:\n # treat missing required parameters as a warning (not a hint)\n missing_required_param: warning\n # treat missing returns as a warning (not a hint)\n missing_return: warning\n # allow having TODOs in the code\n todo: ignore\n\n exclude:\n - 'bin/cache/**'\n - 'flutter/**'\n # the following two are relative to the stocks example and the flutter package respectively\n # see https://github.com/dart-lang/sdk/issues/28463\n - 'lib/i18n/stock_messages_*.dart'\n - 'lib/src/http/**'\n\nlinter:\n rules:\n # these rules are documented on and in the same order as\n # the Dart Lint rules page to make maintenance easier\n # https://github.com/dart-lang/linter/blob/master/example/all.yaml\n - always_declare_return_types\n - always_put_control_body_on_new_line\n # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219\n - always_require_non_null_named_parameters\n - always_specify_types\n - annotate_overrides\n # - avoid_annotating_with_dynamic # conflicts with always_specify_types\n - avoid_as\n # - avoid_bool_literals_in_conditional_expressions # not yet tested\n # - avoid_catches_without_on_clauses # we do this commonly\n # - avoid_catching_errors # we do this commonly\n - avoid_classes_with_only_static_members\n - avoid_empty_else\n - avoid_function_literals_in_foreach_calls\n - avoid_init_to_null\n - avoid_null_checks_in_equality_operators\n # - avoid_positional_boolean_parameters # not yet tested\n # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)\n - avoid_relative_lib_imports\n - avoid_renaming_method_parameters\n - avoid_return_types_on_setters\n # - avoid_returning_null # we do this commonly\n # - avoid_returning_this # https://github.com/dart-lang/linter/issues/842\n # - avoid_setters_without_getters # not yet tested\n # - avoid_single_cascade_in_expression_statements # not yet tested\n - avoid_slow_async_io\n # - avoid_types_as_parameter_names # https://github.com/dart-lang/linter/pull/954/files\n # - avoid_types_on_closure_parameters # conflicts with always_specify_types\n # - avoid_unused_constructor_parameters # https://github.com/dart-lang/linter/pull/847\n - await_only_futures\n - camel_case_types\n - cancel_subscriptions\n # - cascade_invocations # not yet tested\n # - close_sinks # https://github.com/flutter/flutter/issues/5789\n # - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153\n # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204\n - control_flow_in_finally\n - directives_ordering\n - empty_catches\n - empty_constructor_bodies\n - empty_statements\n - hash_and_equals\n - implementation_imports\n # - invariant_booleans # https://github.com/flutter/flutter/issues/5790\n - iterable_contains_unrelated_type\n # - join_return_with_assignment # not yet tested\n - library_names\n - library_prefixes\n - list_remove_unrelated_type\n # - literal_only_boolean_expressions # https://github.com/flutter/flutter/issues/5791\n - no_adjacent_strings_in_list\n - no_duplicate_case_values\n - non_constant_identifier_names\n # - omit_local_variable_types # opposite of always_specify_types\n # - one_member_abstracts # too many false positives\n # - only_throw_errors # https://github.com/flutter/flutter/issues/5792\n - overridden_fields\n - package_api_docs\n - package_names\n - package_prefixed_library_names\n # - parameter_assignments # we do this commonly\n - prefer_adjacent_string_concatenation\n - prefer_asserts_in_initializer_lists\n - prefer_bool_in_asserts\n - prefer_collection_literals\n - prefer_conditional_assignment\n - prefer_const_constructors\n - prefer_const_constructors_in_immutables\n - prefer_const_declarations\n - prefer_const_literals_to_create_immutables\n # - prefer_constructors_over_static_methods # not yet tested\n - prefer_contains\n # - prefer_equal_for_default_values # not yet tested\n # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods\n - prefer_final_fields\n - prefer_final_locals\n - prefer_foreach\n # - prefer_function_declarations_over_variables # not yet tested\n - prefer_initializing_formals\n # - prefer_interpolation_to_compose_strings # not yet tested\n - prefer_is_empty\n - prefer_is_not_empty\n - prefer_single_quotes\n - prefer_typing_uninitialized_variables\n - recursive_getters\n - slash_for_doc_comments\n # - sort_constructors_first\n - sort_unnamed_constructors_first\n - super_goes_last\n - test_types_in_equals\n - throw_in_finally\n # - type_annotate_public_apis # subset of always_specify_types\n - type_init_formals\n # - unawaited_futures # https://github.com/flutter/flutter/issues/5793\n - unnecessary_brace_in_string_interps\n - unnecessary_getters_setters\n # - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498\n - unnecessary_null_aware_assignments\n - unnecessary_null_in_if_null_operators\n - unnecessary_overrides\n # - unnecessary_parenthesis\n # - unnecessary_statements # not yet tested\n - unnecessary_this\n - unnecessary_new\n - unnecessary_const\n - unrelated_type_equality_checks\n - use_rethrow_when_possible\n # - use_setters_to_change_properties # not yet tested\n # - use_string_buffers # https://github.com/dart-lang/linter/pull/664\n # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review\n - valid_regexps\n"
},
{
"path": "doc/README-cn.md",
"content": "- **简介**\n - [关于](introduction/README-cn.md)\n - [演进](concept/evolution-of-fish-redux.md)\n - [特性](concept/features.md)\n- **核心概念**\n - [Redux](concept/redux-cn.md)\n - [Action](concept/action-cn.md)\n - [Connector](concept/connector-cn.md)\n - [Reducer](concept/reducer-cn.md)\n - [Middleware](concept/middleware-cn.md)\n - [Component](concept/component-cn.md)\n - [View](concept/view-cn.md)\n - [Reducer](concept/reducer-cn.md)\n - [Effect](concept/effect-cn.md)\n - [HigherEffect](concept/higher-effect-cn.md)\n - [Lifecycle](concept/lifecycle-cn.md)\n - [Dependencies](concept/dependencies-cn.md)\n - [Dependent](concept/dependent-cn.md)\n - [ShouldUpdate](concept/should-update-cn.md)\n - [OnError](concept/on-error-cn.md)\n - [Filter](concept/filter-cn.md)\n - [OOP](concept/oop-cn.md)\n - [WidgetWrapper](concept/widget-wrapper-cn.md)\n - [Page](concept/page-cn.md)\n - [Adapter](concept/adapter-cn.md)\n - [StaticFlowAdapter](concept/static-flow-adapter-cn.md)\n - [DynamicFlowAdapter](concept/dynamic-flow-adapter-cn.md)\n - [CustomAdapter](concept/custom-adapter-cn.md)\n- **其他**\n - [What's the difference between 'Fish Redux' and 'Redux' ?](concept/what's-the-diiference-cn.md)\n - [What's-adapter](concept/what's-adapter.md)\n - [What's-connector](concept/what's-connector.md)\n - [Mechanism](concept/mechanism-cn.md)\n - [Directory](concept/directory-cn.md)\n"
},
{
"path": "doc/README.md",
"content": "- **Introduction**\n - [About](introduction/README.md)\n - [Evolution](concept/evolution-of-fish-redux.md)\n - [Features](concept/features.md)\n- **Core Concepts**\n - [Redux](concept/redux.md)\n - [Action](concept/action.md)\n - [Connector](concept/connector.md)\n - [Reducer](concept/reducer.md)\n - [Middleware](concept/middleware.md)\n - [Component](concept/component.md)\n - [View](concept/view.md)\n - [Reducer](concept/reducer.md)\n - [Effect](concept/effect.md)\n - [HigherEffect](concept/higher-effect.md)\n - [Lifecycle](concept/lifecycle.md)\n - [Dependencies](concept/dependencies.md)\n - [Dependent](concept/dependent.md)\n - [ShouldUpdate](concept/should-update.md)\n - [OnError](concept/on-error.md)\n - [Filter](concept/filter.md)\n - [OOP](concept/oop.md)\n - [WidgetWrapper](concept/widget-wrapper.md)\n - [Page](concept/page.md)\n - [Adapter](concept/adapter.md)\n - [StaticFlowAdapter](concept/static-flow-adapter.md)\n - [DynamicFlowAdapter](concept/dynamic-flow-adapter.md)\n - [CustomAdapter](concept/custom-adapter.md)\n- **Others**\n - [What's the difference between 'Fish Redux' and 'Redux' ?](concept/what's-the-diiference.md)\n - [What is an adapter?](concept/what's-adapter.md)\n - [What is a connector?](concept/what's-connector.md)\n - [Communication mechanism of fish-redux](concept/mechanism.md)\n - [Recommended directory structure](concept/directory.md)\n"
},
{
"path": "doc/concept/action-cn.md",
"content": "# Action\n\n- Action 包含两个字段\n - type\n - payload\n- 推荐的写法是\n - 为一个组件|适配器创建一个 action.dart 文件，包含两个类\n - 为 type 字段起一个枚举类\n - 为 Action 的创建起一个 ActionCreator 类，这样利于约束 payload 的类型。\n - Effect 接受处理的 Action，以 on{Verb} 命名\n - Reducer 接受处理的 Action，以{verb} 命名\n - 示例代码\n\n```dart\nenum MessageAction {\n onShare,\n shared,\n}\n\nclass MessageActionCreator {\n static Action onShare(Map![](\"https://img.alicdn.com/tfs/TB1vqB2J4YaK1RjSZFnXXa80pXa-900-780.png\")
\n\n集中：从 Store 的角度\n![](\"https://img.alicdn.com/tfs/TB1sThMJYvpK1RjSZFqXXcXUVXa-1426-762.png\")
\n"
},
{
"path": "doc/concept/component.md",
"content": "# Component\n\nComponent is the encapsulation of view presentation and logic functions.\nFor the moment, from the perspective of Redux, we divide the component into state-manage functions (Reducers) and others.\nLooking to the future, from the perspective of UI-Automation, we divide the component into presentations and others.\n\nCombining the above two perspectives, we got the three parts of View, SideEffect, and Reducer, which are called the three factors of the component.\n\nWe use explicit configuration to complete the registration of components and adapters on which large component depend. This dependency configuration is called Dependencies.\n\nSo with this formula:\nComponent = View + Effect(Optional) + Reducer(Optional) + Dependencies(Optional)\n\nDivision: From the perspective of the component\n![](\"https://img.alicdn.com/tfs/TB10lxHLMDqK1RjSZSyXXaxEVXa-1838-1024.png\")
\n"
},
{
"path": "doc/concept/dynamic-flow-adapter.md",
"content": "# DynamicFlowAdapter\n\n- The template is a Map that accepts an array-like data driven\n- Sample Code\n\n```dart\nclass RecommendAdapter extends DynamicFlowAdapter