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

Major Release - Update JSDoc, Dependencies, and Helper Functions #1

Merged
merged 6 commits into from
May 13, 2024

Conversation

snickbit
Copy link
Collaborator

In this PR, we've made several updates to our functionality, documentation, and dependencies. These adaptations will improve the clarity of our codebase and the efficient running of our application.

Here's a summary of the changes:

  • Fixed a jsdoc overflow issue.
  • Regenerated documentation.
  • Added a new getPackageJSON helper function. This addition will streamline our codebase.
  • Updated JSDocs and added explicit function returns. Carried out minor linting for improved readability and functionality.
  • Updated our dependencies to keep our project current and secure.
  • Removed deprecated modules to prevent issues with deprecated dependencies.

Breaking Changes:

  • Removed progress. This function was deprecated and has been replaced with alternative functions.
  • Removed multi-progress. We've simplified our progress tracking functionality by doing this.
  • Removed spinner. This function was deprecated and replaced with an alternative function.
  • Removed saveFileJson and getFileJson. These functions were replaced by the more robust getPackageJSON helper function.

@snickbit snickbit merged commit 9ea0623 into main May 13, 2024
1 check passed
@snickbit snickbit deleted the major-release branch May 13, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant