Unify JavaScript Files to TypeScript, Update tsconfig.json, and Add VS Code Debugger Support

[danfercf1]

Summary

I would like to propose a feature that unifies all JavaScript (.js) files in the project into TypeScript (.ts). This proposal also includes updating the tsconfig.json configuration to output build files into a dedicated folder and adding support for the Visual Studio Code (VS Code) debugger. These changes will enhance code quality, project organization, and developer experience.

Motivation

• Type Safety: Migrating to TypeScript will improve code reliability by adding type safety, helping to catch errors during development rather than at runtime.
• Consistency: Having the entire codebase in TypeScript will make it more maintainable and easier for new contributors to understand and contribute.
• Organized Build Output: By configuring the tsconfig.json file to compile TypeScript files into a dedicated output directory (e.g., ./dist), we can keep our project structure clean and organized.
• Enhanced Developer Experience: Integrating VS Code debugger support will make it easier to debug TypeScript code directly within the IDE, improving the overall development workflow.

Suggested changes

1. Convert All .js Files to .ts: Identify all existing JavaScript files and migrate them to TypeScript. This includes adding appropriate type annotations and ensuring each file is fully functional. Test the converted files to ensure there are no regressions.
2. Update tsconfig.json:
   • Modify the tsconfig.json file to include the following:
     • OutDir: Set outDir to output compiled files into a dedicated folder such as ./dist.
     • RootDir: Set rootDir to the src directory to maintain a clear separation between source and output files.
3. Add VS Code Debugger Support:
   • Create or update the .vscode/launch.json configuration file to support debugging TypeScript files within VS Code.
4. Update Documentation:
   • Update the project’s documentation to reflect these changes, including any new instructions for running the build process, debugging, or contributing with TypeScript.

Implementation Details

• Phased Migration: The conversion from JavaScript to TypeScript should be done incrementally to avoid disrupting the project. Each module can be converted individually and tested before moving on to the next.

• Testing: Ensure that all tests pass after each conversion, and update or add tests as necessary for the TypeScript files.

• Debugger Verification: After configuring the VS Code debugger, verify that breakpoints and step-through debugging work correctly with the compiled TypeScript code.

Potential Impact

• Positive Impact:

  • Improved code quality and safety due to TypeScript’s static typing.
  • Cleaner project structure with separated build artifacts.
  • More efficient debugging within VS Code.

• Negative Impact:

  • Initial time investment required for migrating files and updating configurations.

Next Steps

• Discussion and Approval: I invite the maintainers and contributors to discuss this proposal and provide feedback.
• Branch Creation: Once approved, a dedicated branch can be created for the migration to keep the changes isolated.
• Implementation: Begin the migration of .js to .ts, update tsconfig.json, and add VS Code debugger support.
• Testing and Documentation: Ensure everything works correctly and update documentation as needed.
• Merge: After successful testing, merge the changes into the main branch.