analysis_options.yaml

#
# Copyright 2025 LiveKit
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

include: package:lints/recommended.yaml

analyzer:
  errors:
    constant_identifier_names: ignore
    use_super_parameters: ignore
    avoid_print: ignore
    deprecated_member_use_from_same_package: ignore

  # Exclude generated files: protobuf, and json_serializable output. Neither is
  # hand-edited, so lint hits there can only be fixed by changing the generator.
  exclude:
    - "**/*.pb.dart"
    - "**/*.pbenum.dart"
    - "**/*.pbjson.dart"
    - "**/*.pbserver.dart"
    - "**/*.g.dart"
    # - 'web/*.dart'
    # Xcode vendors Swift package checkouts under build when Swift Package
    # Manager is enabled and this package ships Package.swift.
    - build/**
    - example/build/**
    # Flutter's AnalysisOptionsMigration (flutter_tools) appends these seven
    # patterns to this file on every `flutter analyze`/`pub get`/`run`. There is
    # no opt-out, so they are committed here to stop the file being rewritten.
    # Note this excludes web/, which in this package holds real Dart source (the
    # E2EE worker) rather than just assets -- CI analyzes it explicitly with
    # `dart analyze web/`, which does not run migrators.
    - android/**
    - ios/**
    - web/**
    - windows/**
    - macos/**
    - linux/**

linter:
  rules:
    # Preference of the SDK
    prefer_single_quotes: true
    prefer_final_locals: true
    unnecessary_brace_in_string_interps: false
    avoid_print: true

    # Enforce this for correct async logic
    unawaited_futures: true
    discarded_futures: true

formatter:
  page_width: 120
  trailing_commas: preserve