Releases: SMAKSS/password-generator
Upgrade dependencies
Add bulk password option and change the way of getting characters
Also, update the readme, description, and keywords accordingly.
Full Changelog: v2.0.0...v3.0.0-beta.0
Introduce bulk mode and few optimisations
Release Notes for Password Generator - Version 3.0.0
🌟 Overview
We are excited to announce the release of version 3.0.0 of the Password Generator package. This update introduces enhanced usability, new features, and improved naming conventions for better clarity and consistency.
🚀 What's New
- String Input for Custom Characters: The
characters
option now accepts a string instead of an array, simplifying the way users can input custom characters for password generation. - Bulk Password Generation: Introducing the
numberOfPasswords
parameter, allowing users to generate multiple passwords at once. This feature is perfect for creating a set of passwords in one go. - Improved Parameter Names: Updated parameter names for enhanced clarity:
- Renamed
lowerIncluded
,capsIncluded
,numIncluded
, andspecIncluded
toincludeLower
,includeCaps
,includeNums
, andincludeSpecs
respectively, aligning the naming convention.
- Renamed
📝 Migration Guide
To upgrade to the new version, please consider the following changes:
- Update the
characters
parameter to pass a string instead of an array. - Utilize the
numberOfPasswords
parameter for generating multiple passwords. - Adjust your function calls to align with the new parameter names if you were using the older ones.
🔍 Examples of Usage
Generate a Single Password
const password = PasswordGenerator({ length: 10, includeNums: true });
console.log(password); // Outputs a 10-character password with numbers
Generate Multiple Passwords
const passwords = PasswordGenerator({ numberOfPasswords: 5 });
console.log(passwords); // Outputs an array of 5 random passwords
Using Custom Characters
const password = PasswordGenerator({ length: 10, characters: 'abc123' });
console.log(password); // Outputs a password using only 'abc123'
Trying to fix npm dist files
v2.0.0-beta.1 chore(core): trying to fix npm dist files
Migrate to typescript
v2.0.0-beta.0 feat(core): migrate code to typescript
Add typescript and update docs
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. 🧪
chore: fix workflow and add CodeSandbox to readme
v1.1.4 chore: fix workflow and add CodeSandbox to readme