node/tools/eslint/node_modules/cli-width/README.md
Rich Trott 7268bb1847 tools: update ESLint to version 2.1.0
Update ESLint to 2.1.0. ESLint has a number of potentially-useful new
features but this change attempts to be minimal in its changes.
However, some things could not be avoided reasonably.

ESLint 2.1.0 found a few lint issues that ESLing 1.x missed with
template strings that did not take advantage of any features of
template strings, and `let` declarations where `const` sufficed.

Additionally, ESLint 2.1.0 removes some granularity around enabling ES6
features. Some features (e.g., spread operator) that had been turned off
in our configuration for ESLint 1.x are now permitted.

PR-URL: https://github.com/nodejs/node/pull/5214
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: jbergstroem - Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-03-02 14:01:11 -08:00

1.8 KiB

cli-width

Get stdout window width, with four fallbacks, tty, output.columns, a custom environment variable and then a default.

npm version Build Status Coverage Status

Usage

npm install --save cli-width
'use stict';

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:

var cliWidth = require('cli-width');
var ttys = require('ttys');

cliWidth({
  defaultWidth: 80,
  output: ttys.output
});

Defines a different tty module to read width from:

var cliWidth = require('cli-width');
var ttys = require('ttys');

cliWidth({
  tty: ttys
});

Tests

npm install
npm test

Coverage can be generated with npm run coverage.