A simple cli prompter.

Related tags

Command-line prompt
Overview

@yukikaze-bot/prompt

A simple prompter for your cli.

GitHub npm bundle size npm

Table of Contents

Description

Prompts user input from the cli!

Features

  • Written in TypeScript
  • Offers CommonJS, ESM bundles
  • Fully tested

Installation

yarn add @yukikaze-bot/prompt
# npm install @yukikaze-bot/prompt

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { prompt } = require('@yukikaze-bot/prompt') equals import { prompt } from '@yukikaze-bot/prompt'.

Note: When using ESM syntax you can also default-import prompt function: import prompt from '@yukikaze-bot/prompt'.

Basic Usage

const { prompt } = require('@yukikaze-bot/prompt');
const response = prompt('What is your name?');

console.log(`Your name is: ${response}`);

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Comments
  • chore(deps): update dependency @sapphire/ts-config to v2.3.1

    chore(deps): update dependency @sapphire/ts-config to v2.3.1

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | @sapphire/ts-config | ^2.3.0 -> 2.3.1 | age | adoption | passing | confidence |


    Release Notes

    sapphiredev/utilities

    v2.3.1

    Compare Source

    Note: Version bump only for package @​sapphire/ts-config


    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency @sapphire/prettier-config to v1.1.6

    chore(deps): update dependency @sapphire/prettier-config to v1.1.6

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | @sapphire/prettier-config | ^1.1.4 -> 1.1.6 | age | adoption | passing | confidence |


    Release Notes

    sapphiredev/utilities

    v1.1.6

    Compare Source

    Note: Version bump only for package @​sapphire/prettier-config

    v1.1.5

    Compare Source

    Note: Version bump only for package @​sapphire/prettier-config


    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency @sapphire/eslint-config to v3.2.1

    chore(deps): update dependency @sapphire/eslint-config to v3.2.1

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | @sapphire/eslint-config | ^3.2.0 -> 3.2.1 | age | adoption | passing | confidence |


    Release Notes

    sapphiredev/utilities

    v3.2.1

    Compare Source

    Note: Version bump only for package @​sapphire/eslint-config


    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency prettier to v2.3.2

    chore(deps): update dependency prettier to v2.3.2

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | prettier (source) | ^2.3.1 -> 2.3.2 | age | adoption | passing | confidence |


    Release Notes

    prettier/prettier

    v2.3.2

    Compare Source

    diff

    Fix failure on dir with trailing slash (#​11000 by @​fisker)
    $ ls
    1.js  1.unknown
    

    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency typedoc to v0.21.2

    chore(deps): update dependency typedoc to v0.21.2

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | typedoc (source) | ^0.21.0 -> 0.21.2 | age | adoption | passing | confidence |


    Release Notes

    TypeStrong/TypeDoc

    v0.21.2

    Compare Source

    Bug Fixes
    • Postpone resolution of inherited classes until their parents have been resolved (fc920bd), closes #​1580

    v0.21.1

    Compare Source

    Bug Fixes

    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): pin dependencies

    chore(deps): pin dependencies

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Type | Update | Change | |---|---|---|---| | @sapphire/eslint-config | devDependencies | pin | ^3.2.0 -> 3.2.0 | | @sapphire/prettier-config | devDependencies | pin | ^1.1.4 -> 1.1.4 | | @sapphire/ts-config | devDependencies | pin | ^2.3.0 -> 2.3.0 | | @types/node | devDependencies | pin | ^15.12.4 -> 15.12.4 | | eslint (source) | devDependencies | pin | ^7.29.0 -> 7.29.0 | | gen-esm-wrapper | devDependencies | pin | ^1.1.2 -> 1.1.2 | | npm-run-all | devDependencies | pin | ^4.1.5 -> 4.1.5 | | prettier (source) | devDependencies | pin | ^2.3.1 -> 2.3.1 | | typedoc (source) | devDependencies | pin | ^0.21.0 -> 0.21.0 | | typedoc-plugin-nojekyll | devDependencies | pin | ^1.0.1 -> 1.0.1 | | typescript (source) | devDependencies | pin | ^4.3.4 -> 4.3.4 |

    📌 Important: Renovate will wait until you have merged this Pin PR before creating any upgrade PRs for the affected packages. Add the preset :preserveSemverRanges to your config if you instead don't wish to pin dependencies.


    Configuration

    📅 Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

    👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • Configure Renovate

    Configure Renovate

    WhiteSource Renovate

    Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

    🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.


    Detected Package Files

    • .github/workflows/docs.yml (github-actions)
    • .github/workflows/release.yml (github-actions)
    • package.json (npm)

    Configuration Summary

    Based on the default config's presets, Renovate will:

    • Start dependency updates only once this onboarding PR is merged
    • Separate major versions of dependencies into individual branches/PRs
    • Do not separate patch and minor upgrades into separate PRs for the same dependency
    • Upgrade to unstable versions only if the existing version is unstable
    • Raise PRs immediately (after branch is created)
    • If semantic commits detected, use semantic commit type fix for dependencies and chore for all others
    • Keep existing branches updated even when not scheduled
    • Disable automerging feature - wait for humans to merge all PRs
    • Ignore node_modules, bower_components, vendor and various test/tests directories
    • Autodetect whether to pin dependencies or maintain ranges
    • Rate limit PR creation to a maximum of two per hour
    • Limit to maximum 20 open PRs at any time
    • Group known monorepo packages together
    • Use curated list of recommended non-monorepo package groupings
    • Ignore spring cloud 1.x releases
    • Ignore http4s digest-based 1.x milestones
    • Use node versioning for @types/node
    • Limit concurrent requests to reduce load on Repology servers until we can fix this properly, see issue 10133

    🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.


    What to Expect

    With your current configuration, Renovate will create 2 Pull Requests:

    chore(deps): pin dependencies
    chore(deps): update dependency typedoc to v0.21.1
    • Schedule: ["at any time"]
    • Branch name: renovate/typedoc-0.x
    • Merge into: main
    • Upgrade typedoc to 0.21.1

    ❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.


    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 0
Releases(v2.0.7)
Owner
Yukikaze
The organization for the Yukikaze discord bot.
Yukikaze
A simple CLI pomodoro timer written in Rust.

Pomodoro A simple CLI pomodoro timer written in Rust. Based on the Pomodoro Technique. Works on any platform that supports desktop notifications. Exam

null 6 Nov 26, 2021
Simple cli clipboard manager written in rust

Simple cli clipboard manager written in rust

null 5 Nov 13, 2022
A CLI for fast and simple TODOs

taskus: a simple, but powerful TODO CLI taskus is a tool for managing TODOs. It has support for most operating systems. Shell completions are availabl

Megumin 2 Oct 27, 2021
Small and simple CLI app to generate .editorconfig based on a given settings.

add-editorconfig Small and simple CLI app to generate .editorconfig based on a given settings. Usage # Will create an .editorconfig in the current dir

Reinaldy Rafli 3 Jan 16, 2022
A simple CLI for combining json and yaml files

A simple CLI for combining json and yaml files

Avencera 16 Jul 4, 2022
A simple CLI to build VEXCode V5 Pro projects and download them to the V5 brain.

vexer A simple CLI to build VEXCode V5 Pro projects and download them to the V5 brain. (WIP) This currently is only tested on and only works on window

null 2 May 16, 2022
A simple cli tool to help with wordle in hard mode

Wordking A simple cli tool to help with wordle in hard mode. Usage Run wordking cargo run Wordking will ask for your guesses thus far. Provide your gu

Stephen Spalding 2 Feb 1, 2022
Write a simple CLI script, that when given a 64-byte encoded string

Write a simple CLI script, that when given a 64-byte encoded string, it finds a suitable 4-byte prefix so that, a SHA256 hash of the prefix combined with the original string of bytes, has two last bytes as 0xca, 0xfe. Script should expect the original content of the string to be passed in hexadecimal format and should return two lines, first being the SHA256 string found and second 4-byte prefix used (in hexadecimal format).

Andy Bell 0 Feb 4, 2022
dlfile is a very simple, straightforward CLI to download a file

dlfile dlfile is a very simple, straightforward CLI to download a file, except it... Only downloads over HTTPS Requires TLS 1.2 or higher Executes in

Colin 3 Oct 21, 2022
A simple CLI I made while practicing rust to easily make QR codes with just one command, all in your terminal.

Welcome to rust-qrcode-cli ?? A CLI I made while practicing rust to easily make QR codes with just one command, all in your terminal. Install git clon

Dhravya Shah 2 Mar 2, 2022
laydown is a simple CLI application to help you prepare for your next Daily Standup

laydown is a simple CLI application to help you prepare for your next Daily Standup. No longer shall your name be called on only for you to stare into the abyss while you struggle to remember what you did yesterday.

badjr13 83 Dec 26, 2022
Simple CLI to (add, delete, update, create) i18n translation file 🔤 🦀

, Inrs Simple CLI to (add, delete, update, create) i18n translation file Copyright (C) 2020-2022 TheAwiteb https://github.com/TheAwiteb/inrs This pr

TheAwiteb 4 Oct 4, 2022
Yet Another Texture Packer - a small and simple CLI application to pack multiple textures/sprites into a texture atlas/sprite sheet

YATP (Yet Another Texture Packer) A small and simple CLI application to pack multiple textures/sprites into a texture atlas/sprite sheet. Installation

Petar Petrov 2 Sep 11, 2022
📓 Simple cli snippet manager

nt Minimal cli snippet manager inspired by boom Usage USAGE: nt <SUBCOMMAND> OPTIONS: -h, --help Print help information -V, --versi

Vadim 1 Aug 11, 2022
A simple cli to clone projects and fetch all projects in a GitHub org..

stupid-git A simple cli to clone projects and update all projects. get all repository from GitHub clone all pull all with git stash Usage create sgit.

Fengda Huang 5 Sep 15, 2022
Simple but convenient CLI-based Matrix client app for sending and receiving (in Rust)

matrix-commander-rs simple but convenient CLI-based Matrix client app for sending and receiving Help create this Rust program! This project is current

null 19 Dec 30, 2022
simple but convenient CLI-based Nostr client app for following users and sending DMs

nostr-commander-rs TLDR: simple but convenient CLI-based Nostr client app for publishing, sending DMs, as well as following users and channels nostr-c

null 18 Dec 30, 2022
A simple CLI DDNS Client updater.

DDNS Client A simple DDNS client updater. Supported DDNS Servers Duck DNS How to use it ddns_client ~/.config/ddns_client/config.yaml -t 600 Config sa

Lablack Mourad 2 Dec 6, 2022
🎦 ezz is a simple CLI tool to schedule Zoom meetings

ezz ezz (cheesy abbreviation for easy Zoom) is a simple CLI tool to schedule Zoom meetings. Install With cargo installed: $ cargo install --path . Aut

Eduardo Cuducos 6 Dec 23, 2022