{"id":22514716,"url":"https://github.com/cityssm/simple-password-generator","last_synced_at":"2025-08-03T16:31:12.115Z","repository":{"id":37791684,"uuid":"283571275","full_name":"cityssm/simple-password-generator","owner":"cityssm","description":"Makes generating simple or complex, appropriate passwords a breeze.","archived":false,"fork":false,"pushed_at":"2023-03-03T20:57:23.000Z","size":456,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-08T11:55:59.930Z","etag":null,"topics":["generator","hacktoberfest","password","password-generator","safe","security","unleet","zxcvbn"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@cityssm/simple-password-generator","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cityssm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-29T18:17:24.000Z","updated_at":"2023-01-31T18:26:09.000Z","dependencies_parsed_at":"2024-06-21T19:13:50.936Z","dependency_job_id":null,"html_url":"https://github.com/cityssm/simple-password-generator","commit_stats":{"total_commits":74,"total_committers":5,"mean_commits":14.8,"dds":"0.20270270270270274","last_synced_commit":"cfc4fc39902b00e1043d184f262cb9481912f66e"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fsimple-password-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fsimple-password-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fsimple-password-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fsimple-password-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cityssm","download_url":"https://codeload.github.com/cityssm/simple-password-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228553670,"owners_count":17936022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","hacktoberfest","password","password-generator","safe","security","unleet","zxcvbn"],"created_at":"2024-12-07T03:20:50.994Z","updated_at":"2024-12-07T03:20:51.674Z","avatar_url":"https://github.com/cityssm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-password-generator\n\n[![npm](https://img.shields.io/npm/v/@cityssm/simple-password-generator)](https://www.npmjs.com/package/@cityssm/simple-password-generator)\n[![Codacy Badge](https://img.shields.io/codacy/grade/af55a93d353f4881ad2fdee1c582e495)](https://app.codacy.com/gh/cityssm/simple-password-generator)\n[![Maintainability](https://img.shields.io/codeclimate/maintainability/cityssm/simple-password-generator)](https://codeclimate.com/github/cityssm/simple-password-generator/maintainability)\n[![Test Coverage](https://img.shields.io/codeclimate/coverage/cityssm/simple-password-generator)](https://codeclimate.com/github/cityssm/simple-password-generator/test_coverage)\n[![AppVeyor](https://img.shields.io/appveyor/build/dangowans/simple-password-generator)](https://ci.appveyor.com/project/dangowans/simple-password-generator)\n[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/simple-password-generator)](https://app.snyk.io/org/cityssm/project/6f305273-35f2-4834-93e3-14c13a413055)\n\nMakes generating simple or complex, _appropriate_ passwords a breeze.\n\n-   Passwords can have a minimum or maximum length.\n\n-   Passwords can include words, letters, numbers, and symbols.\n\n-   Passwords are scanned with [zxcvbn-typescript](https://github.com/trichards57/zxcvbn)\n    to reduce their guessability.\n\n-   Passwords are translated with [unleet](https://github.com/cityssm/unleet),\n    and scanned using [badwords](https://github.com/MauriceButler/badwords) to\n    make sure they are appropriate.\n\n## Installation\n\n```bash\nnpm install @cityssm/simple-password-generator\n```\n\n## Usage\n\n```javascript\nimport { generatePassword } from \"@cityssm/simple-password-generator\";\n\ngeneratePassword();\n= \"carPoetDRIVING%38\"\n\ngeneratePassword({ minLength: 15, pattern: \"wnWnX\" });\n= \"curious6COMPOSITION7B\"\n\ngeneratePassword({ pattern: 'xxxXXXnnns', doShufflePattern: true });\n= \"c0O4WG@od9\"\n```\n\n### Options\n\n| Option           | Description                                                                                             | Default  |\n| ---------------- | ------------------------------------------------------------------------------------------------------- | -------- |\n| minLength        | The minimum password length.                                                                            | `8`      |\n| maxLength        | The maximum password length.                                                                            | `50`     |\n| pattern          | The format the password should use.                                                                     | `\"wCnn\"` |\n| doShufflePattern | Whether the pattern should be ordered randomly or not.                                                  | `false`  |\n| minScore         | The minimum allowable zxcvbn guessability score, where 0 is \"too guessable\" and 4 is \"very unguessable\" | `2`      |\n| retries          | The number of times the generator should try to generate a password before failing and returning null.  | `20`     |\n\nNote that if your `pattern` cannot generate a password\nwithin your set `minLength` and `maxLength`,\nthe `generatePassword()` function may return a `null` value.\n\n### Pattern Options\n\n| Pattern Character | Description       | Example |\n| ----------------- | ----------------- | ------- |\n| w                 | Lower case word   | word    |\n| W                 | Upper case word   | WORD    |\n| C                 | Capitalized word  | Word    |\n| x                 | Lower case letter | a       |\n| X                 | Upper case letter | A       |\n| n                 | Number            | 9       |\n| s                 | Symbol            | @       |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fsimple-password-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcityssm%2Fsimple-password-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fsimple-password-generator/lists"}