├── .editorconfig ├── .gitattributes ├── .github ├── funding.yml ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: sindresorhus 2 | open_collective: sindresorhus 3 | tidelift: npm/widest-line 4 | custom: https://sindresorhus.com/donate 5 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Get the visual width of the widest line in a string - the number of columns required to display it. 3 | 4 | @example 5 | ``` 6 | import widestLine from 'widest-line'; 7 | 8 | widestLine('古\n\u001B[1m@\u001B[22m'); 9 | //=> 2 10 | ``` 11 | */ 12 | export default function widestLine(string: string): number; 13 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import stringWidth from 'string-width'; 2 | 3 | export default function widestLine(string) { 4 | let lineWidth = 0; 5 | 6 | for (const line of string.split('\n')) { 7 | lineWidth = Math.max(lineWidth, stringWidth(line)); 8 | } 9 | 10 | return lineWidth; 11 | } 12 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import widestLine from './index.js'; 3 | 4 | expectType(widestLine('古\n\u001B[1m@\u001B[22m')); 5 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "widest-line", 3 | "version": "5.0.0", 4 | "description": "Get the visual width of the widest line in a string - the number of columns required to display it", 5 | "license": "MIT", 6 | "repository": "sindresorhus/widest-line", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": { 15 | "types": "./index.d.ts", 16 | "default": "./index.js" 17 | }, 18 | "engines": { 19 | "node": ">=18" 20 | }, 21 | "scripts": { 22 | "test": "xo && ava && tsd" 23 | }, 24 | "files": [ 25 | "index.js", 26 | "index.d.ts" 27 | ], 28 | "keywords": [ 29 | "string", 30 | "character", 31 | "unicode", 32 | "width", 33 | "visual", 34 | "column", 35 | "columns", 36 | "fullwidth", 37 | "full-width", 38 | "full", 39 | "ansi", 40 | "escape", 41 | "codes", 42 | "cli", 43 | "command-line", 44 | "terminal", 45 | "console", 46 | "cjk", 47 | "chinese", 48 | "japanese", 49 | "korean", 50 | "fixed-width" 51 | ], 52 | "dependencies": { 53 | "string-width": "^7.0.0" 54 | }, 55 | "devDependencies": { 56 | "ava": "^5.3.1", 57 | "tsd": "^0.29.0", 58 | "xo": "^0.56.0" 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # widest-line 2 | 3 | > Get the visual width of the widest line in a string - the number of columns required to display it 4 | 5 | Some Unicode characters are [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) and use double the normal width. [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code) are stripped and doesn't affect the width. 6 | 7 | Useful to be able to know the maximum width a string will take up in the terminal. 8 | 9 | ## Install 10 | 11 | ```sh 12 | npm install widest-line 13 | ``` 14 | 15 | ## Usage 16 | 17 | ```js 18 | import widestLine from 'widest-line'; 19 | 20 | widestLine('古\n\u001B[1m@\u001B[22m'); 21 | //=> 2 22 | ``` 23 | 24 | ## Related 25 | 26 | - [string-width](https://github.com/sindresorhus/string-width) - Get the visual width of a string 27 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import widestLine from './index.js'; 3 | 4 | test('main', t => { 5 | t.is(widestLine('a'), 1); 6 | t.is(widestLine('a\nbe'), 2); 7 | t.is(widestLine('古\n\u001B[1m@\u001B[22m'), 2); 8 | }); 9 | --------------------------------------------------------------------------------