mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
593a956550
* command-line-usage types good default bad * Type adjustments export Section, raw optional * No errors - try remove tslint rule override * Linting .d.ts works great! * typings pass all given examples * Removed type-annotation causing Travis to fail * Re-added Dvorsky as contributor Even though the new definitions completely overwrite the old, it was requested that the original author be re-added. * Fixed a silly, silly mistake - missing comment slashes
83 lines
4.3 KiB
TypeScript
83 lines
4.3 KiB
TypeScript
// Type definitions for command-line-usage 5.0
|
|
// Project: https://github.com/75lb/command-line-usage#readme
|
|
// Definitions by: matrumz <https://github.com/matrumz>
|
|
// Andrija Dvorski <https://github.com/Dvorsky>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.2
|
|
|
|
/**
|
|
* Generates a usage guide suitable for a command-line app.
|
|
* @param sections One or more Section objects
|
|
* @alias module:command-line-usage
|
|
*/
|
|
declare function commandLineUsage(sections: commandLineUsage.Section | commandLineUsage.Section[]): string;
|
|
export = commandLineUsage;
|
|
|
|
declare namespace commandLineUsage {
|
|
/** Section object. */
|
|
type Section = Content | OptionList;
|
|
|
|
/** A Content section comprises a header and one or more lines of content. */
|
|
interface Content {
|
|
/** The section header, always bold and underlined. */
|
|
header?: string;
|
|
/**
|
|
* Overloaded property, accepting data in one of four formats.
|
|
* 1. A single string (one line of text).
|
|
* 2. An array of strings (multiple lines of text).
|
|
* 3. An array of objects (recordset-style data). In this case, the data will be rendered in table format. The property names of each object are not important, so long as they are
|
|
* consistent throughout the array.
|
|
* 4. An object with two properties - data and options. In this case, the data and options will be passed directly to the underlying table layout module for rendering.
|
|
*/
|
|
content?: string | string[] | any[] | { data: any; options: any };
|
|
/** Set to true to avoid indentation and wrapping. Useful for banners. */
|
|
raw?: boolean;
|
|
}
|
|
|
|
/** Describes a command-line option. Additionally, if generating a usage guide with command-line-usage you could optionally add description and typeLabel properties to each definition. */
|
|
interface OptionDefinition {
|
|
name: string;
|
|
/**
|
|
* The type value is a setter function (you receive the output from this), enabling you to be specific about the type and value received.
|
|
*
|
|
* The most common values used are String (the default), Number and Boolean but you can use a custom function.
|
|
*/
|
|
type?: any;
|
|
/** getopt-style short option names. Can be any single character (unicode included) except a digit or hyphen. */
|
|
alias?: string;
|
|
/** Set this flag if the option takes a list of values. You will receive an array of values, each passed through the type function (if specified). */
|
|
multiple?: boolean;
|
|
/** Identical to multiple but with greedy parsing disabled. */
|
|
lazyMultiple?: boolean;
|
|
/** Any values unaccounted for by an option definition will be set on the defaultOption. This flag is typically set on the most commonly-used option to make for more concise usage. */
|
|
defaultOption?: boolean;
|
|
/** An initial value for the option. */
|
|
defaultValue?: any;
|
|
/**
|
|
* When your app has a large amount of options it makes sense to organise them in groups.
|
|
*
|
|
* There are two automatic groups: _all (contains all options) and _none (contains options without a group specified in their definition).
|
|
*/
|
|
group?: string | string[];
|
|
/** A string describing the option. */
|
|
description?: string;
|
|
/** A string to replace the default type string (e.g. <string>). It's often more useful to set a more descriptive type label, like <ms>, <files>, <command>, etc.. */
|
|
typeLabel?: string;
|
|
}
|
|
|
|
/** A OptionList section adds a table displaying details of the available options. */
|
|
interface OptionList {
|
|
header?: string;
|
|
/** An array of option definition objects. */
|
|
optionList?: OptionDefinition[];
|
|
/** If specified, only options from this particular group will be printed. */
|
|
group?: string | string[];
|
|
/** The names of one of more option definitions to hide from the option list. */
|
|
hide?: string | string[];
|
|
/** If true, the option alias will be displayed after the name, i.e. --verbose, -v instead of -v, --verbose). */
|
|
reverseNameOrder?: boolean;
|
|
/** An options object suitable for passing into table-layout. */
|
|
tableOptions?: any;
|
|
}
|
|
}
|