Refactor rename the package and the private deps #28
Conversation
- Change the example database name in the .env.example file - Update from 'ht_api_db' to 'flutter_news_app_api_server_full_source_code_db' - Ensure users have a clear example of the expected database name
- Update project name and repository URL - Update all dependency package names and repository URLs to reflect new locations - Replace "ht_" prefix with more generic names across all dependencies
- Change repository name to flutter_news_app_api_server_full_source_code - Update GitHub links to point to new repository location - Reflect new project name in README content
- Remove wildcard ignore for 'ht_*' - Add individual ignores for core packages - Add ignores for email and data related packages - Add ignore for http_client package
- Update package imports to use core package - Rename repository packages to remove 'ht_' prefix - Rename http_client package to remove 'ht_' prefix - Update class imports to use new package structure - Rename logger instances to use new class names
… in response helper - Replace `ht_api` and `ht_shared` imports with `core` package - Update `request_id` import path
- Update import paths to use core package and local paths - Replace HtHttpException with HttpException for broader error handling - Update error mapping and logging to use new exception types - Remove unused imports and adjust package references
- Replace references to `HtDataRepository` with `DataRepository` - Clarify the role of `modelRegistry` in data endpoint support
…ions - Replace 'package:ht_api/src/rbac/...' with 'package:flutter_news_app_api_server_full_source_code/src/rbac/...' - Replace 'package:ht_shared/ht_shared.dart' with 'package:core/core.dart' - Update relative imports to use full package name - Standardize on 'core' package for shared dependencies
- Replace `ht_data_client` with `data_client` package - Replace `flutter_news_app_api_server_full_source_code` with `core` package - Update class names and references accordingly
- Rename 'ht_api' to 'flutter_news_app_api_server_full_source_code' - Update import paths for core, data_repository, and email_repository packages - Replace HtHttpException with HttpException - Update class and method references according to new package name
- Replace `ht_data_repository` with `data_repository` - Replace `ht_email_repository` with `email_repository` - Update package paths for `flutter_news_app_api_server_full_source_code` - Replace `HtDataRepository` with `DataRepository` - Replace `HtEmailRepository` with `EmailRepository`
- Change import path from 'ht_api' to 'flutter_news_app_api_server_full_source_code' - This update ensures consistency in import paths across the project
- Update import paths to use core package instead of ht_shared - Replace HtHttpException with HttpException - Consolidate import statements and remove duplicates
- Replace `ht_data_repository` with `data_repository` package - Update import paths for `flutter_news_app_api_server_full_source_code` package - Rename `HtDataRepository` to `DataRepository` - Replace `HtHttpException` with `HttpException`
- Move core package from dev_dependencies to dependencies - Adjust dotenv package location in dependencies - Reorganize dependencies for better structure and clarity
- Restructure README for better flow and readability - Enhance with visual elements and branding - Refine capability descriptions for clarity - Update license information and sponsorship details - Improve setup instructions and environment configuration
- Updated the name "flutter news app full source code toolkit" to "Flutter News App Toolkit" for consistency - Removed unnecessary bold formatting in the README introduction
- Replace generic description with a more detailed explanation - Highlight key features: authentication, data management, user settings - Mention Dart Frog as the technology used for implementation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @fulleni, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request represents a significant refactoring effort focused on renaming the core package and its private dependencies. The primary goal is to align the project's branding and internal structure with the new 'Flutter News App Toolkit' ecosystem. This involves a comprehensive search-and-replace operation across the codebase, ensuring all references to the old naming conventions are updated to the new, more descriptive names.
Highlights
- Project Renaming: The entire project has been rebranded from 'Headlines Toolkit' (ht_api) to 'Flutter News App Toolkit' (flutter_news_app_api_server_full_source_code). This includes updates to the project name, description, and repository URLs in
pubspec.yamlandREADME.md. - Dependency Renaming & Restructuring: All internal/private Dart dependencies, previously prefixed with
ht_(e.g.,ht_data_client,ht_shared), have been renamed to remove this prefix (e.g.,data_client,core). Their corresponding Git repository URLs have also been updated to reflect the new organization structure. - Codebase Adaptation: The codebase has been thoroughly updated to reflect these naming changes. This includes modifying all import statements, updating type annotations (e.g.,
HtDataRepositorytoDataRepository,HtEmailRepositorytoEmailRepository), and standardizing exception types fromHtHttpExceptiontoHttpException. - Configuration Alignment: The
.env.examplefile now uses the new database name, and thedependabot.yamlconfiguration has been updated to correctly ignore the newly named private dependencies. Thevery_good_analysisdev dependency has also been upgraded.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request refactors the project by renaming the package and updating private dependencies. It involves changes in the .env.example, .github/dependabot.yaml, README.md, lib/src/config/app_dependencies.dart, lib/src/helpers/response_helper.dart, lib/src/middlewares/, lib/src/providers/, lib/src/rbac/, lib/src/registry/model_registry.dart, lib/src/services/, routes/*, and pubspec.yaml files. The review comments suggest standardizing badge styles in README.md and using HttpException consistently throughout the codebase.
|
|
||
|  | ||
| [](https://pub.dev/packages/very_good_analysis) | ||
| [](https://polyformproject.org/licenses/free-trial/1.0.0) | ||
| # Flutter News App - API Server Full Source Code | ||
|
|
||
| 🚀 Accelerate the development of your news application backend with **ht_api**, the | ||
| dedicated API service for the Headlines Toolkit. Built on the high-performance | ||
| Dart Frog framework, `ht_api` provides the essential server-side infrastructure | ||
| specifically designed to power robust and feature-rich news applications. | ||
| <p> | ||
| <img src="https://img.shields.io/badge/coverage-XX-green?style=for-the-badge" alt="coverage: percentage"> | ||
| <a href="https://github.com/sponsors/flutter-news-app-full-source-code"><img src="https://img.shields.io/badge/DOCS-READ-purple?style=for-the-badge" alt="DOCS READ"></a> | ||
| <a href="https://github.com/sponsors/flutter-news-app-full-source-code"><img src="https://img.shields.io/badge/LICENSE-BUY-pink?style=for-the-badge" alt="License: Buy"></a> | ||
| </p> |
There was a problem hiding this comment.
Consider using a consistent style for badges. The original README used shields.io badges, while the updated version uses a mix of shields.io and for-the-badge styles. Standardizing on one style would improve visual consistency.
Status
READY/IN DEVELOPMENT/HOLD
Description
Type of Change