summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/ansi-escapes/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/node_modules/ansi-escapes/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/ansi-escapes/readme.md62
1 files changed, 57 insertions, 5 deletions
diff --git a/tools/node_modules/eslint/node_modules/ansi-escapes/readme.md b/tools/node_modules/eslint/node_modules/ansi-escapes/readme.md
index b290753094..818a9263f4 100644
--- a/tools/node_modules/eslint/node_modules/ansi-escapes/readme.md
+++ b/tools/node_modules/eslint/node_modules/ansi-escapes/readme.md
@@ -2,14 +2,12 @@
> [ANSI escape codes](http://www.termsys.demon.co.uk/vtansi.htm) for manipulating the terminal
-
## Install
```
$ npm install ansi-escapes
```
-
## Usage
```js
@@ -20,7 +18,6 @@ process.stdout.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);
//=> '\u001B[2A\u001B[1000D'
```
-
## API
### cursorTo(x, y?)
@@ -165,16 +162,71 @@ The width and height are given as a number followed by a unit, or the word "auto
##### preserveAspectRatio
-Type: `boolean`<br>
+Type: `boolean`\
Default: `true`
### iTerm.setCwd(path?)
-Type: `string`<br>
+Type: `string`\
Default: `process.cwd()`
[Inform iTerm2](https://www.iterm2.com/documentation-escape-codes.html) of the current directory to help semantic history and enable [Cmd-clicking relative paths](https://coderwall.com/p/b7e82q/quickly-open-files-in-iterm-with-cmd-click).
+### iTerm.annotation(message, options?)
+
+Creates an escape code to display an "annotation" in iTerm2.
+
+An annotation looks like this when shown:
+
+<img src="https://user-images.githubusercontent.com/924465/64382136-b60ac700-cfe9-11e9-8a35-9682e8dc4b72.png" width="500">
+
+See the [iTerm Proprietary Escape Codes documentation](https://iterm2.com/documentation-escape-codes.html) for more information.
+
+#### message
+
+Type: `string`
+
+The message to display within the annotation.
+
+The `|` character is disallowed and will be stripped.
+
+#### options
+
+Type: `object`
+
+##### length
+
+Type: `number`\
+Default: The remainder of the line
+
+Nonzero number of columns to annotate.
+
+##### x
+
+Type: `number`\
+Default: Cursor position
+
+Starting X coordinate.
+
+Must be used with `y` and `length`.
+
+##### y
+
+Type: `number`\
+Default: Cursor position
+
+Starting Y coordinate.
+
+Must be used with `x` and `length`.
+
+##### isHidden
+
+Type: `boolean`\
+Default: `false`
+
+Create a "hidden" annotation.
+
+Annotations created this way can be shown using the "Show Annotations" iTerm command.
## Related