Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Codebase to Use Modules and Implement JSDocs for Basic Types #102

Open
PushpenderSaini0 opened this issue Feb 13, 2024 · 4 comments
Labels
code-quality Refactoring and other clean up tasks. help wanted Extra attention is needed

Comments

@PushpenderSaini0
Copy link
Collaborator

The current JS codebase relies on script tags, leading to global scope pollution. I recommend refactoring to ES6 modules for better organization and encapsulation. Additionally, adding JSDocs for basic types can enhance code documentation.

@PushpenderSaini0
Copy link
Collaborator Author

@acenturyandabit If you have any suggestions, please feel free to share.

@acenturyandabit
Copy link
Owner

Sure, let's do that. I'm happy to move to modules as they seem reasonably well supported. However I don't want to add node.js as it would make it harder to get started on the project.

@PushpenderSaini0
Copy link
Collaborator Author

JSDoc doesn't need Node.js and serves as a great alternative to TypeScript.
It enhances code documentation without introducing the complexities associated with TypeScript.
I am avoiding TypeScript for the same reason (to keep this project beginner friendly).

JSDocs are optional comments above functions, providing a way to document code by specifying the function's parameters, return types, and other relevant details.
Check here : https://jsdoc.app/about-getting-started

@PushpenderSaini0
Copy link
Collaborator Author

I'll initiate the development of a plan outlining the steps for transitioning to modules. Let's discuss the plan here before proceeding with the coding phase!

I will share it here soon !

@PushpenderSaini0 PushpenderSaini0 added the help wanted Extra attention is needed label Feb 19, 2024
@PushpenderSaini0 PushpenderSaini0 added the code-quality Refactoring and other clean up tasks. label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-quality Refactoring and other clean up tasks. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants