126 lines
2.5 KiB
YAML
126 lines
2.5 KiB
YAML
|
name: StyleInterface
|
||
|
|
class_comment: null
|
||
|
|
dependencies: []
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: title
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Output style helpers.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @author Kevin Bond <kevinbond@gmail.com>
|
||
|
|
|
||
|
|
# */
|
||
|
|
|
||
|
|
# interface StyleInterface
|
||
|
|
|
||
|
|
# {
|
||
|
|
|
||
|
|
# /**
|
||
|
|
|
||
|
|
# * Formats a command title.'
|
||
|
|
- name: section
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats a section title.'
|
||
|
|
- name: listing
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: elements
|
||
|
|
comment: '# * Formats a list.'
|
||
|
|
- name: text
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats informational text.'
|
||
|
|
- name: success
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats a success result bar.'
|
||
|
|
- name: error
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats an error result bar.'
|
||
|
|
- name: warning
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats an warning result bar.'
|
||
|
|
- name: note
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats a note admonition.'
|
||
|
|
- name: caution
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: message
|
||
|
|
comment: '# * Formats a caution admonition.'
|
||
|
|
- name: table
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: headers
|
||
|
|
- name: rows
|
||
|
|
comment: '# * Formats a table.'
|
||
|
|
- name: ask
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: question
|
||
|
|
- name: default
|
||
|
|
default: 'null'
|
||
|
|
- name: validator
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Asks a question.'
|
||
|
|
- name: askHidden
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: question
|
||
|
|
- name: validator
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Asks a question with the user input hidden.'
|
||
|
|
- name: confirm
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: question
|
||
|
|
- name: default
|
||
|
|
default: 'true'
|
||
|
|
comment: '# * Asks for confirmation.'
|
||
|
|
- name: choice
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: question
|
||
|
|
- name: choices
|
||
|
|
- name: default
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Asks a choice question.'
|
||
|
|
- name: newLine
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: count
|
||
|
|
default: '1'
|
||
|
|
comment: '# * Add newline(s).'
|
||
|
|
- name: progressStart
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: max
|
||
|
|
default: '0'
|
||
|
|
comment: '# * Starts the progress output.'
|
||
|
|
- name: progressAdvance
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: step
|
||
|
|
default: '1'
|
||
|
|
comment: '# * Advances the progress output X steps.'
|
||
|
|
- name: progressFinish
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Finishes the progress output.'
|
||
|
|
traits: []
|
||
|
|
interfaces: []
|