hold-place v0.1.2

A simple CLI tool to quickly publish a barebones package to the npm registry under a given name.

Installation

It is recommended to install this package globally, as its usage is independant and unrelated to other locally installed packages.

npm i -g hold-place

You can also temporarily install the package to a central cache with npx instead of installing it globally. To do so, skip the above installation step, and simply prefix all usage commands with npx.

Usage

This tool will publish a package to npm as the npm account of the credentials stored in execution environment (i.e. the npm account logged-in on your client).

To publish a package, you must have a user on the npm registry. If you don't have one, you can create it 2 ways:

• On the npm website
• Using npm adduser

Note: If you created one on the site, use npm login to store the credentials on the client.

Once you have created a user and logged in, you can use npm config ls to ensure that the credentials are stored on your client. You can also check that your user has been added to the registry by going to https://npmjs.com/~username.

Source: http://npm.github.io/installation-setup-docs/installing/logging-in-and-out.html

To generate and publish the package, specify the name under which to publish on the npm registry as the first CLI argument.

hold-place some-coveted-namespace

or, if using npx

npx hold-place some-coveted-namespace

(and accept the prompts to install the package if it is not already found in the central cache.)

TODO

Future updates will improve configurability, by supporting CLI options to configure the auto-generated package source code, namely adding an informative default README.md file and allowing the package initialization to be interactive.

Support will also be added for a dry-run to check whether a namespace is available (whether publishing will succeed).