Merge pull request #1 from Iconica-Development/feature/first_version

feat: version 1.0.0 of linter

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0
+
+- First version of `analysis_options`
+
 # 0.0.0
 
 - Add blank `analysis_options`

example/analysis_options.yaml

@@ -1,5 +1,7 @@
 include: package:flutter_iconica_analysis/analysis_options.yaml
 
+# https://dart-lang.github.io/linter/lints/index.html
+
 # Possible to overwrite the rules from the package
 
 analyzer:

lib/analysis_options.yaml

@@ -1,6 +1,96 @@
+include: package:flutter_lints/flutter.yaml
+
 analyzer:
   exclude:
 
 linter:
   rules:
+    # https://dart-lang.github.io/linter/lints/index.html
+    # rules with # default are already enabled by flutter_lints but specified here for completeness
+
+    # default rules can't be changed because they are part of flutter_lints and we want to follow the Effective Dart rules
+
+    # Error Rules
+    always_use_package_imports: true
+    prefer_relative_imports: false
+    avoid_dynamic_calls: true
+    avoid_empty_else: true
+    avoid_print: true # default
+    avoid_types_as_parameter_names: true
+    avoid_web_libraries_in_flutter: true # default
+    cancel_subscriptions: true
+    close_sinks: true
+    empty_statements: true
+    literal_only_boolean_expressions: true
+    no_adjacent_strings_in_list: true
+    no_logic_in_create_state: true # default
+    prefer_void_to_null: true
+    unnecessary_statements: true
+    use_build_context_synchronously: true # default
+    use_key_in_widget_constructors: true # default
+    valid_regexps: true
+
+    # Style Rules
+    always_declare_return_types: true
+    always_put_control_body_on_new_line: true
+    always_put_required_named_parameters_first: true
+    always_specify_types: false
+    annotate_overrides: true
+    avoid_bool_literals_in_conditional_expressions: true
+    avoid_final_parameters: true
+    avoid_multiple_declarations_per_line: true
+    avoid_returning_null: true
+    avoid_returning_null_for_void: true
+    avoid_unnecessary_containers: true # default
+    avoid_unused_constructor_parameters: true
+    avoid_void_async: true
+    camel_case_extensions: true
+    curly_braces_in_flow_control_structures: false
+    directives_ordering: true
+    empty_catches: true
+    empty_constructor_bodies: true
+    enable_null_safety: true
+    eol_at_end_of_file: true
+    file_names: true
+    flutter_style_todos: true
+    library_names: true
+    library_prefixes: true
+    lines_longer_than_80_chars: true
+    missing_whitespace_between_adjacent_strings: true
+    omit_local_variable_types: true
+    prefer_adjacent_string_concatenation: true
+    prefer_conditional_assignment: true
+    prefer_const_constructors: true # default
+    prefer_const_constructors_in_immutables: true # default
+    prefer_const_declarations: true # default
+    prefer_contains: true
     prefer_single_quotes: true
+    prefer_double_quotes: false
+    prefer_equal_for_default_values: true
+    prefer_if_null_operators: true
+    prefer_interpolation_to_compose_strings: true
+    prefer_is_empty: true
+    prefer_is_not_empty: true
+    prefer_iterable_whereType: true
+    prefer_typing_uninitialized_variables: true
+    require_trailing_commas: true
+    sized_box_for_whitespace: true # default
+    sort_child_properties_last: true # default
+    unawaited_futures: true
+    unnecessary_await_in_return: true
+    unnecessary_brace_in_string_interps: true
+    unnecessary_const: true
+    unnecessary_constructor_name: true
+    unnecessary_final: true
+    unnecessary_lambdas: true
+    unnecessary_new: true
+    unnecessary_parenthesis: true
+    unnecessary_raw_strings: true
+    unnecessary_string_interpolations: true
+    use_full_hex_values_for_flutter_colors: true # default
+    use_is_even_rather_than_modulo: true
+    void_checks: true
+
+    # Pub Rules
+    package_names: true
+    secure_pubspec_urls: true

pubspec.yaml

@@ -1,10 +1,14 @@
 name: flutter_iconica_analysis
-version: 0.0.0
+version: 1.0.0
 description: Lint rules for Dart and Flutter used internally at Iconica Development BV.
 repository: https://github.com/Iconica-Development/flutter_iconica_analysis
 issue_tracker: https://github.com/Iconica-Development/flutter_iconica_analysis/issues
 homepage: https://github.com/Iconica-Development/flutter_iconica_analysis
 documentation: https://github.com/Iconica-Development/flutter_iconica_analysis
 
 environment:
-  sdk: ">=2.18.0 <3.0.0"
+  sdk: ">=2.18.0 <3.0.0"
+
+# depend on the latest version of the linter package
+dependencies:
+  flutter_lints: ^2.0.0