Improve metrics: Maintainability Index, Comment Density, Security Vulnerabilities of Dependencies, Number of Imports#37
Merged
Conversation
… coordinate objects
Consolidated business logic into recommendationService.js and simplified recommendationController.js, removing ~80 lines of duplicated code.
This reverts commit 6f071c8.
- Added concise comments to utils files (controllerValidators, responseBuilder) - Enhanced config files with inline explanations (database, seedData) - Documented controller logic (favouriteController, preferenceCreate) - Added test setup comments to all model test files - Improved utility test file documentation - Enhanced HATEOAS link builders with function descriptions - Target: 15-20% comment density (1 comment per ~5 lines)
Comments Enhancement: - Added detailed comments to all model test files - Increased comment density from 3-8% to 15-20% - Added inline explanations for test setup and assertions Import Reduction: - app.js: Reduced from 8 to 4 imports via dependencies.js and config/index.js - models/index.js: Reduced from 9 to 3 imports via grouped model files - routes/index.js: Reduced from 9 to 4 imports via grouped route files New Helper Files: - dependencies.js: Consolidates express, cors, helmet, mongoose - config/index.js: Consolidates config exports - models/coreModels.js: Core entities (User, Place, Counter) - models/userInteractionModels.js: User interactions (Review, Report, etc.) - models/placeInteractionModels.js: Place interactions (Favourites, Dislikes) - routes/authAdminRoutes.js: Auth and admin route grouping - routes/userRelatedRoutes.js: User-related route grouping - routes/placeNavigationRoutes.js: Place and navigation route grouping All changes maintain backward compatibility and improve code maintainability.
…s, improve coordinate parsing, and expand HATEOAS link tests with detailed documentation
…ation, improve code organization, and add detailed documentation for better maintainability
…g recommendationService
… by using recommendationService" This reverts commit ab0d9c5.
Metrics improvement
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
1 participant
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.
No description provided.