inquirer-npm-name

Helper function using inquirer to validate a value provided in a prompt does not exist as a npm package.

If the value is already used as a npm package, then the users will be prompted and asked if they want to choose another one. If so, we'll recurse through the same validation process until we have a name that is unused on the npm registry. This is a helper to catch naming issue in advance, it is not a validation rule as the user can always decide to continue with the same name.

Install

1$ npm install --save @abhisekp/inquirer-npm-name # npm i -S @abhisekp/inquirer-npm-name

Usage

1const inquirer = require('inquirer');
2const askName = require('@abhisekp/inquirer-npm-name');
3
4askName({
5  name: 'name',
6  message: 'Module Name'
7}, inquirer).then(answers => {
8  console.log(answers.name);
9});

Inside a Yeoman Generator you'd call it this way:

1const generators = require('yeoman-generator');
2const inquirer = require('inquirer');
3const askName = require('@abhisekp/inquirer-npm-name');
4
5module.exports = generators.Base.extend({
6  prompting: function () {
7    const appNamePrompt = {
8      type: 'input',
9      name: 'appname',
10      message: 'What would you like to name the app?',
11      default: answers => this.appname, // optional
12      filter: appname => appname.trim().replace(/\s+/g, '-').toLowerCase() // optional
13    };
14
15    const prompts = []; // other prompts
16
17    return askName(appNamePrompt, this)
18      .then(name =>
19        this.prompt(prompts)
20          .then(answers => this.answers = answers)
21      );
22  }
23});

askName takes 2 parameters:

1. prompt an Inquirer prompt configuration.
2. inquirer or any object with a obj.prompt() method.

Returns: A Promise resolved with the answer object.

Contributors

Thanks goes to these wonderful people (emoji key):

Abhisek Pattnaik 💻 💡

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © Simon Boudrias