Merge branch 'main' into nullsafe-work

supagu · May 24, 2021 · 5757555 · 5757555
2 parents b112c1e + 0573258
commit 5757555
Show file tree

Hide file tree

Showing 44 changed files with 495 additions and 118 deletions.
diff --git a/.github/workflows/CI.yaml b/.github/workflows/CI.yaml
diff --git a/.github/workflows/cicd.yaml b/.github/workflows/cicd.yaml
@@ -0,0 +1,62 @@
+name: cicd
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  # BEGIN LINTING STAGE
+  dartdoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '12.x'
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+      - run: ./scripts/dartdoc.sh
+
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '12.x'
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+      - run: ./scripts/format.sh
+
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '12.x'
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+      - run: ./scripts/analyze.sh
+  # END LINTING STAGE
+
+  # BEGIN TESTING STAGE
+  test:
+    needs: [dartdoc, format, analyze]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '12.x'
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+      - run: ./scripts/test.sh
+  # END TESTING STAGE
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,5 @@ pubspec.lock
 .packages
 .dart_tool
 .vscode/
+coverage/
+doc/
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Tiled Dart
 
-[![Pub](https://img.shields.io/pub/v/tiled.svg?style=popout)](https://pub.dartlang.org/packages/tiled) ![CI](https://github.com/flame-engine/tiled.dart/workflows/CI/badge.svg?branch=main&event=push) [![Discord](https://img.shields.io/discord/509714518008528896.svg)](https://discord.gg/pxrBmy4)
+[![Pub](https://img.shields.io/pub/v/tiled.svg?style=popout)](https://pub.dartlang.org/packages/tiled) ![cicd](https://github.com/flame-engine/tiled.dart/workflows/cicd/badge.svg?branch=main&event=push) [![Discord](https://img.shields.io/discord/509714518008528896.svg)](https://discord.gg/pxrBmy4)
 
 A Dart Tiled library.
 
@@ -34,9 +34,10 @@ If your tmx file includes a external tsx reference, you have to add a CustomPars
 ```dart
 class CustomTsxProvider extends TsxProvider {
   @override
-  XmlNode getSource(String filename) {
-    final String xml = File(filename).readAsStringSync();
-    return XmlDocument.parse(xml).rootElement;
+  Parser getSource(String fileName) {
+    final xml = File(fileName).readAsStringSync();
+    final node = XmlDocument.parse(xml).rootElement;
+    return XmlParser(node);
   }
 }
 ```

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -1,68 +1,147 @@
 # Source of linter options:
 # http://dart-lang.github.io/linter/lints/options/options.html
 
+analyzer:
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+
+  plugins:
+    - dart_code_metrics
+
 linter:
   rules:
     - always_declare_return_types
     - always_put_control_body_on_new_line
     - always_require_non_null_named_parameters
     - annotate_overrides
+    - avoid_double_and_int_checks
+    - avoid_dynamic_calls
     - avoid_empty_else
+    - avoid_escaping_inner_quotes
     - avoid_field_initializers_in_const_classes
     - avoid_init_to_null
+    - avoid_js_rounded_ints
     - avoid_null_checks_in_equality_operators
+    - avoid_private_typedef_functions
+    - avoid_redundant_argument_values
     - avoid_relative_lib_imports
     - avoid_return_types_on_setters
+    - avoid_shadowing_type_parameters
     - avoid_slow_async_io
+    - avoid_type_to_string
+    - avoid_types_as_parameter_names
+    - avoid_unused_constructor_parameters
     - await_only_futures
+    - camel_case_extensions
     - camel_case_types
     - cancel_subscriptions
+    - cast_nullable_to_non_nullable
+    - close_sinks
+    - comment_references
+    - constant_identifier_names
     - control_flow_in_finally
+    - curly_braces_in_flow_control_structures
+    - directives_ordering
+    - do_not_use_environment
     - empty_catches
     - empty_constructor_bodies
     - empty_statements
+    - exhaustive_cases
+    - file_names
     - hash_and_equals
     - implementation_imports
+    - invariant_booleans
     - iterable_contains_unrelated_type
+    - join_return_with_assignment
     - library_names
     - library_prefixes
     - list_remove_unrelated_type
+    - literal_only_boolean_expressions
+    - missing_whitespace_between_adjacent_strings
     - no_adjacent_strings_in_list
     - no_duplicate_case_values
-    - non_constant_identifier_names
+    - no_runtimeType_toString
+    - omit_local_variable_types
     - package_api_docs
     - package_names
     - package_prefixed_library_names
+    - parameter_assignments
     - prefer_adjacent_string_concatenation
     - prefer_asserts_in_initializer_lists
     - prefer_collection_literals
     - prefer_conditional_assignment
     - prefer_const_constructors
+    - prefer_const_constructors_in_immutables
     - prefer_const_declarations
     - prefer_const_literals_to_create_immutables
     - 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_foreach
+    - 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_interpolation_to_compose_strings
     - prefer_is_empty
     - prefer_is_not_empty
+    - prefer_is_not_operator
+    - prefer_iterable_whereType
+    - prefer_mixin
+    - prefer_null_aware_operators
+    - prefer_single_quotes
+    - prefer_spread_collections
+    - prefer_relative_imports
     - prefer_typing_uninitialized_variables
+    - prefer_void_to_null
+    - provide_deprecation_message
     - recursive_getters
     - slash_for_doc_comments
     - sort_unnamed_constructors_first
     - test_types_in_equals
     - throw_in_finally
+    - type_annotate_public_apis
     - type_init_formals
+    - unnecessary_await_in_return
     - unnecessary_brace_in_string_interps
+    - unnecessary_const
     - unnecessary_getters_setters
+    - unnecessary_lambdas
+    - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_in_if_null_operators
     - unnecessary_overrides
     - unnecessary_parenthesis
+    - unnecessary_raw_strings
+    - unnecessary_statements
+    - unnecessary_string_escapes
+    - unnecessary_string_interpolations
     - unnecessary_this
-    - unrelated_type_equality_checks
+    - use_full_hex_values_for_flutter_colors
+    - use_function_type_syntax_for_parameters
+    - use_is_even_rather_than_modulo
     - use_rethrow_when_possible
-    - unnecessary_new
+    - unrelated_type_equality_checks
+    - unsafe_html
+    - void_checks
 
+dart_code_metrics:
+  rules:
+    - prefer-trailing-comma
+    - prefer-trailing-comma-for-collection
+    - no-equal-then-else
+    - no-object-declaration
+    - potential-null-dereference
+  metrics-exclude:
+    - test/**
+  metrics:
+    number-of-parameters: 8
+    number-of-methods: 32
+    source-lines-of-code: 200
+    cyclomatic-complexity: 36
diff --git a/lib/src/chunk.dart b/lib/src/chunk.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <chunk>
 ///
 /// * x: The x coordinate of the chunk in tiles.
@@ -13,7 +16,7 @@ part of tiled;
 ///
 /// The data inside is a compressed (encoded) representation of a list
 /// (that sequentially represents a matrix) of integers representing
-/// [TileData]s.
+/// [Gid]s.
 class Chunk {
   List<int> data;
 

diff --git a/lib/src/common/enums.dart b/lib/src/common/enums.dart
@@ -208,7 +208,7 @@ extension LayerTypeExtension on LayerType {
   }
 
   static LayerType parseFromTmx(String name) {
-    if (name == "layer") {
+    if (name == 'layer') {
       return LayerType.tileLayer;
     }
     return LayerType.values.firstWhere((e) => e.name == name);

diff --git a/lib/src/common/frame.dart b/lib/src/common/frame.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <frame>
 ///
 /// * tileid: The local ID of a tile within the parent <tileset>.

diff --git a/lib/src/common/gid.dart b/lib/src/common/gid.dart
@@ -57,11 +57,11 @@ class Gid {
       return List.generate(width, (x) {
         final gid = data[(y * width) + x];
         // get flips from id
-        final bool flippedHorizontally =
+        final flippedHorizontally =
             (gid & flippedHorizontallyFlag) == flippedHorizontallyFlag;
-        final bool flippedVertically =
+        final flippedVertically =
             (gid & flippedVerticallyFlag) == flippedVerticallyFlag;
-        final bool flippedDiagonally =
+        final flippedDiagonally =
             (gid & flippedDiagonallyFlag) == flippedDiagonallyFlag;
         // clear id from flips
         final tileId = gid &

diff --git a/lib/src/common/point.dart b/lib/src/common/point.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <point>
 /// Used to mark an object as a point.
 /// The existing x and y attributes are used to determine the position of the

diff --git a/lib/src/common/property.dart b/lib/src/common/property.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <property>
 /// * name: The name of the property.
 /// * type: The type of the property.

diff --git a/lib/src/common/tiled_image.dart b/lib/src/common/tiled_image.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <image>
 ///
 /// * format: Used for embedded images, in combination with a data child element.

diff --git a/lib/src/editor_setting/chunk_size.dart b/lib/src/editor_setting/chunk_size.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <chunksize>
 ///
 /// * width: The width of chunks used for infinite maps (default to 16).

diff --git a/lib/src/editor_setting/editor_setting.dart b/lib/src/editor_setting/editor_setting.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <editorsettings>
 /// This element contains various editor-specific settings,
 /// which are generally not relevant when reading a map.

diff --git a/lib/src/editor_setting/export.dart b/lib/src/editor_setting/export.dart
@@ -1,5 +1,8 @@
 part of tiled;
 
+/// Below is Tiled's documentation about how this structure is represented
+/// on XML files:
+///
 /// <export>
 ///
 /// * target: The last file this map was exported to.