express-typescript
express-typescript copied to clipboard
Remove the dev Dependencies awesome-type-loader
PR Details
Description
This PR focuses on removing the unused awesome-type-loader
from the project.
Related Issue
This PR addresses the following issue: Dependency Conflict typescript@"5.0.3" & awesome-typescript-loader@"^5.2.0"
Motivation and Context
When a user attempts to install the dependencies, the following error occurs, hindering the successful setup of the project:
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/typescript
npm ERR! dev typescript@"5.0.3" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer typescript@"^2.7 || ^3" from [email protected]
npm ERR! node_modules/awesome-typescript-loader
npm ERR! dev awesome-typescript-loader@"^5.2.0" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR!
npm ERR! For a full report see:
npm ERR! /Users/smt/.npm/_logs/2023-09-23T20_57_50_849Z-eresolve-report.txt
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/smt/.npm/_logs/2023-09-23T20_57_50_849Z-debug-0.log
This error holds particular significance as awesome-type-loader
is neither actively used in the project nor maintained by the author, having been archived. Removing this loader will resolve the dependency conflict, thereby enhancing the project's stability and maintainability.
Why is this change required?
- The dependency
awesome-type-loader
is causing conflicts and is not being used in the project. - The loader has been archived and is not maintained anymore, representing a potential security risk.
What problem does it solve?
- Resolves the dependency conflict error during installation.
- Removes an unused and unmaintained package, reducing potential security vulnerabilities.
How Has This Been Tested
Since there are no tests present in this project currently, traditional testing methods were not applicable. However, to validate the change, I ran the project within a Docker container and tested a few APIs using Insomnia, ensuring the removal of awesome-type-loader
did not introduce any regressions or adversely affect the functionality.
Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [x] Bug fix (non-breaking change which fixes an issue)
Checklist
- [x] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [x] I have read the CONTRIBUTING document.
- [ ] I have added tests to cover my changes.
- [x] All new and existing tests passed.