generate-pw 1.4.5 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -19
- package/dist/cli.min.js +14 -9
- package/dist/generate-pw.min.js +6 -1
- package/docs/README.md +21 -19
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
### Randomly generate, strengthen, and validate cryptographically-secure passwords.
|
|
20
20
|
|
|
21
21
|
<a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-orange.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
22
|
-
<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.
|
|
22
|
+
<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.5.0"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.5.0-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
23
23
|
<a href="https://www.npmjs.com/package/generate-pw?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/generate-pw?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue"></a>
|
|
24
|
-
<a href="https://github.com/adamlui/js-utils/blob/generate-pw-1.
|
|
24
|
+
<a href="https://github.com/adamlui/js-utils/blob/generate-pw-1.5.0/generate-pw/dist/generate-pw.min.js"><img height=31 src="https://img.shields.io/github/size/adamlui/js-utils/generate-pw/dist/generate-pw.min.js?branch=generate-pw-1.5.0&label=Minified%20Size&logo=databricks&logoColor=white&labelColor=464646&color=ff69b4&style=for-the-badge"></a>
|
|
25
25
|
<a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:generate-pw/src/generate-pw.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Agenerate-pw%2Fsrc%2Fgenerate-pw.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
|
|
26
26
|
<a href="https://github.com/toolleeo/cli-apps#password-managers"><img height=31 src="https://img.shields.io/badge/Mentioned_in-Awesome-c4a2bd?logo=awesomelists&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
27
27
|
|
|
@@ -81,14 +81,14 @@ const pw = require('generate-pw');
|
|
|
81
81
|
#### <> HTML script tag:
|
|
82
82
|
|
|
83
83
|
```html
|
|
84
|
-
<script src="https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
84
|
+
<script src="https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js"></script>
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
#### ES6:
|
|
88
88
|
|
|
89
89
|
```js
|
|
90
90
|
(async () => {
|
|
91
|
-
await import('https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
91
|
+
await import('https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js');
|
|
92
92
|
// Your code here...
|
|
93
93
|
})();
|
|
94
94
|
```
|
|
@@ -97,7 +97,7 @@ const pw = require('generate-pw');
|
|
|
97
97
|
|
|
98
98
|
```js
|
|
99
99
|
...
|
|
100
|
-
// @require https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
100
|
+
// @require https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js
|
|
101
101
|
// ==/UserScript==
|
|
102
102
|
|
|
103
103
|
// Your code here...
|
|
@@ -105,7 +105,7 @@ const pw = require('generate-pw');
|
|
|
105
105
|
|
|
106
106
|
<br>
|
|
107
107
|
|
|
108
|
-
**💡 Note:** To always import the latest version (not recommended in production!) remove the `@1.
|
|
108
|
+
**💡 Note:** To always import the latest version (not recommended in production!) remove the `@1.5.0` version tag from the jsDelivr URL: `https://cdn.jsdelivr.net/npm/generate-pw/dist/generate-pw.min.js`
|
|
109
109
|
|
|
110
110
|
<br>
|
|
111
111
|
|
|
@@ -228,18 +228,19 @@ Name | Type | Description | Default Value
|
|
|
228
228
|
|
|
229
229
|
Any of these can be passed into the options object for each `generate*()` function:
|
|
230
230
|
|
|
231
|
-
Name
|
|
232
|
-
|
|
233
|
-
`verbose`
|
|
234
|
-
`length`
|
|
235
|
-
`qty`*
|
|
236
|
-
`charset`
|
|
237
|
-
`exclude`
|
|
238
|
-
`numbers`
|
|
239
|
-
`symbols`
|
|
240
|
-
`lowercase`
|
|
241
|
-
`uppercase`
|
|
242
|
-
`strict`
|
|
231
|
+
Name | Type | Description | Default Value
|
|
232
|
+
----------------------|---------|--------------------------------------------------------------------------------|---------------
|
|
233
|
+
`verbose` | Boolean | Show logging in console/terminal. | `true`
|
|
234
|
+
`length` | Integer | Length of password(s). | `8`
|
|
235
|
+
`qty`* | Integer | Number of passwords to generate. | `1`
|
|
236
|
+
`charset` | String | Characters to include in password(s). | `''`
|
|
237
|
+
`exclude` | String | Characters to exclude from password(s). | `''`
|
|
238
|
+
`numbers` | Boolean | Allow numbers in password(s). | `false`
|
|
239
|
+
`symbols` | Boolean | Allow symbols in password(s). | `false`
|
|
240
|
+
`lowercase` | Boolean | Allow lowercase letters in password(s). | `true`
|
|
241
|
+
`uppercase` | Boolean | Allow uppercase letters in password(s). | `true`
|
|
242
|
+
`strict` | Boolean | Require at least one character from each allowed character set in password(s). | `false`
|
|
243
|
+
`excludeSimilarChars` | Boolean | Exclude similar characters (e.g. o,0,O,i,l,1,|) in password(s). | `false`
|
|
243
244
|
|
|
244
245
|
##### _*Only available in [`generatePassword([options])`](#generatepasswordoptions) since [`generatePasswords(qty[, options])`](#generatepasswordsqty-options) takes a `qty` argument_
|
|
245
246
|
|
|
@@ -270,9 +271,10 @@ Parameter options:
|
|
|
270
271
|
|
|
271
272
|
Boolean options:
|
|
272
273
|
-n, --include-numbers Allow numbers in password(s).
|
|
273
|
-
-
|
|
274
|
+
-y, --include-symbols Allow symbols in password(s).
|
|
274
275
|
-L, --no-lowercase Disallow lowercase letters in password(s).
|
|
275
276
|
-U, --no-uppercase Disallow uppercase letters in password(s).
|
|
277
|
+
-S, --no-similar Exclude similar characters in password(s).
|
|
276
278
|
-s, --strict Require at least one character from each
|
|
277
279
|
allowed character set in password(s).
|
|
278
280
|
-q, --quiet Suppress all logging except errors.
|
package/dist/cli.min.js
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
${
|
|
9
|
-
${
|
|
10
|
-
|
|
2
|
+
/**
|
|
3
|
+
* © 2024 Adam Lui & contributors under the MIT license.
|
|
4
|
+
* Source: https://github.js-utils.com/tree/main/generate-pw/src
|
|
5
|
+
* Documentation: https://github.js-utils.com/tree/main/generate-pw/docs
|
|
6
|
+
*/
|
|
7
|
+
const pkgName="generate-pw",docURL="https://github.com/adamlui/js-utils/tree/main/generate-pw#-command-line-usage",generatePassword=require(__dirname.match(/src/)?"./generate-pw":"./generate-pw.min")["generatePassword"],fs=require("fs"),path=require("path"),execSync=require("child_process")["execSync"],nc="[0m",br="[1;91m",by="[1;33m",config={},argRegex={paramOptions:{length:/^--?length(?:=.*|$)/,qty:/^--?qu?a?n?ti?t?y(?:=.*|$)/,charset:/^--?chars(?:=.*|$)/,excludeChars:/^--?exclude(?:=.*|$)/},flags:{includeNums:/^--?(?:n|(?:include-?)?num(?:ber)?s?=?(?:true|1)?)$/,includeSymbols:/^--?(?:y|(?:include-?)?symbols?=?(?:true|1)?)$/,excludeLowerChars:/^--?(?:L|(?:exclude|disable|no)-?lower-?(?:case)?|lower-?(?:case)?=(?:false|0))$/,excludeUpperChars:/^--?(?:U|(?:exclude|disable|no)-?upper-?(?:case)?|upper-?(?:case)?=(?:false|0))$/,excludeSimilarChars:/^--?(?:S|(?:exclude|disable|no)-?similar-?(?:char(?:acter)?s?)?|similar-?(?:char(?:acter)?s?)?=(?:false|0))$/,strictMode:/^--?s(?:trict)?(?:-?mode)?$/,quietMode:/^--?q(?:uiet)?(?:-?mode)?$/},infoCmds:{help:/^--?h(?:elp)?$/,version:/^--?ve?r?s?i?o?n?$/}};if(process.argv.forEach(s=>{var e,r,o;s.startsWith("-")&&(e=Object.keys(argRegex.paramOptions).find(e=>argRegex.paramOptions[e].test(s)),o=Object.keys(argRegex.flags).find(e=>argRegex.flags[e].test(s)),r=Object.keys(argRegex.infoCmds).find(e=>argRegex.infoCmds[e].test(s)),o?config[o]=!0:e?(s.includes("=")||(console.error(`
|
|
8
|
+
${br}ERROR: Arg [--${s.replace(/-/g,"")}] requires '=' followed by a value.`+nc),printHelpCmdAndDocURL(),process.exit(1)),o=s.split("=")[1],config[e]=parseInt(o)||o):r||(console.error(`
|
|
9
|
+
${br}ERROR: Arg [${s}] not recognized.`+nc),console.info(`
|
|
10
|
+
${by}Valid arguments are below.`+nc),printHelpSections(["paramOptions","flags","infoCmds"]),printHelpCmdAndDocURL(),process.exit(1)))}),console.log(config.excludeSimilarChars),process.exit(),process.argv.some(e=>argRegex.infoCmds.help.test(e)))printHelpSections();else if(process.argv.some(e=>argRegex.infoCmds.version.test(e))){const k=execSync(`npm view ${pkgName} version`).toString().trim()||"none";let e,s=process.cwd();for(;"/"!=s;){const n=path.join(s,"package.json");if(fs.existsSync(n)){const o=require(n);e=(o.dependencies?.[pkgName]||o.devDependencies?.[pkgName])?.match(/(\d+\.\d+\.\d+)/)[0]||"none";break}s=path.dirname(s)}console.info(`
|
|
11
|
+
Global version: `+k),console.info("Local version: "+e)}else{for(const r of["length","qty"])config[r]&&(isNaN(config[r])||config[r]<1)&&(console.error(`
|
|
12
|
+
${br}Error: [${r}] argument can only be > 0.`+nc),printHelpCmdAndDocURL(),process.exit(1));const p={length:config.length||8,qty:config.qty||1,charset:config.charset,exclude:config.excludeChars,numbers:!!config.includeNums,symbols:!!config.includeSymbols,lowercase:!config.excludeLowerChars,uppercase:!config.excludeUpperChars,strict:!!config.strictMode,verbose:!config.quietMode},q=generatePassword(p);config.quietMode||console.info("\nCopying to clipboard..."),copyToClipboard(Array.isArray(q)?q.join("\n"):q)}function printHelpSections(e=["cmdFormat","paramOptions","flags","infoCmds"]){const s={cmdFormat:[`
|
|
13
|
+
${by}generate-pw [options|commands]`+nc],paramOptions:["\nParameter options:"," --length=n Generate password(s) of n length."," --qty=n Generate n password(s)."," --charset=chars Only include chars in password(s)."," --exclude=chars Exclude chars from password(s)."],flags:["\nBoolean options:"," -n, --include-numbers Allow numbers in password(s)."," -y, --include-symbols Allow symbols in password(s)."," -L, --no-lowercase Disallow lowercase letters in password(s)."," -U, --no-uppercase Disallow uppercase letters in password(s)."," -s, --strict Require at least one character from each allowed character set in password(s)."," -S, --no-similar Exclude similar characters in password(s)."," -q, --quiet Suppress all logging except errors."],infoCmds:["\nInfo commands:"," -h, --help Display help screen."," -v, --version Show version number."]};e.forEach(e=>{s[e]?.forEach(e=>{{const o=process.stdout.columns||80,n=[],s=e.match(/\S+|\s+/g);let r="";s.forEach(e=>{var s=o-(0==n.length?0:29);r.length+e.length>s&&(n.push(0==n.length?r:r.trimStart()),r=""),r+=e}),n.push(0==n.length?r:r.trimStart()),n.forEach((e,s)=>console.info(0==s?e:" ".repeat(29)+e))}})})}function printHelpCmdAndDocURL(){console.info(`
|
|
14
|
+
${by}For more help, type 'generate-pw --help' or visit
|
|
15
|
+
`+(docURL+nc))}function copyToClipboard(e){e=e.replace(/\s+$/m,"").replace(/"/g,'""'),"darwin"==process.platform?execSync(`printf "${e}" | pbcopy`):"linux"==process.platform?execSync(`printf "${e}" | xclip -selection clipboard`):"win32"==process.platform&&execSync(`Set-Clipboard -Value "${e}"`,{shell:"powershell"})}
|
package/dist/generate-pw.min.js
CHANGED
|
@@ -1 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* © 2024 Adam Lui & contributors under the MIT license.
|
|
3
|
+
* Source: https://github.js-utils.com/tree/main/generate-pw/src
|
|
4
|
+
* Documentation: https://github.js-utils.com/tree/main/generate-pw/docs
|
|
5
|
+
*/
|
|
6
|
+
let randomInt;try{({randomInt}=require("crypto"))}catch(e){const b=window.crypto||window.msCrypto;randomInt=(e,r)=>{var s=b?.getRandomValues(new Uint32Array(1))[0]/4294967295||Math.random();return Math.floor(s*(r-e))+e}}const charsets={lower:"abcdefghijklmnopqrstuvwxyz",upper:"ABCDEFGHIJKLMNOPQRSTUVWXYZ",numbers:"0123456789",symbols:"!@#$%^&*()-_=+[]{}/\\|;:'\",.<>?"};function generatePassword(t={}){var e={verbose:!0,length:8,qty:1,charset:"",exclude:"",numbers:!1,symbols:!1,lowercase:!0,uppercase:!0,excludeSimilarChars:!1,strict:!1};if(validateOptions(t,e,"https://github.com/adamlui/js-utils/tree/main/generate-pw#generatepasswordoptions","generatePassword({ verbose: false, numbers: true })")){if(1<(t={...e,...t}).qty){const{qty:r,...s}=t;return generatePasswords(r,s)}{var o,e="generatePasswords"==generatePassword.caller?.name;t.verbose&&!e&&console.info("generatePassword() » Initializing character set...");let r=t.charset||(t.numbers?charsets.numbers:"")+(t.symbols?charsets.symbols:"")+(t.lowercase?charsets.lower:"")+(t.uppercase?charsets.upper:""),s=(""==r&&(r=charsets.lower+charsets.upper),t.exclude&&(t.verbose&&!e&&console.info("generatePassword() » Removing excluded characters..."),r=r.replace(new RegExp(`[${t.exclude}]`,"g"),"")),t.excludeSimilarChars&&(t.verbose&&!e&&console.info("generatePassword() » Excluding similar characters..."),r=r.replace(/[o0Oil1|]/g,"")),t.verbose&&!e&&console.info("generatePassword() » Generating password..."),"");for(let e=0;e<t.length;e++){var n=randomInt(0,r.length);s+=r.charAt(n)}return t.strict&&(t.verbose&&!e&&console.info("generatePassword() » Enforcing strict mode..."),o=["number","symbol","lower","upper"].filter(e=>t[e+"s"]||t[e+"case"]),s=strictify(s,o)),t.verbose&&!e&&(console.info("generatePassword() » Password generated!"),"undefined"!=typeof require&&/cli(?:\.min)?\.js$/.test(require.main.filename)||console.info("generatePassword() » Check returned string.")),s}}}function generatePasswords(r,s={}){var e="https://github.com/adamlui/js-utils/tree/main/generate-pw#generatepasswordsqty-options",t={verbose:!0,length:8,charset:"",exclude:"",numbers:!1,symbols:!1,lowercase:!0,uppercase:!0,excludeSimilarChars:!1,strict:!1};if(r=parseInt(r,10),isNaN(r)||r<1)console.error("generatePasswords() » ERROR: 1st arg <qty> can only be an integer > 0."),console.info("generatePasswords() » For more help, please visit "+e);else if(validateOptions(s,t,e,"generatePasswords(3, { verbose: false, symbols: true })")){(s={...t,...s}).verbose&&console.info(`generatePasswords() » Generating password${1<r?"s":""}...`);var o=[];for(let e=0;e<r;e++)o.push(generatePassword(s));return s.verbose&&console.info(`generatePasswords() » Password${1<r?"s":""} generated!`),"undefined"!=typeof require&&/cli(?:\.min)?\.js$/.test(require.main.filename)||console.info("generatePasswords() » Check returned array."),o}}function strictify(t,o=["number","symbol","lower","upper"],e={}){var r="https://github.com/adamlui/js-utils/tree/main/generate-pw#strictifypassword-requiredchartypes-options",n={verbose:!0};if("string"!=typeof t)console.error("strictify() » ERROR: 1st arg <password> must be a string."),console.info("strictify() » For more help, please visit "+r);else{var s=["number","symbol","lower","upper"];for(const d of o=Array.isArray(o)?o:[o])if(!s.includes(d))return console.error(`strictify() » ERROR: 2nd arg \`${d}\` is an invalid character type.`),console.info(`strictify() » Valid character types: [ ${s.map(e=>`'${e}'`).join(", ")} ]`),console.info("strictify() » Pass one as a string or more as an array, or all types will be required."),void console.info("strictify() » For more help, please visit "+r);if(validateOptions(e,n,r,"strictify('pa55word', ['symbol', 'upper'], { verbose: false })")){e={...n,...e};var a={};for(const p of o)a["has"+p.charAt(0).toUpperCase()+p.slice(1)]=!1;for(let e=0;e<t.length;e++)for(const f of o)(charsets[f]||charsets[f+"s"]).includes(t.charAt(e))&&(a["has"+f.charAt(0).toUpperCase()+f.slice(1)]=!0);e.verbose&&console.info("strictify() » Strictifying password...");var i=Math.min(t.length,o.length),l=[];let r=0,s=t;for(const u of o)if(r<i&&!a["has"+u.charAt(0).toUpperCase()+u.slice(1)]){let e;for(;e=randomInt(0,t.length),l.includes(e););l.push(e);var c=charsets[u]||charsets[u+"s"];s=s.substring(0,e)+c.charAt(randomInt(0,c.length))+s.substring(e+1),r++}return e.verbose&&(0<r?(console.info("strictify() » Password is now strict!"),console.info("strictify() » Check returned string.")):(console.info(`strictify() » Password already includes ${o.join(" + ")} characters!`),console.info("strictify() » No modifications made."))),s}}}function validateStrength(r,s={}){var e="https://github.com/adamlui/js-utils/tree/main/generate-pw#validatestrengthpassword-options",t={minLength:8,minLower:1,minUpper:1,minNumber:1,minSymbol:1},o={verbose:!0};if("string"!=typeof r)console.error("validateStrength() » ERROR: 1st arg <password> must be a string."),console.info("validateStrength() » For more help, please visit "+e);else if(validateOptions(s,o,e,"validateStrength('pa55word', { verbose: false })")){(s={...o,...s}).verbose&&console.info("validateStrength() » Validating password strength...");var n={lower:0,upper:0,number:0,symbol:0};for(const i of r)for(const l of Object.keys(n))(charsets[l]||charsets[l+"s"]).includes(i)&&n[l]++;var a=[];r.length<t.minLength&&a.push(`Make it at least ${t.minLength} characters long.`);for(const c of Object.keys(n))n[c]<t["min"+c.charAt(0).toUpperCase()+c.slice(1)]&&a.push("Include at least one "+c+`${["upper","lower"].includes(c)?"case letter":""}.`);let e=0;e+=r.length>=t.minLength?20:0;for(const d of Object.keys(n))e+=n[d]>=t["min"+d.charAt(0).toUpperCase()+d.slice(1)]?20:0;return s.verbose&&(console.info("validateStrength() » Password strength validated!"),console.info("validateStrength() » Check returned object for score/recommendations.")),{strengthScore:e,recommendations:a,isGood:80<=e}}}function validateOptions(e,r,s,t){const o=JSON.stringify(r,null,2).replace(/"([^"]+)":/g,"$1:").replace(/"/g,"'").replace(/\n\s*/g," "),n=Object.keys(r).join(", "),a=Object.keys(r).filter(e=>"boolean"==typeof r[e]),i=Object.keys(r).filter(e=>Number.isInteger(r[e])),l=(validateOptions.caller?.name||"validateOptions")+"() » ";var c=()=>{console.info(l+`Valid options: [ ${n} ]`),console.info(l+"If omitted, default settings are: "+o)},d=()=>{console.info(l+"For more help, please visit "+s)};if("object"!=typeof e)return console.error(l+"ERROR: [options] can only be an object of key/values."),console.info(l+"Example valid call: "+t),c(),d(),!1;for(const p in e){if(!Object.prototype.hasOwnProperty.call(r,p))return console.error(l+`ERROR: \`${p}\` is an invalid option.`),c(),d(),!1;if(a.includes(p)&&"boolean"!=typeof e[p])return console.error(l+`ERROR: [${p}] option can only be \`true\` or \`false\`.`),d(),!1;if(i.includes(p)&&(e[p]=parseInt(e[p],10),isNaN(e[p])||e[p]<1))return console.error(l+`ERROR: [${p}] option can only be an integer > 0.`),d(),!1}return!0}const apiFunctions={generatePassword:generatePassword,generatePasswords:generatePasswords,strictify:strictify,validateStrength:validateStrength};try{module.exports={...apiFunctions}}catch(e){}try{window.pw={...apiFunctions}}catch(e){}
|
package/docs/README.md
CHANGED
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
### Randomly generate, strengthen, and validate cryptographically-secure passwords.
|
|
20
20
|
|
|
21
21
|
<a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-orange.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
22
|
-
<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.
|
|
22
|
+
<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.5.0"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.5.0-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
23
23
|
<a href="https://www.npmjs.com/package/generate-pw?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/generate-pw?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue"></a>
|
|
24
|
-
<a href="https://github.com/adamlui/js-utils/blob/generate-pw-1.
|
|
24
|
+
<a href="https://github.com/adamlui/js-utils/blob/generate-pw-1.5.0/generate-pw/dist/generate-pw.min.js"><img height=31 src="https://img.shields.io/github/size/adamlui/js-utils/generate-pw/dist/generate-pw.min.js?branch=generate-pw-1.5.0&label=Minified%20Size&logo=databricks&logoColor=white&labelColor=464646&color=ff69b4&style=for-the-badge"></a>
|
|
25
25
|
<a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:generate-pw/src/generate-pw.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Agenerate-pw%2Fsrc%2Fgenerate-pw.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
|
|
26
26
|
<a href="https://github.com/toolleeo/cli-apps#password-managers"><img height=31 src="https://img.shields.io/badge/Mentioned_in-Awesome-c4a2bd?logo=awesomelists&logoColor=white&labelColor=464646&style=for-the-badge"></a>
|
|
27
27
|
|
|
@@ -81,14 +81,14 @@ const pw = require('generate-pw');
|
|
|
81
81
|
#### <> HTML script tag:
|
|
82
82
|
|
|
83
83
|
```html
|
|
84
|
-
<script src="https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
84
|
+
<script src="https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js"></script>
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
#### ES6:
|
|
88
88
|
|
|
89
89
|
```js
|
|
90
90
|
(async () => {
|
|
91
|
-
await import('https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
91
|
+
await import('https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js');
|
|
92
92
|
// Your code here...
|
|
93
93
|
})();
|
|
94
94
|
```
|
|
@@ -97,7 +97,7 @@ const pw = require('generate-pw');
|
|
|
97
97
|
|
|
98
98
|
```js
|
|
99
99
|
...
|
|
100
|
-
// @require https://cdn.jsdelivr.net/npm/generate-pw@1.
|
|
100
|
+
// @require https://cdn.jsdelivr.net/npm/generate-pw@1.5.0/dist/generate-pw.min.js
|
|
101
101
|
// ==/UserScript==
|
|
102
102
|
|
|
103
103
|
// Your code here...
|
|
@@ -105,7 +105,7 @@ const pw = require('generate-pw');
|
|
|
105
105
|
|
|
106
106
|
<br>
|
|
107
107
|
|
|
108
|
-
**💡 Note:** To always import the latest version (not recommended in production!) remove the `@1.
|
|
108
|
+
**💡 Note:** To always import the latest version (not recommended in production!) remove the `@1.5.0` version tag from the jsDelivr URL: `https://cdn.jsdelivr.net/npm/generate-pw/dist/generate-pw.min.js`
|
|
109
109
|
|
|
110
110
|
<br>
|
|
111
111
|
|
|
@@ -228,18 +228,19 @@ Name | Type | Description | Default Value
|
|
|
228
228
|
|
|
229
229
|
Any of these can be passed into the options object for each `generate*()` function:
|
|
230
230
|
|
|
231
|
-
Name
|
|
232
|
-
|
|
233
|
-
`verbose`
|
|
234
|
-
`length`
|
|
235
|
-
`qty`*
|
|
236
|
-
`charset`
|
|
237
|
-
`exclude`
|
|
238
|
-
`numbers`
|
|
239
|
-
`symbols`
|
|
240
|
-
`lowercase`
|
|
241
|
-
`uppercase`
|
|
242
|
-
`strict`
|
|
231
|
+
Name | Type | Description | Default Value
|
|
232
|
+
----------------------|---------|--------------------------------------------------------------------------------|---------------
|
|
233
|
+
`verbose` | Boolean | Show logging in console/terminal. | `true`
|
|
234
|
+
`length` | Integer | Length of password(s). | `8`
|
|
235
|
+
`qty`* | Integer | Number of passwords to generate. | `1`
|
|
236
|
+
`charset` | String | Characters to include in password(s). | `''`
|
|
237
|
+
`exclude` | String | Characters to exclude from password(s). | `''`
|
|
238
|
+
`numbers` | Boolean | Allow numbers in password(s). | `false`
|
|
239
|
+
`symbols` | Boolean | Allow symbols in password(s). | `false`
|
|
240
|
+
`lowercase` | Boolean | Allow lowercase letters in password(s). | `true`
|
|
241
|
+
`uppercase` | Boolean | Allow uppercase letters in password(s). | `true`
|
|
242
|
+
`strict` | Boolean | Require at least one character from each allowed character set in password(s). | `false`
|
|
243
|
+
`excludeSimilarChars` | Boolean | Exclude similar characters (e.g. o,0,O,i,l,1,|) in password(s). | `false`
|
|
243
244
|
|
|
244
245
|
##### _*Only available in [`generatePassword([options])`](#generatepasswordoptions) since [`generatePasswords(qty[, options])`](#generatepasswordsqty-options) takes a `qty` argument_
|
|
245
246
|
|
|
@@ -270,9 +271,10 @@ Parameter options:
|
|
|
270
271
|
|
|
271
272
|
Boolean options:
|
|
272
273
|
-n, --include-numbers Allow numbers in password(s).
|
|
273
|
-
-
|
|
274
|
+
-y, --include-symbols Allow symbols in password(s).
|
|
274
275
|
-L, --no-lowercase Disallow lowercase letters in password(s).
|
|
275
276
|
-U, --no-uppercase Disallow uppercase letters in password(s).
|
|
277
|
+
-S, --no-similar Exclude similar characters in password(s).
|
|
276
278
|
-s, --strict Require at least one character from each
|
|
277
279
|
allowed character set in password(s).
|
|
278
280
|
-q, --quiet Suppress all logging except errors.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "generate-pw",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"description": "Randomly generate, strengthen, and validate cryptographically-secure passwords.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Adam Lui",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
},
|
|
26
26
|
"scripts": {
|
|
27
27
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
28
|
-
"build": "
|
|
28
|
+
"build": "bash utils/build.sh",
|
|
29
29
|
"bump:patch": "bash utils/bump.sh patch",
|
|
30
30
|
"bump:minor": "bash utils/bump.sh minor",
|
|
31
31
|
"bump:major": "bash utils/bump.sh major",
|
|
@@ -53,6 +53,6 @@
|
|
|
53
53
|
"url": "https://github.com/sponsors/adamlui"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
|
-
"@adamlui/minify.js": "^1.5.
|
|
56
|
+
"@adamlui/minify.js": "^1.5.3"
|
|
57
57
|
}
|
|
58
58
|
}
|