Skip to content
This repository has been archived by the owner on Jan 3, 2019. It is now read-only.
/ pkgname Public archive

A simple tool that helps you find a name for your app, framework or library.

License

Notifications You must be signed in to change notification settings

clebert/pkgname

Repository files navigation

pkgname

npm Build Status Commitizen friendly

A simple tool that helps you find a name for your app, framework or library.

The name suggestions are generated using data from WordNet®, a lexical database for English.

Screenshot

Installation

npm install -g pkgname

Usage

Usage
  $ pkgname [options]

Options
  --help, -h                Usage information
  --version, -v             Version information
  --max-length <n>          Displays only names with a maximum length of <n>
  --npm-check               Displays only names that are available on npm
  --npm-latest              Downloads always the latest list of npm package names, even if you already have them
  --remove-hyphens          Removes the hyphens from all hyphenated names
  --search-definitions <s>  Displays only names whose definition match the case-insensitive pattern <s>
  --search-names <s>        Displays only names that match the case-insensitive pattern <s>
  --shuffle-names           Displays the names in random order

Examples
  $ pkgname
  $ pkgname --npm-check --npm-latest
  $ pkgname --max-length 7 --npm-check --search-definitions "the [a-z]+ star" --shuffle-names
  $ pkgname --npm-check --remove-hyphens --search-names "^[a-z]{5}$"

Development

Installing the dev dependencies

npm install

Watching the sources and tests

npm run watch

Checking for formatting and linting errors

npm run check

Formatting the sources

npm run format

Committing a new change

npm run cz

Publishing a new version

npm run release
git push --follow-tags origin master
npm publish

Starting in debug mode

DEBUG=* node ./lib/index.js

Built by (c) Clemens Akens. Released under the MIT license.

About

A simple tool that helps you find a name for your app, framework or library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published