Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
terminal-kit
Advanced tools
terminal-kit - npm Package Compare versions
Comparing version 0.1.1 to 0.1.2
@@ -11,8 +11,124 @@ | ||
| Work in progress, no documentation ATM. | ||
| Work in progress, only a rough documentation ATM. | ||
| Full BDD spec generated by Mocha: | ||
| # Short function description | ||
| ## Basics | ||
| ### Common/Misc | ||
| * reset(): full reset the terminal. | ||
| * error(): it just set error to true so it will write to STDERR instead of STDOUT | ||
| * beep(): emit a beep | ||
| ### Foreground colors | ||
| * defaultColor(): back to the default foreground color | ||
| * black(): ... | ||
| * red(): ... | ||
| * green(): ... | ||
| * yellow(): dark yellow, most of time brown or orange | ||
| * blue(): ... | ||
| * magenta(): ... | ||
| * cyan(): ... | ||
| * white(): ... | ||
| * brightBlack(): ... | ||
| * brightRed(): ... | ||
| * brightGreen(): ... | ||
| * brightYellow(): true yellow | ||
| * brightBlue(): ... | ||
| * brightMagenta(): ... | ||
| * brightCyan(): ... | ||
| * brightWhite(): ... | ||
| * color(register): choose between 16 colors using an 0..15 integer | ||
| * darkColor(register): choose between 8 regular (dark) colors using an 0..7 integer | ||
| * brightColor(register): choose between 8 bright colors using an 0..7 integer | ||
| ### Background colors | ||
| * bgDefaultColor(): back to the default background color | ||
| * bgBlack(): ... | ||
| * bgRed(): ... | ||
| * bgGreen(): ... | ||
| * bgYellow(): dark yellow, most of time brown or orange | ||
| * bgBlue(): ... | ||
| * bgMagenta(): ... | ||
| * bgCyan(): ... | ||
| * bgWhite(): ... | ||
| * bgDarkColor(): ... | ||
| * bgBrightBlack(): ... | ||
| * bgBrightRed(): ... | ||
| * bgBrightGreen(): ... | ||
| * bgBrightYellow(): true yellow | ||
| * bgBrightBlue(): ... | ||
| * bgBrightMagenta(): ... | ||
| * bgBrightCyan(): ... | ||
| * bgColor(register): choose between 16 colors using an 0..15 integer | ||
| * bgBrightWhite(): choose between 8 regular (dark) colors using an 0..7 integer | ||
| * bgBrightColor(): choose between 8 bright colors using an 0..7 integer | ||
| ### Styles | ||
| * styleReset(): reset all styles and go back to default colors without | ||
| * bold(): bold text | ||
| * dim(): faint color | ||
| * italic(): italic | ||
| * underline(): underline | ||
| * blink(): blink text, not widely supported | ||
| * inverse(): foreground and background color | ||
| * hidden(): invisible, but can be copy/paste'd | ||
| * strike(): strike throught | ||
| ### Cursors | ||
| * saveCursor(): save cursor position | ||
| * restoreCursor(): restore a previously saved cursor position | ||
| * up(n): move the cursor 'n' chars up | ||
| * down(n): move the cursor 'n' chars down | ||
| * right(n): move the cursor 'n' chars right | ||
| * left(n): move the cursor 'n' chars left | ||
| * moveTo(x,y): move the cursor to the (x,y) coordinate (1,1 is the upper-left corner) | ||
| ### Editing | ||
| * clear(): clear the screen and move the cursor to the upper-left corner | ||
| * eraseDisplayBelow(): erase everything below the cursor | ||
| * eraseDisplayAbove(): erase everything above the cursor | ||
| * eraseDisplay(): erase everything | ||
| * eraseLineAfter(): erase current line after the cursor | ||
| * eraseLineBefore(): erase current line before the cursor | ||
| * eraseLine(): erase current line | ||
| * alternateScreenBuffer(boolean): this set/unset the alternate screen buffer, many terminal do not support it or inhibit it | ||
| ### Input/Output | ||
| * requestCursorLocation(): request the cursor location, a 'terminal' event will be fired when available | ||
| * requestScreenSize(): request for screen size, a 'terminal' event will be fired when available (rarely useful, most of time this event is fired on resize) | ||
| * applicationKeypad(): should allow keypad to send different code than 0..9 keys, not widely supported | ||
| ### Internal input/output (do not use directly, use grabInput() instead) | ||
| * mouseButton(): ask the terminal to send event when a mouse button is pressed, with the mouse cursor position | ||
| * mouseDrag(): ask the terminal to send event when a mouse button is pressed and when draging, with the mouse cursor position | ||
| * mouseMotion(): ask the terminal to send all mouse event, even mouse motion that occurs without buttons | ||
| * mouseSGR: another mouse protocol that extend coordinate mapping (without it, it supports only 223 rows and columns) | ||
| * focusEvent: ask the terminal to send event when it gains and loses focus, not widely supported | ||
| ### OS functions (not widely supported) | ||
| windowTitle(): set the title of an xterm-compatible window | ||
| { | ||
| "name": "terminal-kit", | ||
| "version": "0.1.1", | ||
| "version": "0.1.2", | ||
| "description": "Terminal utilities.", | ||
@@ -5,0 +5,0 @@ "main": "lib/terminal.js", |
120
README.md
@@ -11,8 +11,124 @@ | ||
| Work in progress, no documentation ATM. | ||
| Work in progress, only a rough documentation ATM. | ||
| Full BDD spec generated by Mocha: | ||
| # Short function description | ||
| ## Basics | ||
| ### Common/Misc | ||
| * reset(): full reset the terminal. | ||
| * error(): it just set error to true so it will write to STDERR instead of STDOUT | ||
| * beep(): emit a beep | ||
| ### Foreground colors | ||
| * defaultColor(): back to the default foreground color | ||
| * black(): ... | ||
| * red(): ... | ||
| * green(): ... | ||
| * yellow(): dark yellow, most of time brown or orange | ||
| * blue(): ... | ||
| * magenta(): ... | ||
| * cyan(): ... | ||
| * white(): ... | ||
| * brightBlack(): ... | ||
| * brightRed(): ... | ||
| * brightGreen(): ... | ||
| * brightYellow(): true yellow | ||
| * brightBlue(): ... | ||
| * brightMagenta(): ... | ||
| * brightCyan(): ... | ||
| * brightWhite(): ... | ||
| * color(register): choose between 16 colors using an 0..15 integer | ||
| * darkColor(register): choose between 8 regular (dark) colors using an 0..7 integer | ||
| * brightColor(register): choose between 8 bright colors using an 0..7 integer | ||
| ### Background colors | ||
| * bgDefaultColor(): back to the default background color | ||
| * bgBlack(): ... | ||
| * bgRed(): ... | ||
| * bgGreen(): ... | ||
| * bgYellow(): dark yellow, most of time brown or orange | ||
| * bgBlue(): ... | ||
| * bgMagenta(): ... | ||
| * bgCyan(): ... | ||
| * bgWhite(): ... | ||
| * bgDarkColor(): ... | ||
| * bgBrightBlack(): ... | ||
| * bgBrightRed(): ... | ||
| * bgBrightGreen(): ... | ||
| * bgBrightYellow(): true yellow | ||
| * bgBrightBlue(): ... | ||
| * bgBrightMagenta(): ... | ||
| * bgBrightCyan(): ... | ||
| * bgColor(register): choose between 16 colors using an 0..15 integer | ||
| * bgBrightWhite(): choose between 8 regular (dark) colors using an 0..7 integer | ||
| * bgBrightColor(): choose between 8 bright colors using an 0..7 integer | ||
| ### Styles | ||
| * styleReset(): reset all styles and go back to default colors without | ||
| * bold(): bold text | ||
| * dim(): faint color | ||
| * italic(): italic | ||
| * underline(): underline | ||
| * blink(): blink text, not widely supported | ||
| * inverse(): foreground and background color | ||
| * hidden(): invisible, but can be copy/paste'd | ||
| * strike(): strike throught | ||
| ### Cursors | ||
| * saveCursor(): save cursor position | ||
| * restoreCursor(): restore a previously saved cursor position | ||
| * up(n): move the cursor 'n' chars up | ||
| * down(n): move the cursor 'n' chars down | ||
| * right(n): move the cursor 'n' chars right | ||
| * left(n): move the cursor 'n' chars left | ||
| * moveTo(x,y): move the cursor to the (x,y) coordinate (1,1 is the upper-left corner) | ||
| ### Editing | ||
| * clear(): clear the screen and move the cursor to the upper-left corner | ||
| * eraseDisplayBelow(): erase everything below the cursor | ||
| * eraseDisplayAbove(): erase everything above the cursor | ||
| * eraseDisplay(): erase everything | ||
| * eraseLineAfter(): erase current line after the cursor | ||
| * eraseLineBefore(): erase current line before the cursor | ||
| * eraseLine(): erase current line | ||
| * alternateScreenBuffer(boolean): this set/unset the alternate screen buffer, many terminal do not support it or inhibit it | ||
| ### Input/Output | ||
| * requestCursorLocation(): request the cursor location, a 'terminal' event will be fired when available | ||
| * requestScreenSize(): request for screen size, a 'terminal' event will be fired when available (rarely useful, most of time this event is fired on resize) | ||
| * applicationKeypad(): should allow keypad to send different code than 0..9 keys, not widely supported | ||
| ### Internal input/output (do not use directly, use grabInput() instead) | ||
| * mouseButton(): ask the terminal to send event when a mouse button is pressed, with the mouse cursor position | ||
| * mouseDrag(): ask the terminal to send event when a mouse button is pressed and when draging, with the mouse cursor position | ||
| * mouseMotion(): ask the terminal to send all mouse event, even mouse motion that occurs without buttons | ||
| * mouseSGR: another mouse protocol that extend coordinate mapping (without it, it supports only 223 rows and columns) | ||
| * focusEvent: ask the terminal to send event when it gains and loses focus, not widely supported | ||
| ### OS functions (not widely supported) | ||
| windowTitle(): set the title of an xterm-compatible window | ||
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.45%
318432
- Number of lines in readme file
- increased by644.44%
134
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes