Project Name Generator

Generate quirky names like fluffy-basin, eminent chickens, hissing-popcorn-3056 to use wherever you need a random but memorable name.

Useful for object names, temp folders, passwords, project names, unique ids etc

Install

yarn add project-name-generator --dev

Quick Start

1import generator from 'Generator'
2
3generator.generate().dashed // 'furry-detail'
4generator.generate().spaced // 'typical achiever'
5generator.generate().raw // ['abusive', 'beds']
6generator.generate({ number: true }).dashed // 'waiting-chalk-4875'
7generator.generate({ words: 4, number: true }).dashed // 'abandoned-disastrous-thinkable-quilt-4355'

API

The module returns a single method generator.generate(options)

Calling generator.generate() with no arguments will return and object:

1{
2    raw: ['noxious', 'tongue'],
3    dashed: 'noxious-tongue',
4    spaced: 'noxious tongue'
5}

The options argument can have properties

• words (number) - Number of words generated (excluding number). All words will be ajectives except the last one which will be a noun. Defaults to 2.
• number (boolean) - Whether a numeric suffix is generated or not. The number is between 1 - 9999, both inclusive. Defaults to false.

generator.generate({ words: 3 }) will return:

1{
2    raw: ['purring', 'snowy', 'thrill'],
3    dashed: 'purring-snowy-thrill'
4    spaced: 'purring snowy thrill'
5}

generator.generate({ words: 5, number: true }) will return:

1{
2    raw: ['kindly', 'skillful', 'furry', 'awful', 'expansion', '8244'],
3    dashed: 'kindly-skillful-furry-awful-expansion-8244',
4    spaced: 'kindly skillful furry awful expansion 8244'
5
6}

Tests

To run tests locally:

yarn install

yarn test