make-it-name

Generate random, docker-like names, e.g. 'quirky-asimov' or 'brainy-bronte'

Usage no npm install needed!

<script type="module">
  import makeItName from 'https://cdn.skypack.dev/make-it-name';
</script>

README

make-it-name

Make-it-name is a random name generator that can be used via CLI or as a npm package. Make-it-name was designed to be a light-weight utility used from a Powershell terminal; feel free to adapt and use as you see fit.

Make-it-name outputs a randomly generated name from three wordlists: adjectives, scientist names, and author names. By default, these names are separated by '-' for readability and usage.

Example output:

quirky-asimov

Problem

Sometimes, one of the hardest things to do is to start. In my experience, coming up with a name for anything can get in the way of progress, whether that is a function name, test method name, article title, etc. Getting caught up in naming something can easily keep you from putting one foot in front of the other. Names are extremely important and should require a lot of thought, however it is usually easier to describe what something is doing after it exists rather than before. Make-it-name was built as a fun way to help stub out names and for me to learn a little about NodeJS CLIs.

Inspiration

If you use Docker, you'll notice that if an image name is not provided, Docker will create a name for your image composed of an adjective and the last name of famous scientist. Similarly, make-it-name uses adjectives and scientist names to create a name, but also adds last name of a famous author as a possible alternative.

Installation

Install from npm:

If you plan to use as is, run:

npm i -g make-it-name //or npm install -g make-it-name

Local installation:

If you wish to clone the repository and then install globally, navigate to the repository's context in your terminal and run:

npm i -g //or npm install -g

Check global installation:

To check your global installation, run:

npm ls -g -depth=0

Uninstall

To uninstall, run:

npm uninstall -g make-it-name

Usage

Once the make-it-name package has been installed globally the mknm command should be accessible via Powershell, Cmd, or NodeJS terminal.

Example:

PS C:\> mknm
historical-watson

Make-it-name supports command line arguments for formatting with underscores instead of hyphens, capitalization, and alliteration. Each command line argument can be combined with another.

Example:

PS C:\> mknm -u
tart_dickinson

Example:

PS C:\> mknm -u -c
Abusive_Vesalius

Example:

PS C:\> mknm -u -c -a

Advanced Usage

To make the output of make-it-name a little more usable, you can use a Powershell function and alias to set the output in your clipboard value.

Modify your current Powershell profile to store a new alias.

Open your profile with VS Code:

code $profile //or notepad $profile

Add the following function and alias with your replacement for [name]:

Function Generate-Name { Set-Clipboard -Value (. mknm) }
Set-Alias -Name [name] -Value Generate-Name

Whatever value you provided for the alias name can be called via Powershell to copy a random name to your clipboard.