cli-width
Advanced tools
Package description
The cli-width package is a simple utility that allows you to retrieve the current width of the command line interface (CLI) in which your node.js application is running. It is useful for creating CLI tools that need to format output according to the width of the terminal window.
Get CLI width
This feature allows you to get the current width of the CLI. The function returns a number representing the number of columns in the terminal, or a default value if it can't be determined.
const cliWidth = require('cli-width');
console.log(cliWidth());Set default width
This feature allows you to set a default width that cli-width will return if it cannot determine the actual width of the terminal. This is useful for ensuring your application has a fallback width to use for formatting output.
const cliWidth = require('cli-width');
cliWidth.defaultWidth = 100;
console.log(cliWidth());The window-size package is similar to cli-width in that it provides the dimensions of the terminal window. However, window-size offers both width and height properties, and it can also provide dimensions based on environment variables or stdout/stderr dimensions.
Term-size is another package that offers similar functionality to cli-width. It provides the size of the terminal as an object with 'columns' and 'rows'. Unlike cli-width, term-size uses a native addon to retrieve terminal dimensions, which may offer more accurate results in some environments.
Readme
Get stdout window width, with three fallbacks, tty, a custom environment variable and then a default.
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 is 0 and can be changed via cliWidth.defaultWidth = 200;.
npm install
npm test
Coverage can be generated with npm run coverage.
FAQs
Get stdout window width, with two fallbacks, tty and then a default.
The npm package cli-width receives a total of 23,099,790 weekly downloads. As such, cli-width popularity was classified as popular.
We found that cli-width demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.