Skip to main content
Deno 2 is finally here 🎉️
Learn more
Latest
import * as dmm from "https://deno.land/x/dmm@v2.1.2/tests/integration/up-to-date-deps/original_deps.ts";

Namespaces

String formatters and utilities for dealing with ANSI color codes.

Helpers for working with the filesystem.

Logging library with the support for terminal and file outputs. Also provides interfaces for building custom loggers.

Classes

Completion list type.

Boolean type with auto completion. Allows true, false, 0 and 1.

Cell representation.

Checkbox prompt representation.

String type with auto completion of child command names.

Generates shell completion scripts for various shell's.

Confirm prompt representation.

Enum type. Allows only provided values.

Generic input prompt representation.

Generic list prompt representation.

Generic prompt representation.

Generates well formatted and colored help output for specified command.

Input prompt representation.

List prompt representation.

Number prompt representation.

Number type.

Row representation.

Secret prompt representation.

Select prompt representation.

String type. Allows any value.

Table representation.

Toggle prompt representation.

c
Cliffy.Type
abstract

Base class for custom types.

An object that encapsulates provided message and arguments as well some metadata that can be later used when formatting a message.

Enums

Available build-in argument types.

Platform-specific conventions for the line ending format (i.e., the "end-of-line").

Get log level numeric values through enum constants. Defaults to INFO.

Variables

Chainable ansi escape sequence's. If invoked as method, a new Ansi instance will be returned.

Ring audio bell: \u0007

Boolean type handler. Excepts true, false, 1, 0

Clear the terminal screen. (Viewport)

Clear the whole terminal, including scrollback buffer. (Not just the visible part of it).

Hide cursor.

Move cursor to first column of current row.

Get cursor position.

Restore cursor.

Save cursor.

Show cursor.

Clear current line.

Clear to line end.

Clear to line start.

Clear screen.

Prompt icons.

Base key mapping.

Ctrl key mapping.

Shift key mapping.

Number type handler. Excepts any numeric value.

Special key mapping.

String type handler. Excepts any value.

Chainable ansi escape sequence's. If invoked as method, a new Tty instance will be returned.

Handlers are responsible for actual output of log messages. When a handler is called by a logger, it firstly checks that LogRecord's level is not lower than level of the handler. If level check passes, handlers formats log record into string and outputs it to target.

Functions

Move cursor backward by n lines.

Move cursor down by n lines.

Move cursor forward by n lines.

Move cursor by offset.

Move cursor to the beginning of the line n lines down.

Move cursor to the beginning of the line n lines up.

Move cursor to x, y, counting from the top left corner.

Move cursor up by n lines.

Clear screen down by n lines.

Clear screen and move cursor by n lines up and move cursor to first column.

Clear screen up by n lines.

Get cursor position.

Create image.

Inject prompt values. Can be used for unit tests or pre selections.

Create link.

Parse ansi escape sequence.

Parse command line arguments.

Scroll window down by n lines.

Scroll window up by n lines.

Flags post validation. Validations that are not already done by the parser.

Set background color to black.

Set background color to blue.

Set background color to bright black.

Set background color to bright blue.

Set background color to bright cyan.

Set background color to bright green.

Set background color to bright magenta.

Set background color to bright red.

Set background color to bright white.

Set background color to bright yellow.

Set background color to cyan.

Set background color to green.

Set background color to magenta.

Set background color to red.

Set background color using 24bit rgb. color can be a number in range 0x000000 to 0xffffff or an Rgb.

Set background color using paletted 8bit colors. https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit

Set background color to white.

Set background color to yellow.

Set text color to black.

Set text color to blue.

Make the text bold.

Set text color to bright black.

Set text color to bright blue.

Set text color to bright cyan.

Set text color to bright green.

Set text color to bright magenta.

Set text color to bright red.

Set text color to bright white.

Set text color to bright yellow.

Set text color to cyan.

The text emits only a small amount of light.

Get whether text color change is enabled or disabled.

Set text color to gray.

Set text color to green.

Make the text hidden.

Invert background color and text color.

Make the text italic.

Set text color to magenta.

Set text color to red.

Reset the text modified

Set text color using 24bit rgb. color can be a number in range 0x000000 to 0xffffff or an Rgb.

Set text color using paletted 8bit colors. https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit

Set changing text color to enabled or disabled

Put horizontal line through the center of the text.

Remove ANSI escape codes from the string.

Make the text underline.

Set text color to white.

Set text color to yellow.

Copy a file or directory. The directory can have contents. Like cp -r. Requires the --allow-read and --allow-write flag.

Copy a file or directory. The directory can have contents. Like cp -r. Requires the --allow-read and --allow-write flag.

Detect the EOL character for string input. returns null if no newline.

Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted. Requires the --allow-read and --allow-write flag.

Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted. Requires the --allow-read and --allow-write flag.

Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p. Requires the --allow-read and --allow-write flag.

Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p. Requires the --allow-read and --allow-write flag.

Ensures that the file exists. If the file that is requested to be created is in directories that do not exist. these directories are created. If the file already exists, it is NOTMODIFIED. Requires the --allow-read and --allow-write flag.

Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOT MODIFIED. Requires the --allow-read and --allow-write flag.

Ensures that the hard link exists. If the directory structure does not exist, it is created.

Ensures that the hard link exists. If the directory structure does not exist, it is created.

Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created.

Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created.

Test whether or not the given path exists by checking with the file system. Please consider to check if the path is readable and either a file or a directory by providing additional options:

Test whether or not the given path exists by checking with the file system. Please consider to check if the path is readable and either a file or a directory by providing additional options:

Expand the glob string from the specified root directory and yield each result as a WalkEntry object.

Synchronous version of expandGlob().

Format the file to the targeted EOL.

Moves a file or directory.

Moves a file or directory synchronously.

Walks the file tree rooted at root, yielding each file or directory in the tree filtered according to the given options.

Same as walk() but uses synchronous ops

Log with critical level, using default logger.

Log with debug level, using default logger.

Log with error level, using default logger.

Get a logger instance. If not specified name, get the default logger.

Log with info level, using default logger.

Setup logger config.

Log with warning level, using default logger.

Validate that the passed UUID is an RFC4122 v4 UUID.

Interfaces

Ansi instance returned by all ansi escape properties.

Chainable ansi escape method declarations.

Checkbox key options.

Checkbox option options.

Checkbox prompt options.

Checkbox option settings.

Confirm prompt options.

Cursor position.

Cursor position options.

Input keys options.

Generic input prompt options.

Generic input prompt settings.

Select key options.

Generic list option options.

Generic list prompt options.

Generic list option settings.

Generic list prompt settings.

Input keys options.

Generic prompt options.

Generic prompt settings.

Global prompt options.

Argument details.

Cell options.

Command option options.

Completion options.

Completion settings.

Environment variable settings.

Environment variable options

Example settings.

Flag argument definition.

Flag options.

Result of the parseFlags method.

Image options.

Input prompt options.

Command option settings.

Parser options.

Result of cmd.parse() method.

Row options.

Table options.

Table settings.

Type settings.

Type details.

Type options.

List prompt options.

Number key options.

Number prompt options.

Secret prompt options.

Select prompt options.

Select prompt settings.

Static generic prompt interface.

Toggle key options.

Generic prompt options.

Ansi instance returned by all ansi escape properties.

Create new Ansi instance.

Type Aliases

Chainable ansi escape sequence's. If invoked as method, a new Ansi instance will be returned.

Create new Ansi instance.

Checkbox options type.

Checkbox option settings type.

Chainable colors module. If invoked as method, a new Colors instance will be returned.

Chainable colors instance returned by all ansi escape properties.

Create new Colors instance.

Action handler for commands and options.

Border characters settings.

Cell type

Type parser method.

Json row.

Default flag value

Description handler.

Value handler for custom value processing.

Help callback method to print the help. Invoked by the --help option and help command and the .getHelp() and .showHelp() method's.

Row type

Table type.

Custom type handler/parser.

Version callback method to print the version. Invoked by the --help option command and the .getVersion() and .showHelp() method's.

List key options.

Secret key options.

Select key options.

Select option options.

Select option settings.

Select options type.

Select option settings type.

Chainable ansi escape sequence's. If invoked as method, a new Tty instance will be returned.

Create new Tty instance.

Prompt validation return tape.

Union of valid log level strings