refactor: Reorganize utilities into 'utils' directory and separate concerns

[mitsuki31]

Overview

This pull request refactors the utility modules to enhance code organization, readability, and maintainability. The changes involve moving and separating utility functions into specific files within a new utils directory, updating import paths, and adjusting relevant code to align with these structural changes.

Changes Made

• Move utility modules to utils directory:

  • Relocated the utility files into a new utils directory to improve code organization.
    • utils.js was moved to utils/index.js.
    • url-utils.js was moved to utils/url-utils.js.
    • yt-urlfmt.js was moved to utils/yt-urlfmt.js.

• Separate type and logger utilities:

  • Introduced new utility modules for cleaner separation of concerns:
    • Created utils/type-utils.js to house type checking and utility functions.
    • Created utils/logger.js to manage logging functionalities.
  • Renamed the logger object to Logger while keeping the old name (logger) as an alias for backward compatibility.
  • Added circular references within the Logger object:
    • log as an alias for Logger.
    • logger retained as a backward compatibility reference.

• Correct import path for utils module:

  • Updated all references and import paths across the codebase to align with the new structure of the utils directory.

• Update @module tag description in documentation:

  • Refined and updated the @module JSDoc tags in affected files to reflect the new paths and module structure accurately.

• Correct the ROOTDIR path in utils module:

  • Adjusted the ROOTDIR constant to ensure it correctly points to the project’s root directory after the module reorganization.

• Correct import paths in test files:

  • Updated the test suites to use the correct import paths for the refactored utils module, ensuring all tests reference the new directory structure.

Impact

• Enhances code organization by clearly separating utility functions into dedicated modules.
• Improves maintainability and readability of the codebase.
• Maintains backward compatibility with the legacy logger naming convention to avoid breaking changes.
• Corrects all necessary paths in production and test code to reflect the updated structure.

Summary

This refactoring effort significantly improves the project’s structure by organizing utility functions into a utils directory. The changes maintain backward compatibility where necessary, correct paths across the codebase, and update documentation to align with the new structure, resulting in a more maintainable and readable codebase.