Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fordnox/wordplex
Generate words by providing format CVVC# => GOOG1
https://github.com/fordnox/wordplex
automation consonants generator language npm random vowels
Last synced: 2 days ago
JSON representation
Generate words by providing format CVVC# => GOOG1
- Host: GitHub
- URL: https://github.com/fordnox/wordplex
- Owner: fordnox
- License: mit
- Created: 2019-11-28T21:16:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T10:14:28.000Z (8 months ago)
- Last Synced: 2025-01-22T20:33:45.594Z (23 days ago)
- Topics: automation, consonants, generator, language, npm, random, vowels
- Language: JavaScript
- Homepage:
- Size: 379 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPlex
[](https://github.com/fordnox/wordplex/actions)
[](https://www.npmjs.com/package/wordplex)
[](https://npm-stat.com/charts.html?package=wordplex&from=2019-11-01)
[](http://opensource.org/licenses/MIT)
## Installation
Install for global use
```js
npm i -g wordplex
```
Install for use in project
```js
npm i --save wordplex
```
## CLI
```cli
wordplex --help
wordplex [options]
Generate words according to pattern CVC (generates: bab ...) or word google
(generates baabba ...)
Options:
--help Show help [boolean]
--version Show version number [boolean]
--verbose, -v Run with verbose logging [boolean]
--similar, -s Provide similar word instead of pattern. Will generate similar
words. [boolean]
--prefix Set text to be added to the beggining of all generated texts
[string]
--suffix Set text to be added to the end of all generated texts [string]
--pattern [default: "CVC"]
```
Generate all 3 letter .com domains in `CVC` format
```wordplex CVC --suffix=.com```
Generate all 4 letter .net domains in `CVCV` format
```wordplex CVCV --suffix=.net```
Generate words in format `CVC` (consonant vowel consonant)
```cli
$ wordplex CVC
bbb
bbc
bbd
bbf
bbg
bbh
bbj
bbk
bbl
bbm
...
```
```cli
$ wordplex look
```
Will generate words similar to `look` in `CVVC` format
```
baab
baac
baad
baaf
baag
baah
baaj
baak
baal
baam
...
```
## Example script
```js
const wordplex = require('wordplex');
wordplex.generate('CVC', function(word) {
console.log(word)
});
```
Result
```cli
[ 'bab',
'bac',
'bad',
'baf',
'bag',
'bah',
'baj',
'bak',
'bal',
'bam',
'ban',
'bap',
'baq',
...
```
## Generating words
```js
var words = wordplex.generate('VC');
console.log(words)
```
Result
```cli
[ 'ab',
'ac',
'ad',
'af',
'ag',
'ah',
'aj',
'ak',
'al',
'am',
'an',
...
```
## Generating similar format words
```js
var words = wordplex.similar('google');
console.log(words)
```
Result generate words in `CVVCCV` format
```cli
[ 'baabba',
'baabbe',
'baabbi',
'baabbo',
'baabbu',
'baabca',
'baabce',
'baabci',
'baabco',
'baabcu',
'baabda',
'baabde',
...
```
## Generating words with numbers
```js
var words = wordplex.generate('VC#');
console.log(words)
```
Result
```cli
[ 'ab1',
'ab2',
'ab3',
'ab4',
'ab5',
'ab6',
'ab7',
'ab8',
'ab9',
'ab0',
'ac1',
'ac2',
'ac3',
...
```
## Generating words with prefix
```js
var words = wordplex.setPrefix('my-').similar("dog");
console.log(words)
```
Result
```cli
[ 'my-bab',
'my-bac',
'my-bad',
'my-baf',
'my-bag',
'my-bah',
'my-baj',
'my-bak',
'my-bal',
'my-bam',
'my-ban',
'my-bap',
...
```
## Generating words with suffix
```js
var words = wordplex.setSuffix('.com').generate('CVC');
console.log(words)
```
Result
```cli
[ 'bab.com',
'bac.com',
'bad.com',
'baf.com',
'bag.com',
'bah.com',
'baj.com',
'bak.com',
'bal.com',
'bam.com',
'ban.com',
'bap.com',
...
```
## Reset generator to default values
```js
var words = wordplex.reset().generate();
console.log(words)
```
Result
```cli
[ 'ab',
'ac',
'ad',
'af',
'ag',
'ah',
'aj',
'ak',
...
```
# Development
npm i --dev
npm test