Skip to content
This repository was archived by the owner on Jan 31, 2025. It is now read-only.

Commit

Permalink
feat!: update to Dart3 and modernize code (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
GregoryConrad authored Dec 19, 2024
1 parent 794b014 commit 049d365
Show file tree
Hide file tree
Showing 19 changed files with 177 additions and 1,219 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ name: Publish Release
on:
push:
tags:
- 'unnested-v[0-9]+.[0-9]+.[0-9]+*'
- "*"

jobs:
publish_github_release:
runs-on: ubuntu-latest
permissions:
contents: write # this is required for action-gh-release
steps:
- uses: actions/checkout@v3
- uses: softprops/action-gh-release@v1
Expand Down
38 changes: 0 additions & 38 deletions .github/workflows/release.yml

This file was deleted.

6 changes: 3 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test Code
name: Build & Test

on:
pull_request:
Expand All @@ -19,8 +19,8 @@ jobs:
- uses: bluefireteam/melos-action@v2

- name: Check code format
run: melos run check-format --no-select
run: melos format --set-exit-if-changed
- name: Run code analysis
run: melos run analyze --no-select
run: melos analyze --fatal-infos --fatal-warnings
- name: Run tests
run: melos run test
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
</p>

The easy way to unnest even the most complicated of widget trees,
based on the power of macros in Dart 3.
based on the power of the upcoming macros feature.

---

# IMPORTANT
This library is just a placeholder for now with some prototype code.
Dart 3 and macros have not been released yet.
Macros in Dart have not been released yet.

Also, there are still a few in-code TODOs that need to be worked out.

Expand Down Expand Up @@ -46,9 +46,6 @@ import 'package:flutter/material.dart';
@unnested
import 'package:my_app/my_custom_widget.dart';
// other Widget imports with @unnested...
// The @unnested macros above will construct an Unnest class for you
// that you can then import in your other UI files.
```

### Step 3: Use Unnested
Expand All @@ -68,12 +65,12 @@ Widget build(BuildContext context) => Unnest()

#### Stateful Widgets
```dart
// This example uses Unstate, a modern state management solution
// built around Dart 3! After you're done here, go check it out!
@unstateWidget
Widget _countDisplay(@C(countCapsule) int count) => Unnest()
// This example uses ReArch, a modern state management solution.
// After you are done here, go check it out!
@rearchWidget
Widget _countDisplay(WidgetHandle use) => Unnest()
.padding(padding: const EdgeInsets.all(8))
.text('$count'); // simply reference your state variables
.text('${use(countCapsule)}'); // simply reference your state variables
```

#### Including Custom Widgets
Expand Down Expand Up @@ -119,7 +116,7 @@ Widget build(BuildContext context) => Unnest()
### Step 4: Going Beyond
Here are some helpful hints to make working with Unnested easier.

- Unnested plays very nicely with `Unstate` for state management, as they are sister projects
- Unnested plays very nicely with `ReArch` for state management, as they are sister projects
- Create a `widgets` Flutter package and use a monorepo tool like [Melos](https://melos.invertase.dev)
- Helps split up your code in a logical way too!
- When using Unnested to create stateless widgets, using the `=>` syntax
Expand Down
209 changes: 3 additions & 206 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,208 +1,5 @@
# Modified from [email protected]
# TODO update for Dart 3
analyzer:
language:
strict-casts: true
strict-inference: true
strict-raw-types: true
include: package:very_good_analysis/analysis_options.yaml

analyzer:
errors:
missing_required_param: error
missing_return: error

exclude:
- test/.test_coverage.dart
- lib/generated_plugin_registrant.dart
- '**/lib/macro_api/**'

linter:
rules:
- always_declare_return_types
- always_put_required_named_parameters_first
- always_use_package_imports
- annotate_overrides
- avoid_bool_literals_in_conditional_expressions
- avoid_catching_errors
- avoid_double_and_int_checks
- avoid_dynamic_calls
- avoid_empty_else
- avoid_equals_and_hash_code_on_mutable_classes
- avoid_escaping_inner_quotes
- avoid_field_initializers_in_const_classes
- avoid_final_parameters
- avoid_function_literals_in_foreach_calls
- avoid_init_to_null
- avoid_js_rounded_ints
- avoid_multiple_declarations_per_line
- avoid_null_checks_in_equality_operators
- avoid_positional_boolean_parameters
- avoid_print
- avoid_private_typedef_functions
- avoid_redundant_argument_values
- avoid_relative_lib_imports
- avoid_renaming_method_parameters
- avoid_return_types_on_setters
- avoid_returning_null_for_void
- avoid_returning_this
- avoid_setters_without_getters
- avoid_shadowing_type_parameters
- avoid_single_cascade_in_expression_statements
- avoid_slow_async_io
- avoid_type_to_string
- avoid_types_as_parameter_names
- avoid_unnecessary_containers
- avoid_unused_constructor_parameters
- avoid_void_async
- avoid_web_libraries_in_flutter
- await_only_futures
- camel_case_extensions
- camel_case_types
- cancel_subscriptions
- cast_nullable_to_non_nullable
- collection_methods_unrelated_type
- combinators_ordering
- comment_references
- conditional_uri_does_not_exist
- constant_identifier_names
- control_flow_in_finally
- curly_braces_in_flow_control_structures
- dangling_library_doc_comments
- depend_on_referenced_packages
- deprecated_consistency
- directives_ordering
- empty_catches
- empty_constructor_bodies
- empty_statements
- enable_null_safety
- eol_at_end_of_file
- exhaustive_cases
- file_names
- flutter_style_todos
- hash_and_equals
- implicit_call_tearoffs
- implementation_imports
- iterable_contains_unrelated_type
- join_return_with_assignment
- leading_newlines_in_multiline_strings
- library_annotations
- library_names
- library_prefixes
- library_private_types_in_public_api
- lines_longer_than_80_chars
- list_remove_unrelated_type
- literal_only_boolean_expressions
- missing_whitespace_between_adjacent_strings
- no_adjacent_strings_in_list
- no_default_cases
- no_duplicate_case_values
- no_leading_underscores_for_library_prefixes
- no_leading_underscores_for_local_identifiers
- no_logic_in_create_state
- no_runtimeType_toString
- non_constant_identifier_names
- noop_primitive_operations
- null_check_on_nullable_type_parameter
- null_closures
- omit_local_variable_types
- one_member_abstracts
- only_throw_errors
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
- parameter_assignments
- prefer_adjacent_string_concatenation
- prefer_asserts_in_initializer_lists
- prefer_asserts_with_message
- prefer_collection_literals
- prefer_conditional_assignment
- prefer_const_constructors
- prefer_const_constructors_in_immutables
- prefer_const_declarations
- prefer_const_literals_to_create_immutables
- prefer_constructors_over_static_methods
- prefer_contains
- prefer_equal_for_default_values
- prefer_final_fields
- prefer_final_in_for_each
- prefer_final_locals
- prefer_for_elements_to_map_fromIterable
- prefer_function_declarations_over_variables
- prefer_generic_function_type_aliases
- prefer_if_elements_to_conditional_expressions
- prefer_if_null_operators
- prefer_initializing_formals
- prefer_inlined_adds
- prefer_int_literals
- prefer_interpolation_to_compose_strings
- prefer_is_empty
- prefer_is_not_empty
- prefer_is_not_operator
- prefer_iterable_whereType
- prefer_null_aware_method_calls
- prefer_null_aware_operators
- prefer_single_quotes
- prefer_spread_collections
- prefer_typing_uninitialized_variables
- prefer_void_to_null
- provide_deprecation_message
- public_member_api_docs
- recursive_getters
- require_trailing_commas
- secure_pubspec_urls
- sized_box_for_whitespace
- sized_box_shrink_expand
- slash_for_doc_comments
- sort_child_properties_last
- sort_constructors_first
- sort_pub_dependencies
- sort_unnamed_constructors_first
- test_types_in_equals
- throw_in_finally
- tighten_type_of_initializing_formals
- type_annotate_public_apis
- type_init_formals
- unawaited_futures
- unnecessary_await_in_return
- unnecessary_brace_in_string_interps
- unnecessary_const
- unnecessary_constructor_name
- unnecessary_getters_setters
- unnecessary_lambdas
- unnecessary_late
- unnecessary_library_directive
- unnecessary_new
- unnecessary_null_aware_assignments
- unnecessary_null_checks
- unnecessary_null_in_if_null_operators
- unnecessary_nullable_for_final_variable_declarations
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_raw_strings
- unnecessary_statements
- unnecessary_string_escapes
- unnecessary_string_interpolations
- unnecessary_this
- unnecessary_to_list_in_spreads
- unrelated_type_equality_checks
- use_build_context_synchronously
- use_colored_box
- use_decorated_box
- use_enums
- use_full_hex_values_for_flutter_colors
- use_function_type_syntax_for_parameters
- use_if_null_to_convert_nulls_to_bools
- use_is_even_rather_than_modulo
- use_key_in_widget_constructors
- use_late_for_private_fields_and_variables
- use_named_constants
- use_raw_strings
- use_rethrow_when_possible
- use_setters_to_change_properties
- use_string_buffers
- use_string_in_part_of_directives
- use_super_parameters
- use_test_throws_matchers
- use_to_and_as_if_applicable
- valid_regexps
- void_checks
close_sinks: warning
12 changes: 0 additions & 12 deletions melos.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,6 @@ packages:
- 'packages/**'

scripts:
analyze:
exec: dart analyze . --fatal-infos
description: Analyze a specific package in this project.

check-format:
exec: dart format --set-exit-if-changed .
description: Check the format of a specific package in this project.

format:
exec: dart format .
description: Format a specific package in this project.

test:
run: melos run test:dart --no-select && melos run test:flutter --no-select
description: Run all Dart & Flutter tests in this project.
Expand Down
3 changes: 1 addition & 2 deletions packages/unnested/example/lib/main.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:flutter/material.dart';
import 'package:unnested/unnested.dart';

// NOTE: this is a trivial example
// ignore_for_file: public_member_api_docs

class Unnest extends UnmodifiableRecursiveBuilder {}

void main() {
runApp(
const MaterialApp(
Expand Down
2 changes: 1 addition & 1 deletion packages/unnested/example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Example project using Unnested.
publish_to: none

environment:
sdk: ">=2.19.2 <3.0.0"
sdk: ">=3.6.0 <4.0.0"

dependencies:
flutter:
Expand Down
10 changes: 0 additions & 10 deletions packages/unnested/lib/macro_api/api.dart

This file was deleted.

Loading

0 comments on commit 049d365

Please sign in to comment.