Baseflow / Baseflow/flutter_cache_manager

[2.0.0] Rename Config to CacheManagerConfig

Open
#237 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Dart
Stars
809
Forks
510
Avg merge
6m
Merged PRs (30d)
1

Description

## 🏗 Enhancement Proposal

Since version 2.0.0 the flutter_cache_manager exports a class called `Config`. This name is very general and causes problems in all my projects because I have a general Config class.

I think the name `Config` is a very bad choice, as it is way to general. So I propose renaming it to `CacheManagerConfig` to prevent conflicts like these to occur.

I know that it is possible to work around this issue by using `import a as b`, but I think this should be avoided to make the development process more easy.

Also the name `CacheManagerConfig` would be much more intuitive to use, as you usually wouldn't expect to have a class called `Config`, but rather somthing like `CacheManager***` while writing your code with intellisense.

Contributor guide

Open the contributing guide

Research direction

Start by locating the exported Config declaration and every reference to it in flutter_cache_manager. Review the package's existing tests and public API entry points before deciding the rename scope; done means the requested CacheManagerConfig name is used consistently and the affected tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, flutter
Domain
mobile
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.