https://github.com/recuencojones/inquirer-ordinal-prompt

Ordinal prompt for inquirer
https://github.com/recuencojones/inquirer-ordinal-prompt

github-actions inquirer inquirer-plugin inquirer-prompt jest typescript

Last synced: 3 months ago
JSON representation

Ordinal prompt for inquirer

• Host: GitHub
• URL: https://github.com/recuencojones/inquirer-ordinal-prompt
• Owner: RecuencoJones
• License: mit
• Created: 2020-06-23T08:51:36.000Z (almost 5 years ago)
• Default Branch: develop
• Last Pushed: 2023-01-06T09:39:56.000Z (over 2 years ago)
• Last Synced: 2024-12-28T05:41:50.345Z (5 months ago)
• Topics: github-actions, inquirer, inquirer-plugin, inquirer-prompt, jest, typescript
• Language: TypeScript
• Homepage:
• Size: 1.04 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/inquirer-ordinal-prompt.svg)](https://npmjs.com/package/inquirer-ordinal-prompt)

![Build](https://github.com/RecuencoJones/inquirer-ordinal-prompt/workflows/Build/badge.svg)

# inquirer-ordinal-prompt

Ordinal prompt for [inquirer](https://github.com/SBoudrias/Inquirer.js)

## Installation

```

npm install --save inquirer inquirer-ordinal-prompt

```

## Usage

```js

inquirer.registerPrompt('ordinal', require('inquirer-ordinal-prompt').default);

inquirer.prompt({

  type: 'ordinal',

  name: 'scripts',

  message: 'Pick scripts to run in order',

  choices: [ 'Build', 'Lint', 'Test' ],

  default: [ 'Build' ]

});

```

## Options

Take `type`, `name`, `message`, `choices`[, `filter`, `validate`, `default`] properties.

`default` is expected to be an Array of the ordered choices value.

ordinal prompt is mostly the same as [checkbox prompt](https://github.com/SBoudrias/Inquirer.js#checkbox---type-checkbox), with slight differences:

- it doesn't use `checked` property and instead leverages `default` as an ordered list of choice values.

- selecting a choice will show ordinal index instead of filled checkbox.

## Example

You can find a running example in [demo.js](https://github.com/RecuencoJones/inquirer-ordinal-prompt/blob/develop/demo.js)

[![asciicast](./demo.gif)](https://asciinema.org/a/BAL0gV4p1PqFgcdfzc1ndd3Jk)