mirror of
https://github.com/immich-app/immich.git
synced 2024-12-29 15:11:58 +00:00
9503bf479b
* feat(mobile): album view sort order * feat: add error message * refactor(mobile): album page (#14659) * refactor album page * update lint rule * const record * fix: updating sort order when pull to refresh --------- Co-authored-by: Alex <alex.tran1502@gmail.com> * Move sort toggle button to bottom sheet menu * chore: revert multiselectgrid loading status * chore: revert multiselectgrid loading status --------- Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
158 lines
6.8 KiB
YAML
158 lines
6.8 KiB
YAML
# This file configures the analyzer, which statically analyzes Dart code to
|
|
# check for errors, warnings, and lints.
|
|
#
|
|
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
|
|
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
|
|
# invoked from the command line by running `flutter analyze`.
|
|
|
|
# The following line activates a set of recommended lints for Flutter apps,
|
|
# packages, and plugins designed to encourage good coding practices.
|
|
include: package:flutter_lints/flutter.yaml
|
|
|
|
linter:
|
|
# The lint rules applied to this project can be customized in the
|
|
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
|
|
# included above or to enable additional rules. A list of all available lints
|
|
# and their documentation is published at
|
|
# https://dart-lang.github.io/linter/lints/index.html.
|
|
#
|
|
# Instead of disabling a lint rule for the entire project in the
|
|
# section below, it can also be suppressed for a single line of code
|
|
# or a specific dart file by using the `// ignore: name_of_lint` and
|
|
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
|
|
# producing the lint.
|
|
|
|
rules:
|
|
# avoid_print: false # Uncomment to disable the `avoid_print` rule
|
|
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
|
|
use_build_context_synchronously: false
|
|
require_trailing_commas: true
|
|
unrelated_type_equality_checks: true
|
|
prefer_const_constructors: true
|
|
|
|
# Additional information about this file can be found at
|
|
# https://dart.dev/guides/language/analysis-options
|
|
analyzer:
|
|
exclude:
|
|
- openapi/**
|
|
- lib/generated_plugin_registrant.dart
|
|
|
|
plugins:
|
|
- custom_lint
|
|
|
|
custom_lint:
|
|
debug: true
|
|
rules:
|
|
- avoid_build_context_in_providers: false
|
|
- avoid_public_notifier_properties: false
|
|
- avoid_manual_providers_as_generated_provider_dependency: false
|
|
- unsupported_provider_value: false
|
|
- import_rule_photo_manager:
|
|
message: photo_manager must only be used in MediaRepositories
|
|
restrict: package:photo_manager
|
|
allowed:
|
|
# required / wanted
|
|
- 'lib/repositories/{album,asset,file}_media.repository.dart'
|
|
# acceptable exceptions for the time being
|
|
- lib/entities/asset.entity.dart # to provide local AssetEntity for now
|
|
- lib/providers/image/immich_local_{image,thumbnail}_provider.dart # accesses thumbnails via PhotoManager
|
|
# refactor to make the providers and services testable
|
|
- lib/providers/backup/{backup,manual_upload}.provider.dart # uses only PMProgressHandler
|
|
- lib/services/{background,backup}.service.dart # uses only PMProgressHandler
|
|
- import_rule_isar:
|
|
message: isar must only be used in entities and repositories
|
|
restrict: package:isar
|
|
allowed:
|
|
# required / wanted
|
|
- lib/entities/*.entity.dart
|
|
- lib/repositories/{album,asset,backup,database,etag,exif_info,user}.repository.dart
|
|
# acceptable exceptions for the time being (until Isar is fully replaced)
|
|
- integration_test/test_utils/general_helper.dart
|
|
- lib/main.dart
|
|
- lib/pages/album/album_asset_selection.page.dart
|
|
- lib/routing/router.dart
|
|
- lib/services/immich_logger.service.dart # not really a service... more a util
|
|
- lib/utils/{db,migration,renderlist_generator}.dart
|
|
- lib/widgets/asset_grid/asset_grid_data_structure.dart
|
|
- test/**.dart
|
|
# refactor the remaining providers
|
|
- lib/providers/{archive,asset,authentication,db,favorite,partner,trash,user}.provider.dart
|
|
- lib/providers/{album/album,album/shared_album,asset_viewer/asset_stack,asset_viewer/render_list,backup/backup,search/all_motion_photos,search/recently_added_asset}.provider.dart
|
|
|
|
- import_rule_openapi:
|
|
message: openapi must only be used through ApiRepositories
|
|
restrict: package:openapi
|
|
allowed:
|
|
# requried / wanted
|
|
- lib/repositories/*_api.repository.dart
|
|
# acceptable exceptions for the time being
|
|
- lib/entities/{album,asset,exif_info,user}.entity.dart # to convert DTOs to entities
|
|
- lib/utils/{image_url_builder,openapi_patching}.dart # utils are fine
|
|
- test/modules/utils/openapi_patching_test.dart # filename is self-explanatory...
|
|
# refactor
|
|
- lib/models/map/map_marker.model.dart
|
|
- lib/models/server_info/server_{config,disk_info,features,version}.model.dart
|
|
- lib/models/shared_link/shared_link.model.dart
|
|
- lib/providers/asset_viewer/asset_people.provider.dart
|
|
- lib/providers/auth.provider.dart
|
|
- lib/providers/image/immich_remote_{image,thumbnail}_provider.dart
|
|
- lib/providers/map/map_state.provider.dart
|
|
- lib/providers/search/{search,search_filter}.provider.dart
|
|
- lib/providers/websocket.provider.dart
|
|
- lib/routing/auth_guard.dart
|
|
- lib/services/{api,asset,backup,memory,oauth,search,shared_link,stack,trash}.service.dart
|
|
- lib/widgets/album/album_thumbnail_listtile.dart
|
|
- lib/widgets/forms/login/login_form.dart
|
|
- lib/widgets/search/search_filter/{camera_picker,location_picker,people_picker}.dart
|
|
- lib/services/auth.service.dart # on ApiException
|
|
- test/services/auth.service_test.dart # on ApiException
|
|
|
|
dart_code_metrics:
|
|
metrics:
|
|
cyclomatic-complexity: 20
|
|
number-of-parameters: 4
|
|
maximum-nesting-level: 5
|
|
rules:
|
|
# Common
|
|
- avoid-accessing-collections-by-constant-index
|
|
- avoid-accessing-other-classes-private-members
|
|
- avoid-cascade-after-if-null
|
|
- avoid-collapsible-if
|
|
- avoid-collection-methods-with-unrelated-types
|
|
- avoid-double-slash-imports
|
|
- avoid-duplicate-cascades
|
|
- avoid-duplicate-patterns
|
|
- avoid-generics-shadowing
|
|
- avoid-global-state
|
|
# Flutter
|
|
- add-copy-with:
|
|
file-name-pattern: '.model.dart'
|
|
- always-remove-listener
|
|
- avoid-border-all
|
|
- avoid-empty-setstate
|
|
- avoid-expanded-as-spacer
|
|
- avoid-incomplete-copy-with
|
|
- avoid-inherited-widget-in-initstate
|
|
- avoid-late-context
|
|
- avoid-recursive-widget-calls
|
|
- avoid-returning-widgets
|
|
- avoid-shrink-wrap-in-lists
|
|
- avoid-single-child-column-or-row
|
|
- avoid-state-constructors
|
|
- avoid-stateless-widget-initialized-fields
|
|
- avoid-unnecessary-overrides-in-state
|
|
- avoid-unnecessary-stateful-widgets
|
|
- avoid-wrapping-in-padding
|
|
- dispose-fields
|
|
- prefer-const-border-radius
|
|
- prefer-correct-edge-insets-constructor
|
|
- prefer-dedicated-media-query-methods
|
|
- prefer-define-hero-tag
|
|
- prefer-extracting-callbacks
|
|
- prefer-single-widget-per-file:
|
|
ignore-private-widgets: true
|
|
- prefer-sliver-prefix
|
|
- prefer-text-rich
|
|
- prefer-using-list-view
|
|
- proper-super-calls
|
|
- use-setstate-synchronously
|