Skip to content

Add typescript and update docs

Compare
Choose a tag to compare
@SMAKSS SMAKSS released this 03 Nov 23:37
· 5 commits to main since this release
6ed41d6

Release Notes for @smakss/password-generator v2.0.0 πŸš€

We're excited to roll out the latest version of the @smakss/password-generator package! πŸŽ‰

This release includes enhancements and bug fixes that solidify the library's functionality and streamline the user experience. Here's what's new:

Features ✨

  • TypeScript Refactor: The entire codebase has been migrated to TypeScript, offering improved type safety and developer experience. πŸ› οΈ
  • Simplified API: We've simplified the password generation function, making it even easier to use with fewer lines of code. πŸ“
  • Random Length Option: Passwords now have a default random length between 1 and 20 when the length parameter isn't specified, adding an extra layer of Randomness! πŸ”€

Bug Fixes πŸ›

  • Prettier Integration: Resolved conflicts between ESLint and Prettier, ensuring a smoother development process and cleaner code formatting. βœ…
  • DX Tool Glitch: Fixed an issue where the developer experience tools incorrectly added a trailing comma, leading to linting errors. πŸ› οΈ

Documentation πŸ“š

  • Updated README: The documentation has been thoroughly updated to reflect the recent migration to TypeScript and API changes. πŸ“„
  • Enhanced Examples: We've added new examples to showcase the usage of the library with its current feature set. πŸ“

General 🌐

  • Code Clean-up: We've gone through the internals with a fine-tooth comb to remove any redundant code, resulting in a leaner package. 🧹
  • Improved Randomness: Enhanced the random generator function to ensure even more unpredictable and secure passwords. 🎲

As always, we recommend testing the new version in your development environment before deploying it to production. πŸ§ͺ