generate-pw 2.1.2 → 2.3.0

package/README.md

@@ -21,16 +21,14 @@
 
 ### Randomly generate, strengthen, and validate cryptographically-secure passwords.
 
-<a href="https://www.npmjs.com/package/generate-pw">
+<a href="https://npmstar.com/compare/generate-pw">
     <img height=31 src="https://img.shields.io/npm/dm/generate-pw?logo=npm&color=af68ff&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <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>
-<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-2.1.2">
-    <img height=31 src="https://img.shields.io/badge/Latest_Build-2.1.2-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-2.3.0">
+    <img height=31 src="https://img.shields.io/badge/Latest_Build-2.3.0-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <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>
-<a href="https://github.com/adamlui/js-utils/blob/generate-pw-2.1.2/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-2.1.2&label=Minified%20Size&logo=databricks&logoColor=white&labelColor=464646&color=ff69b4&style=for-the-badge"></a>
 <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>
 <a href="https://github.com/toolleeo/cli-apps#password-managers">
@@ -94,14 +92,14 @@ const pw = require('generate-pw')
 #### <> HTML script tag:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/generate-pw@2.1.2/dist/generate-pw.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/generate-pw@2.3.0/dist/generate-pw.min.js"></script>
 ```
 
 #### ES6:
 
 ```js
 (async () => {
-    await import('https://cdn.jsdelivr.net/npm/generate-pw@2.1.2/dist/generate-pw.min.js')
+    await import('https://cdn.jsdelivr.net/npm/generate-pw@2.3.0/dist/generate-pw.min.js')
     // Your code here...
 })()
 ```
@@ -110,7 +108,7 @@ const pw = require('generate-pw')
 
 ```js
 ...
-// @require https://cdn.jsdelivr.net/npm/generate-pw@2.1.2/dist/generate-pw.min.js
+// @require https://cdn.jsdelivr.net/npm/generate-pw@2.3.0/dist/generate-pw.min.js
 // ==/UserScript==
 
 // Your code here...
@@ -118,7 +116,7 @@ const pw = require('generate-pw')
 
 <br>
 
-**💡 Note:** To always import the latest version (not recommended in production!) remove the `@2.1.2` version tag from the jsDelivr URL: `https://cdn.jsdelivr.net/npm/generate-pw/dist/generate-pw.min.js`
+**💡 Note:** To always import the latest version (not recommended in production!) remove the `@2.3.0` version tag from the jsDelivr URL: `https://cdn.jsdelivr.net/npm/generate-pw/dist/generate-pw.min.js`
 
 <br>
 
@@ -255,7 +253,7 @@ Name                  | Type    | Description
 `uppercase`           | Boolean | Allow uppercase letters in password(s).                                        | `true`
 `similarChars`        | Boolean | Include similar characters (e.g. o,0,O,i,l,1,\|) in password(s).               | `false`
 `strict`              | Boolean | Require at least one character from each allowed character set in password(s). | `true`
-`entropy`             | Boolean | Calculate/log estimated entropy.                                               | `false`
+`entropy`             | Boolean | Calculate/log estimated entropy.                                               | `true`
 
 ##### _*Only available in [`generatePassword([options])`](#generatepasswordoptions) since [`generatePasswords(qty[, options])`](#generatepasswordsqty-options) takes a `qty` argument_
 
@@ -265,13 +263,13 @@ Name                  | Type    | Description
 
 ## 💻 Command line usage
 
-When installed [globally](#-installation), **generate-pw** can also be used from the command line. The basic command is:
+**generate-pw** can also be used directly from the command line. The basic command is:
 
 ```
 $ generate-pw
 ```
 
-<img src="https://media.generatepw.org/images/screenshots/cli/generate-pw-cmd-output.png?0d36e26">
+<img src="https://cdn.jsdelivr.net/gh/adamlui/js-utils@0d3424a/generate-pw/assets/images/screenshots/cli/generate-pw-cmd-output.png">
 
 #
 
@@ -297,13 +295,15 @@ Boolean options:
  -S, --similar-chars         Include similar characters in password(s).
  -S, --unstrict              Don't require at least one character from
                              each allowed character set in password(s).
- -e, --entropy               Calculate/log estimated entropy.
+ -E, --no-entropy            Don't calculate/log estimated entropy.
  -q, --quiet                 Suppress all logging except errors.
 
 Commands:
  -i, --init                  Create config file (in project root).
  -h, --help                  Display help screen.
  -v, --version               Show version number.
+     --stats                 Show npm stats.
+     --debug [targetKey]     Show debug logs.
 ```
 
 #
@@ -327,7 +327,7 @@ export default {
     excludeUpperChars: false,   // disallow uppercase letters in password(s)
     similarChars: false,        // include similar chars in password(s)
     unstrict: false,            // don't require 1+ char from each allowed charset in password(s)
-    entropy: false,             // calculate/log estimated entropy
+    noEntropy: false,           // don't calculate/log estimated entropy
     quietMode: false            // suppress all logging except errors
 }
 ```
@@ -354,7 +354,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ## 🛠️ Related utilities
 
-### <picture><source media="(prefers-color-scheme: dark)" srcset="https://media.generate-ip.org/images/icons/node-graph/white/icon55x49.png?b4eb06e"><img height=21 src="https://media.generate-ip.org/images/icons/node-graph/black/icon55x49.png?b4eb06e"></picture> [generate-ip](https://js-utils.org/generate-ip) &nbsp;<a href="https://github.com/toolleeo/cli-apps#networking"><img height=18 src="https://assets.js-utils.org/images/badges/awesome/badge.svg?v=0d36e26"></a>
+### <picture><source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/adamlui/js-utils@5c34563/generate-ip/assets/images/icons/node-graph/white/icon55x49.png"><img height=21 src="https://cdn.jsdelivr.net/gh/adamlui/js-utils@5c34563/generate-ip/assets/images/icons/node-graph/black/icon55x49.png"></picture> [generate-ip](https://js-utils.org/generate-ip) &nbsp;<a href="https://github.com/toolleeo/cli-apps#networking"><img height=18 src="https://assets.js-utils.org/images/badges/awesome/badge.svg?v=0d36e26"></a>
 
 > Randomly generate, format, and validate IPv4 + IPv6 + MAC addresses.
 <br>[Install](https://docs.generate-ip.org/#-installation) /
@@ -363,7 +363,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 [CLI usage](https://docs.generate-ip.org/#-command-line-usage) /
 [Discuss](https://github.com/adamlui/js-utils/discussions)
 
-### <picture><source media="(prefers-color-scheme: dark)" srcset="https://media.geolocatejs.org/images/icons/wire-globe/white/icon32.png?0d36e26"><img height=22 src="https://media.geolocatejs.org/images/icons/wire-globe/black/icon32.png?0d36e26"></picture> [geolocate](https://js-utils.org/geolocate) &nbsp;<a href="https://github.com/toolleeo/cli-apps#networking"><img height=18 src="https://assets.js-utils.org/images/badges/awesome/badge.svg?v=0d36e26"></a>
+### <picture><source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/adamlui/js-utils@0d3424a/geolocate/assets/images/icons/wire-globe/white/icon32.png"><img height=22 src="https://cdn.jsdelivr.net/gh/adamlui/js-utils@0d3424a/geolocate/assets/images/icons/wire-globe/black/icon32.png"></picture> [geolocate](https://js-utils.org/geolocate) &nbsp;<a href="https://github.com/toolleeo/cli-apps#networking"><img height=18 src="https://assets.js-utils.org/images/badges/awesome/badge.svg?v=0d36e26"></a>
 
 > Fetch IP geolocation data from the CLI.
 <br>[Install](https://docs.geolocatejs.org/#-installation) /

package/dist/cli/index.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+(async () => {
+    'use strict'
+
+    // Init ENV
+    const init = require('./lib/init')
+    init.env()
+
+    // Import LIBS
+    globalThis.log = require('./lib/log')
+    const clipboardy = require('node-clipboardy'),
+        { generatePassword } = require(`../generate-pw${ env.modes.dev ? '' : '.min' }.js`)
+
+    await init.cli()
+
+    // Exec CMD arg if passed
+    if (cli.config.init) return init.configFile()
+    else if (cli.config.help) return log.help()
+    else if (cli.config.version) return log.version()
+    else if (cli.config.stats) return log.stats()
+
+    // Copy random PASSWORD(s)
+    const genOptions = {
+        length: cli.config.length,
+        qty: cli.config.qty,
+        strength: cli.config.mode || cli.config.strength,
+        charset: cli.config.charset,
+        exclude: cli.config.excludeChars,
+        numbers: !cli.config.excludeNums,
+        symbols: !cli.config.excludeSymbols,
+        lowercase: !cli.config.excludeLowerChars,
+        uppercase: !cli.config.excludeUpperChars,
+        similarChars: cli.config.similarChars,
+        strict: !cli.config.unstrict,
+        entropy: !cli.config.noEntropy,
+        verbose: !cli.config.quietMode
+    }
+    log.break()
+    clipboardy.writeSync([].concat(generatePassword(genOptions)).join('\n'))
+    log.ifNotQuiet(`${cli.msgs.info_copyingToClip}...`)
+
+})()

package/dist/cli/lib/color.js

@@ -0,0 +1,31 @@
+const color = module.exports = {
+    nc: '\x1b[0m',
+    hex: {
+        br: '#ff0000',  by: '#ffff00',  bo: '#ffa500',   bg: '#00ff00',
+        bw: '#ffffff', gry: '#808080', blk: '#000000', tlBG: '#008080'
+    },
+    schemes: {
+        get default() {
+            return [
+                '#00e5bc', '#18c8ae', '#30ac9f', '#488f91', '#607383',
+                '#775674', '#8f3966', '#a71d57', '#bf0049', '#9a1b5e'
+            ].map(color.hexToANSI)
+        },
+        get rainbow() {
+            return [
+                '#e41a1c', '#ff7f00', '#ffff33', '#4daf4a', '#377eb8',
+                '#984ea3', '#f781bf', '#999999', '#a65628', '#d95f02'
+            ].map(color.hexToANSI)
+        }
+    },
+
+    hexToANSI(hex) {
+        const r = parseInt(hex.slice(1,3), 16),
+              g = parseInt(hex.slice(3,5), 16),
+              b = parseInt(hex.slice(5,7), 16)
+        return `\x1b[38;2;${r};${g};${b}m`
+    }
+}
+
+for (const hexKey of Object.keys(color.hex)) // add color[hexKey] getters that return ANSI
+    Object.defineProperty(color, hexKey, { get: () => color.hexToANSI(color.hex[hexKey]) })

package/dist/cli/lib/data.js

@@ -0,0 +1,30 @@
+module.exports = {
+
+    atomicWrite(filePath, data, encoding = 'utf8') { // to prevent TOCTOU
+        const fs = require('fs'),
+              path = require('path'),
+              tmpPath = path.join(path.dirname(filePath), `.${path.basename(filePath)}.tmp`)
+        fs.writeFileSync(tmpPath, data, encoding) ; fs.renameSync(tmpPath, filePath)
+    },
+
+    fetch(url) { // to support Node.js < v21
+        return typeof fetch == 'undefined' ? new Promise((resolve, reject) => { // using https?.get()
+            const protocol = url.match(/^([^:]+):\/\//)[1]
+            if (!/^https?$/.test(protocol))
+                reject(new Error(`${cli.msgs.error_invalidURL}.`))
+            require(protocol).get(url, resp => {
+                let rawData = ''
+                resp.on('data', chunk => rawData += chunk)
+                resp.on('end', () => resolve({ json: () => JSON.parse(rawData), text: () => rawData }))
+            }).on('error', reject)
+        }) : fetch(url) // using Node.js fetch()
+    },
+
+    flatten(json, { key = 'message' } = {}) { // eliminate need to ref nested keys
+        const flatObj = {}
+        for (const jsonKey in json) flatObj[jsonKey] =
+            typeof json[jsonKey] == 'object' && key in json[jsonKey] ? json[jsonKey][key]
+                                                                     : json[jsonKey]
+        return flatObj
+    }
+}

package/dist/cli/lib/init.js

@@ -0,0 +1,57 @@
+const language = require('./language'),
+      settings = require('./settings')
+
+module.exports = {
+
+    async cli() {
+        Object.assign(globalThis.cli ??= {}, require(`${env.paths.libData}/package-data.json`))
+        cli.msgs = await language.getMsgs('en')
+        cli.msgs = await language.getMsgs(cli.lang = settings.load('uiLang') || (
+            env.modes.debug ? language.generateRandomLang({ excludes: ['en'] }) : language.getSysLang() ))
+        cli.urls.cliDocs = `${cli.urls.docs}/#-command-line-usage`
+        if (!cli.lang.startsWith('en')) { // localize cli.urls.cliDocs
+            cli.docLocale = cli.lang.replace('_', '-').toLowerCase()
+            cli.docLocales ??= await language.getDocLocales()
+            if (cli.docLocales?.includes(cli.docLocale))
+                log.debug(cli.urls.cliDocs = `${cli.urls.docs}/${cli.docLocale}#readme`)
+        }
+        settings.load() // all keys to cli.config
+    },
+
+    async configFile(filename = settings.configFilename) {
+        const fs = require('fs'),
+              path = require('path'),
+              paths = { target: path.resolve(process.cwd(), filename) }
+
+        if (fs.existsSync(paths.target)) // use existing config file
+            return log.warn(`${cli.msgs.warn_configFileExists}:`, paths.target)
+        if (fs.existsSync(paths.src = path.resolve(__dirname, `${env.paths.libData}/${filename}`)))
+            fs.copyFileSync(paths.src, paths.target) // use found template
+
+        else { // use jsDelivr copy
+            const jsdURL = `${require('./jsdelivr').getPkgVerURL()}/${filename}`
+            log.data(`${cli.msgs.info_fetchingRemoteConfigFrom} ${jsdURL}...`)
+            try {
+                const data = require('./data'),
+                      resp = await data.fetch(jsdURL)
+                if (resp.ok) data.atomicWrite(paths.target, await resp.text())
+                else return log.warn(`${cli.msgs.warn_remoteConfigNotFound}: ${jsdURL} (${resp.status})`)
+            } catch (err) {
+                return log.warn(`${cli.msgs.warn_remoteConfigFailed}: ${jsdURL} ${err.message}`) }
+        }
+
+        log.success(`${cli.msgs.info_configFileCreated}: ${paths.target}\n`)
+        log.tip(`${cli.msgs.tip_editToSetDefaults}.`)
+        log.tip(`${cli.msgs.tip_cliArgsPrioritized}.`)
+    },
+
+    env() {
+        Object.assign(globalThis.env ??= {}, {
+            args: process.argv.slice(2),
+            modes: { dev: /[\\/]src(?:[\\/]|$)/i.test(__dirname) },
+            supports: { unicode: require('is-unicode-supported').default() }
+        })
+        env.modes.debug = env.args.some(arg => /^--?(?:V|debug(?:[-_]?mode)?)$/.test(arg))
+        env.paths = { libData: `../../${ env.modes.dev ? '..' : 'data' }` }
+    }
+}

package/dist/cli/lib/jsdelivr.js

@@ -0,0 +1,10 @@
+module.exports = {
+
+    getPkgVerURL(version) {
+        version ||= cli.version ||= require('./pkg').getVer('local') || 'none'
+        const verTag = !/^\d+\.\d+\.\d+$/.test(version) ? 'latest' : `${cli.name}-${version}`
+        return `${cli.urls.jsdelivr}@${verTag}/${cli.name}`
+    },
+
+    getCommitURL(hash = 'latest') { return `${cli.urls.jsdelivr}@${hash}/${cli.name}` }
+}

package/dist/cli/lib/language.js

@@ -0,0 +1,113 @@
+const data = require('./data')
+
+module.exports = {
+
+    formatCode(langCode) { // to match locale dir name
+        return langCode.replace(
+            /([a-z]{2,8})[-_]([a-z]{2})/i, (_, lang, region) =>`${lang.toLowerCase()}_${region.toUpperCase()}`) },
+
+    async getDocLocales() {
+        cli.version ||= require('./pkg').getVer('local') || 'none'
+        const jsdURL = `${require('./jsdelivr').getPkgVerURL()}/docs/`,
+              locales = []
+        try {
+            const respText = await (await data.fetch(jsdURL)).text(),
+                  reLocale = /href=".*\/docs\/([^/]+)\/"/g
+            let match ; while ((match = reLocale.exec(respText))) locales.push(match[1]) // store locale dir names
+        } catch (err) {
+            log.warn(`${cli.msgs.warn_docLocalesFetchFailed}:`, err.message)
+        }
+        return locales
+    },
+
+    generateRandomLang({ includes = [], excludes = [] } = {}) {
+        const fs = require('fs'),
+              path = require('path')
+
+        let locales = includes.length ? includes : (() => {
+
+            // Read cache if found
+            const cacheDir = path.join(__dirname, '../../.cache'),
+                  localeCache = path.join(cacheDir, 'locales.json')
+            if (fs.existsSync(localeCache))
+                try { return JSON.parse(fs.readFileSync(localeCache, 'utf8')) } catch (err) {}
+
+            // Discover pkg _locales
+            const localesDir = path.resolve(__dirname, '../../../_locales')
+            if (!fs.existsSync(localesDir)) return ['en']
+            const locales = fs.readdirSync(localesDir, { withFileTypes: true })
+                .filter(entry => entry.isDirectory()).map(entry => entry.name)
+                .filter(name => /^\w{2}[-_]?\w{0,2}$/.test(name))
+
+            // Cache result
+            fs.mkdirSync(cacheDir, { recursive: true })
+            data.atomicWrite(localeCache, JSON.stringify(locales, null, 2))
+
+            return locales
+        })()
+
+        // Filter out excludes
+        const excludeSet = new Set(excludes)
+        locales = locales.filter(locale => !excludeSet.has(locale))
+
+        // Get random language
+        const randomLang = locales.length ? locales[Math.floor(Math.random() * locales.length)] : 'en'
+        log.debug(`Random language: ${randomLang}`)
+
+        return randomLang
+    },
+
+    async getMsgs(langCode = 'en') {
+        langCode = module.exports.formatCode(langCode)
+        if (env.msgs && langCode == cli.lang) return env.msgs // don't re-fetch same msgs
+
+        let msgs = data.flatten( // local ones
+            require(`../../${ env.modes.dev ? '../_locales/en' : 'data' }/messages.json`))
+
+        if (!langCode.startsWith('en')) { // fetch non-English msgs from jsDelivr
+            try { // check if terminal supports non-Latin scripts
+                const nonLatinLocales = await (await data.fetch(
+                    `${cli.urls.jsdelivr}@${cli.commitHashes.data}/assets/data/non-latin-locales.json`
+                )).json()
+                if (nonLatinLocales.includes(langCode.split('-')[0]) && !env.supports.unicode)
+                    return msgs // en ones
+            } catch (err) {
+                log.debug(`Failed to fetch non-Latin locales: ${err}`)
+            }
+            const msgBaseURL = `${require('./jsdelivr').getCommitURL(cli.commitHashes.locales)}/_locales`
+            let msgURL = `${msgBaseURL}/${langCode}/messages.json`, msgFetchesTried = 0
+            while (msgFetchesTried < 3)
+                try { // fetch remote msgs
+                    msgs = data.flatten(await (await data.fetch(msgURL)).json())
+                    break
+                } catch (err) { // retry up to 2X (region-stripped + EN)
+                    msgFetchesTried++ ; if (msgFetchesTried >= 3) break
+                    log.debug(msgURL = langCode.includes('-') && msgFetchesTried == 1 ?
+                        msgURL.replace(/([^_]*)_[^/]*(\/.*)/, '$1$2') // strip region before retrying
+                            : `${msgBaseURL}/en/messages.json` // else use EN msgs
+                    )
+                }
+        }
+
+        return msgs
+    },
+
+    getSysLang() {
+        try {
+            if (process.platform == 'win32')
+                return require('child_process').execSync(
+                    '(Get-Culture).TwoLetterISOLanguageName', { shell: 'powershell', encoding: 'utf-8' }
+                ).trim()
+            else { // macOS/Linux
+                const pe = process.env
+                return (pe.LANG || pe.LANGUAGE || pe.LC_ALL || pe.LC_MESSAGES || pe.LC_NAME)
+                    .split('.')[0] // strip encoding e.g. .UTF-8
+            }
+        } catch (err) {
+            log.error(`${cli.msgs.error_failedToFetchSysLang}:`, err.message)
+            return 'en'
+        }
+    },
+
+    validateLangCode(code) { return typeof code != 'string' ? false : /^[a-z]{2,8}(?:[-_][a-z]{2,3})?$/i.test(code) }
+}

package/dist/cli/lib/log.js

@@ -0,0 +1,171 @@
+const colors = require('./color'),
+    { getDownloads, getVer } = require('./pkg'),
+      settings = require('./settings'),
+      string = require('./string')
+
+const nextMajVer = require('../../../package.json').version.replace(/^(\d+)\..*/, (_, major) => `${ +major +1 }.0.0`)
+
+module.exports = {
+    colors,
+
+    break() { console.log() },
+    configURL() { this.info(`${cli.msgs.info_exampleValidConfigFile}: ${cli.urls.config}`) },
+    configURLandExit(...args) { this.error(...args); this.configURL(); process.exit(1) },
+    data(msg) { console.log(`\n${colors.bw}${msg}${colors.nc}`) },
+    dim(msg) { console.log(`${colors.gry}${msg}${colors.nc}`) },
+    error(...args) { console.error(`\n${colors.br}ERROR:`, ...args, colors.nc) },
+    errorAndExit(...args) { this.error(...args); this.helpDocsCmdsDocsURL(); process.exit(1) },
+    ifNotQuiet(msg) { if (!cli.config.quietMode) this.info(msg) },
+    info(msg) { console.info(`\n${colors.schemes.default[0]}${msg}${colors.nc}`) },
+    success(msg) { console.log(`\n${colors.bg}${msg}${colors.nc}`) },
+    tip(msg) { console.info(`${colors.by}TIP: ${msg}${colors.nc}`) },
+    warn(...args) { console.warn(`\n${colors.bo}WARNING:`, ...args, colors.nc) },
+
+    argDoesNothing(arg) {
+        this.warn(`${cli.msgs.warn_option} ${arg} ${cli.msgs.warn_noLongerHasAnyEffect} ${
+                     cli.msgs.warn_andWillBeRemoved} @ v${nextMajVer}`)
+    },
+
+    configKeyReplacedBy(oldKey, newKey, oldVal) {
+        if (!this[`${oldKey}Warned`]) {
+            this.warn(
+                `${cli.msgs.info_configFile} ${cli.msgs.warn_option.toLowerCase()} '${oldKey}: ${oldVal}' ${
+                   cli.msgs.warn_hasBeenReplacedBy} '${
+                       newKey}: ${ settings.isNegKey(oldKey) != settings.isNegKey(newKey) ? !oldVal : oldVal }' ${
+                   cli.msgs.warn_andWillBeRemoved} @ v${nextMajVer}`
+            )
+            this[`${oldKey}Warned`] = true
+        }
+    },
+
+    debug(msg) {
+        if (!env.modes.debug) return
+        this.argIdx ??= env.args.findIndex(arg => /^--?(?:V|debug(?:[-_]?mode)?)$/.test(arg))
+        if (this.argIdx +1 < env.args.length && !env.args[this.argIdx +1].startsWith('-')) // use --debug [targetKey]
+            this.key ??= env.args[this.argIdx +1].replace('-', '_')
+        if (this.key)
+            this.val = cli.config[this.key] || `cli.config key "${this.key}" ${cli.msgs.warn_notFound.toLowerCase()}`
+        else
+            this.val = cli.config
+        msg += `\n${colors.gry}${JSON.stringify(this.val)}${colors.nc}`
+        console.debug(`\n${colors.by}DEBUG:`, msg, colors.nc)
+    },
+
+    help(includeSections = ['header', 'usage', 'params', 'flags', 'cmds']) {
+        cli.prefix = `${this.colors.tlBG}${this.colors.blk}\x1b[30m ${cli.name} ${this.colors.nc} `
+        const helpSections = {
+            header: [
+                `\n├ ${cli.prefix}${cli.msgs.pkg_copyright}.`,
+                `${cli.prefix}${cli.msgs.prefix_source}: ${cli.urls.src}`
+            ],
+            usage: [
+                `\n${this.colors.bw}o ${cli.msgs.helpSection_usage}:${this.colors.nc}`,
+                ` ${this.colors.bw}» ${this.colors.bg}${cli.cmdFormat}${this.colors.nc}`
+            ],
+            params: [
+                `\n${this.colors.bw}o ${cli.msgs.helpSection_params}:${this.colors.nc}`,
+                ` --length=n                  ${cli.msgs.optionDesc_length}.`,
+                ` --qty=n                     ${cli.msgs.optionDesc_qty}.`,
+                ` --charset=chars             ${cli.msgs.optionDesc_charset}.`,
+                ` --exclude=chars             ${cli.msgs.optionDesc_exclude}.`,
+                ` --ui-lang="code"            ${cli.msgs.optionDesc_uiLang}.`,
+                ` --config="path/to/file"     ${cli.msgs.optionDesc_config}.`
+            ],
+            flags: [
+                `\n${this.colors.bw}o ${cli.msgs.helpSection_flags}:${this.colors.nc}`,
+                ` -w, --weak                  ${cli.msgs.optionDesc_weak}.`,
+                ` -b, --basic                 ${cli.msgs.optionDesc_basic}.`,
+                ` -t, --strong                ${cli.msgs.optionDesc_strong}.`,
+                ` -N, --no-numbers            ${cli.msgs.optionDesc_excludeNums}.`,
+                ` -Y, --no-symbols            ${cli.msgs.optionDesc_excludeSymbols}.`,
+                ` -L, --no-lowercase          ${cli.msgs.optionDesc_noLower}.`,
+                ` -U, --no-uppercase          ${cli.msgs.optionDesc_noUpper}.`,
+                ` -s, --similar-chars         ${cli.msgs.optionDesc_similarChars}.`,
+                ` -S, --unstrict              ${cli.msgs.optionDesc_unstrict}.`,
+                ` -E, --no-entropy            ${cli.msgs.optionDesc_noEntropy}.`,
+                ` -q, --quiet                 ${cli.msgs.optionDesc_quiet}.`
+            ],
+            cmds: [
+                `\n${this.colors.bw}o ${cli.msgs.helpSection_cmds}:${this.colors.nc}`,
+                ` -i, --init                  ${cli.msgs.optionDesc_init}.`,
+                ` -h, --help                  ${cli.msgs.optionDesc_help}.`,
+                ` -v, --version               ${cli.msgs.optionDesc_version}.`,
+                ` -v, --stats                 ${cli.msgs.optionDesc_stats}.`,
+                ` -V, --debug                 ${cli.msgs.optionDesc_debug}.`
+            ]
+        }
+        includeSections.forEach(section => // print valid arg elems
+            helpSections[section]?.forEach(line => printHelpMsg(line, /header|usage/.test(section) ? 1 : 29)))
+        console.info(`\n${cli.msgs.info_moreHelp}, ${
+            cli.msgs.info_visit}: ${this.colors.bw}${cli.urls.cliDocs}${this.colors.nc}`)
+
+        function printHelpMsg(msg, indent) { // wrap msg + indent 2nd+ lines
+            const terminalWidth = process.stdout.columns || 80,
+                  words = msg.match(/\S+|\s+/g),
+                  lines = [], prefix = '| '
+
+            // Split msg into lines of appropriate lengths
+            let currentLine = ''
+            words.forEach(word => {
+                const lineLength = terminalWidth -( !lines.length ? 0 : indent )
+                if (currentLine.length + prefix.length + word.length > lineLength) { // cap/store it
+                    lines.push(!lines.length ? currentLine : currentLine.trimStart())
+                    currentLine = ''
+                }
+                currentLine += word
+            })
+            lines.push(!lines.length ? currentLine : currentLine.trimStart())
+
+            // Print formatted msg
+            lines.forEach((line, idx) => console.info(prefix +(
+                idx == 0 ? line // print 1st line unindented
+                    : ' '.repeat(indent) + line // print subsequent lines indented
+            )))
+        }
+    },
+
+    helpDocsCmdsDocsURL() {
+        console.info(`\n${
+            cli.msgs.info_moreHelp}, ${cli.msgs.info_type} ${
+                colors.bw}${cli.name} --<docs|help>${colors.nc} ${
+                cli.msgs.info_or} ${cli.msgs.info_visit}\n${colors.by}${cli.urls.docs}${colors.nc}`
+        )
+    },
+
+    initCmd(invalidKey) {
+        if (invalidKey)
+            this.warn(
+                `${cli.msgs.error_invalidKey} '${invalidKey}' ${cli.msgs.error_foundIn}\n`
+                + `${log.colors.gry}${cli.configPath}`
+            )
+        if (!this.initTipped) {
+            this.break()
+            this.tip(`${
+                string.toTitleCase(cli.msgs.info_type)} '${cli.name} init' ${
+                    cli.msgs.info_toCreateDefaultConfig}`
+            )
+            this.initTipped = true
+        }
+    },
+
+    invalidConfigKey(key) { if (!this[`${key}Tipped`]) { this.initCmd(key) ; this[`${key}Tipped`] = true } },
+
+    async stats(pkgName = cli.name, options = { ecosystem: 'npm', maxDays: 8, maxVers: 5, scheme: 'default' }) {
+        const pkgStats = await getDownloads(pkgName, options),
+              schemeData = colors.schemes[options.scheme]
+        if (!schemeData) return this.error(`Scheme '${options.scheme}' not found!`)
+        const colorMap = Object.fromEntries(schemeData.map((hex, idx) => [`c${idx}`, hex])),
+              statsTable = new (require('console-table-printer').Table)({ colorMap })
+        pkgStats.forEach((row, idx) => // build colored rows
+            statsTable.addRow(row, { color: `c${Math.floor(idx / pkgStats.length * schemeData.length)}` }))
+        statsTable.printTable()
+    },
+
+    version() {
+        this.info(cli.name)
+        this.data(`${
+            cli.msgs.prefix_globalVer}: ${ getVer('global') || 'none' }\n${
+            cli.msgs.prefix_localVer }: ${ getVer('local')  || 'none' }`
+        )
+    }
+}