Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: prevent from confusing and conflicting class names #1465

Merged
merged 4 commits into from
Apr 9, 2023

Conversation

Gustl22
Copy link
Collaborator

@Gustl22 Gustl22 commented Apr 7, 2023

Description

As some of the classes introduced in #1352 are quite generic and could conflict with other packages, we should rename them to be more specific to the package:

  • Refactor GlobalEvent to GlobalAudioEvent
  • Refactor PlayerEvent to AudioEvent
  • Refactor Logger to AudioLogger
  • Refactor LogLevel to AudioLogLevel

PlayerEvent was renamed to have the same scheme as GlobalAudioEvent and so that it is more applicable to Audio and not to all players in general (e.g. media or video player).

Checklist

  • The title of my PR starts with a [Conventional Commit] prefix (fix:, feat:, docs:, chore: etc).
  • I have read the [Contributor Guide] and followed the process outlined for submitting PRs.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation and added dartdoc comments with ///, where necessary.
  • I have updated/added relevant examples in [example].

Breaking Change

This is a breaking change regarding the current master channel, but not the published versions.

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

audioplayers

Before After
GlobalEvent GlobalAudioEvent
PlayerEvent AudioEvent
Logger AudioLogger
LogLevel AudioLogLevel

audioplayers_platform_interface

Before After
GlobalEvent GlobalAudioEvent
PlayerEvent AudioEvent

Related Issues

#1352

@Gustl22 Gustl22 marked this pull request as ready for review April 7, 2023 17:18
@Gustl22 Gustl22 force-pushed the gustl22/refactor-logger-global-scope branch from 374881d to 60dec68 Compare April 9, 2023 19:14
@Gustl22 Gustl22 enabled auto-merge (squash) April 9, 2023 19:32
@Gustl22 Gustl22 merged commit 7cdb858 into main Apr 9, 2023
@Gustl22 Gustl22 deleted the gustl22/refactor-logger-global-scope branch April 9, 2023 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants