Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

codename

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

codename

Codename generator

  • 0.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
510
increased by32.12%
Maintainers
1
Weekly downloads
 
Created
Source

Codename generator

Generates codenames. What for, you ask?

Installation

$ npm install -g codename

Usage

From node,

var codename = require('codename')();

var filters = ['alliterative', 'random'],
    lists = ['crayons', 'adjectives', 'cities', 'animals'],
    myName = codename.generate(filters, lists);
Options

codename.generate takes two options: filters and lists.

  • filters (Array[String|Function]) - describes a set of filters that should be used to reduce each list to a single word

  • lists - (Array[String|Array]) - the names or contents of the lists to use for selecting names

From the CLI,

All arguments are forwarded from comma-delimited strings:

$ codename \
  --lists=crayons,adjectives,cities,animals \
  --filters=alliterative,unique,random

Writing Filters

Each filter takes a memo listing any other words selected followed by the list of words the filter should be applied to. For instance, a filter to limit results to words containing the letter j:

var letterJFilter = function (memo, words) {
  return words.filter(function (w) {
    return w.toLowerCase().indexOf('j') > -1;
  });
};

Alternatively, a filter may return a single word that should be added to the name. These filters are output filters, and they should only be used at the end of a filter list.

Filters may be contributed to src/filters or supplied as function arguments to codename.generate.

Word Lists

License

  • word lists (c) their respective authors
  • codename released under the WTFPL

FAQs

Package last updated on 25 Oct 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc