docs(readme): install as regular dependency (not dev)#3
Merged
Conversation
magic_devtools/dusk/telescope are imported in lib/main.dart (under kDebugMode), so they are regular dependencies, not dev_dependencies: a dev_dependencies entry trips the depend_on_referenced_packages lint, and kDebugMode already tree-shakes them from release builds. Aligns with how fluttersdk_dusk and fluttersdk_telescope document their own installation.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Updates installation guidance to recommend adding magic_devtools (and related tooling packages) under regular dependencies rather than dev_dependencies, aligning with how the packages are imported/used from consumer app lib/ code and avoiding depend_on_referenced_packages lint hits.
Changes:
- Rewrites the README Install section rationale to explain why these packages must be regular dependencies.
- Updates the sample
pubspec.yamlsnippet fromdev_dependencies:todependencies:.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Install | ||
|
|
||
| It is a dev tool, not a runtime dependency, so it belongs under `dev_dependencies`: | ||
| `magic_devtools` and the tooling packages are imported in `lib/main.dart` (under `kDebugMode`), so they are regular `dependencies`, not `dev_dependencies` — `kDebugMode` tree-shakes them out of release builds, and because `lib/` imports them a `dev_dependencies` entry would trip the `depend_on_referenced_packages` lint. This matches how `fluttersdk_dusk` and `fluttersdk_telescope` are installed on their own. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Install section recommended
dev_dependencies, but magic_devtools/dusk/telescope are imported inlib/main.dart(underkDebugMode), which trips thedepend_on_referenced_packageslint (4 infos on a fresh consumer). They are regulardependencies—kDebugModetree-shakes them from release builds — matching how dusk/telescope document their own install. Surfaced by a fresh-app E2E test.