diff options
author | Michaël Zasso <targos@protonmail.com> | 2017-12-22 16:53:42 +0100 |
---|---|---|
committer | Michaël Zasso <targos@protonmail.com> | 2018-01-11 09:48:05 +0100 |
commit | 3dc30632755713179f345f4af024bd904c6162d0 (patch) | |
tree | f28c4f6dd6dfc5992edf301449d1a371d229755b /tools/node_modules/eslint/node_modules/cli-width/README.md | |
parent | a2c7085dd4a8e60d1a47572aca8bb6fcb7a32f88 (diff) | |
download | android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.gz android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.bz2 android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.zip |
tools: move eslint from tools to tools/node_modules
This is required because we need to add the babel-eslint dependency
and it has to be able to resolve "eslint".
babel-eslint is required to support future ES features such as async
iterators and import.meta.
Refs: https://github.com/nodejs/node/pull/17755
PR-URL: https://github.com/nodejs/node/pull/17820
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'tools/node_modules/eslint/node_modules/cli-width/README.md')
-rw-r--r-- | tools/node_modules/eslint/node_modules/cli-width/README.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/cli-width/README.md b/tools/node_modules/eslint/node_modules/cli-width/README.md new file mode 100644 index 0000000000..b7157ea528 --- /dev/null +++ b/tools/node_modules/eslint/node_modules/cli-width/README.md @@ -0,0 +1,72 @@ +cli-width +========= + +Get stdout window width, with four fallbacks, `tty`, `output.columns`, a custom environment variable and then a default. + +[![npm version](https://badge.fury.io/js/cli-width.svg)](http://badge.fury.io/js/cli-width) +[![Build Status](https://travis-ci.org/knownasilya/cli-width.svg)](https://travis-ci.org/knownasilya/cli-width) +[![Coverage Status](https://coveralls.io/repos/knownasilya/cli-width/badge.svg?branch=master&service=github)](https://coveralls.io/github/knownasilya/cli-width?branch=master) + +## Usage + +``` +npm install --save cli-width +``` + +```js +'use strict'; + +var cliWidth = require('cli-width'); + +cliWidth(); // maybe 204 :) +``` + +You can also set the `CLI_WIDTH` environment variable. + +If none of the methods are supported, and the environment variable isn't set, +the default width value is going to be `0`, that can be changed using the configurable `options`. + +## API + +### cliWidth([options]) + +`cliWidth` can be configured using an `options` parameter, the possible properties are: + +- **defaultWidth**\<number\> Defines a default value to be used if none of the methods are available, defaults to `0` +- **output**\<object\> A stream to be used to read width values from, defaults to `process.stdout` +- **tty**\<object\> TTY module to try to read width from as a fallback, defaults to `require('tty')` + + +### Examples + +Defining both a default width value and a stream output to try to read from: + +```js +var cliWidth = require('cli-width'); +var ttys = require('ttys'); + +cliWidth({ + defaultWidth: 80, + output: ttys.output +}); +``` + +Defines a different tty module to read width from: + +```js +var cliWidth = require('cli-width'); +var ttys = require('ttys'); + +cliWidth({ + tty: ttys +}); +``` + +## Tests + +```bash +npm install +npm test +``` + +Coverage can be generated with `npm run coverage`. |