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 Updates and Configuration Adjustments #3

Merged
merged 16 commits into from
Sep 14, 2024
Merged

Conversation

loveakinlesi
Copy link
Owner

Summary:
This MR encompasses significant updates across several aspects of the project, including the GitHub Actions workflows, the TypeScript configuration, the js-randomize library, and the project's documentation. Key changes include the introduction of a new class-based API for js-randomize, updates to GitHub Actions workflows, and revisions to the README and changelog.

Changes:

  1. js-randomize Library:

    • Breaking Changes:

      • API Changes: The library functions have been refactored into a Randomize class with updated method names and enhanced functionality. The new methods include integer(), float(), intArray(), floatArray(), boolean(), pick(), sample(), shuffle(), and string().
      • Error Handling: Improved error handling with more precise error messages.
      • Method Updates:
        • int()integer()
        • array()sample()
      • Additional Features: Added pick() and string() methods for more versatile functionality.
    • TypeScript Integration: Enhanced TypeScript support with type definitions for better development experience.

  2. GitHub Actions Workflow:

    • Testing Workflow Updates:

      • pnpm Integration: Added setup for pnpm for consistency in dependency management.
      • Updated Steps: Switched from npm to pnpm for installation and build steps.
    • Publish Workflow Updates:

      • Integration with pnpm: Adjusted the publish workflow to use pnpm for installing dependencies and building the project.
  3. Documentation:

    • README:

      • Breaking Changes Warning: Added a prominent section at the top of the README to inform users of breaking changes introduced in version 2.0.0.
    • Changelog:

      • Version 2.0.0: Documented breaking changes, new features, and improvements in the changelog for version 2.0.0 of js-randomize.

Impact:

  • Functionality: The updated js-randomize library provides a more robust and feature-rich API. The class-based approach and new methods enhance flexibility and usability.
  • Documentation: Improved README and changelog ensure users are aware of breaking changes and how to adapt to the new version.

Note:

  • Ensure to update any project dependencies and configurations to align with the new js-randomize version and workflow changes.

@loveakinlesi loveakinlesi self-assigned this Sep 14, 2024
@loveakinlesi loveakinlesi merged commit f99ee4e into main Sep 14, 2024
4 checks passed
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