{
"_from": "cli-table3@0.5.1",
"_id": "cli-table3@0.5.1",
"_inBundle": false,
"_integrity": "sha512-7Qg2Jrep1S/+Q3EceiZtQcDPWxhAvBw+ERf1162v4sikJrvojMHFqXt8QIVha8UlH9rgU0BeWPytZ9/TzYqlUw==",
"_location": "/npm/cli-table3",
"_phantomChildren": {},
"_requested": {
"escapedName": "cli-table3",
"fetchSpec": "0.5.1",
"name": "cli-table3",
"raw": "cli-table3@0.5.1",
"rawSpec": "0.5.1",
"registry": true,
"saveSpec": null,
"type": "version"
},
"_requiredBy": [
"#USER",
"/npm",
"/npm/npm-audit-report"
],
"_resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.5.1.tgz",
"_shasum": "0252372d94dfc40dbd8df06005f48f31f656f202",
"_shrinkwrap": null,
"_spec": "cli-table3@0.5.1",
"_where": "/Users/aeschright/code/cli",
"author": {
"name": "James Talmage"
},
"bugs": {
"url": "https://github.com/cli-table/cli-table3/issues"
},
"bundleDependencies": false,
"changelog": {
"labels": {
"breaking": ":boom: Breaking Change",
"bug": ":bug: Bug Fix",
"documentation": ":memo: Documentation",
"enhancement": ":rocket: Enhancement",
"internal": ":house: Internal"
},
"repo": "cli-table/cli-table3"
},
"dependencies": {
"colors": "^1.1.2",
"object-assign": "^4.1.0",
"string-width": "^2.1.1"
},
"deprecated": false,
"description": "Pretty unicode tables for the command line. Based on the original cli-table.",
"devDependencies": {
"ansi-256-colors": "^1.1.0",
"cli-table": "^0.3.1",
"eslint-config-prettier": "^2.9.0",
"eslint-plugin-prettier": "^2.6.0",
"jest": "^23.1.0",
"jest-runner-eslint": "^0.6.0",
"lerna-changelog": "^0.8.0",
"prettier": "1.13.7"
},
"directories": {
"test": "test"
},
"engines": {
"node": ">=6"
},
"files": [
"index.d.ts",
"index.js",
"src/"
],
"homepage": "https://github.com/cli-table/cli-table3",
"jest": {
"projects": [
{
"displayName": "test",
"testMatch": [
"**/test/**/*-test(s)?.js"
]
},
{
"runner": "jest-runner-eslint",
"displayName": "lint",
"testMatch": [
"<rootDir>/examples/**/*.js",
"<rootDir>/lib/**/*.js",
"<rootDir>/scripts/**/*.js",
"<rootDir>/src/**/*.js",
"<rootDir>/test/**/*.js"
]
}
]
},
"keywords": [
"cli",
"colors",
"command",
"grid",
"line",
"node",
"table",
"tables",
"tabular",
"unicode"
],
"license": "MIT",
"main": "index.js",
"name": "cli-table3",
"optionalDependencies": {
"colors": "^1.1.2"
},
"prettier": {
"printWidth": 120,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5"
},
"readme": "cli-table3 \n===============================================================================\n\n[](https://www.npmjs.com/package/cli-table3)\n[](https://travis-ci.com/cli-table/cli-table3)\n\nThis utility allows you to render unicode-aided tables on the command line from\nyour node.js scripts.\n\n`cli-table3` is based on (and api compatible with) the original [cli-table](https://github.com/Automattic/cli-table),\nand [cli-table2](https://github.com/jamestalmage/cli-table2), which are both\nunmaintained. `cli-table3` includes all the additional features from\n`cli-table2`.\n\n\n\n## Features not in the original cli-table\n\n- Ability to make cells span columns and/or rows.\n- Ability to set custom styles per cell (border characters/colors, padding, etc).\n- Vertical alignment (top, bottom, center).\n- Automatic word wrapping.\n- More robust truncation of cell text that contains ansi color characters.\n- Better handling of text color that spans multiple lines.\n- API compatible with the original cli-table.\n- Exhaustive test suite including the entire original cli-table test suite.\n- Lots of examples auto-generated from the tests ([basic](https://github.com/cli-table/cli-table3/blob/master/basic-usage.md), [advanced](https://github.com/cli-table/cli-table3/blob/master/advanced-usage.md)).\n\n## Features\n\n- Customizable characters that constitute the table.\n- Color/background styling in the header through\n [colors.js](http://github.com/marak/colors.js)\n- Column width customization\n- Text truncation based on predefined widths\n- Text alignment (left, right, center)\n- Padding (left, right)\n- Easy-to-use API\n\n## Installation\n\n```bash\nnpm install cli-table3\n```\n\n## How to use\n\nA portion of the unit test suite is used to generate examples:\n- [basic-usage](https://github.com/cli-table/cli-table3/blob/master/basic-usage.md) - covers basic uses.\n- [advanced](https://github.com/cli-table/cli-table3/blob/master/advanced-usage.md) - covers using the new column and row span features.\n\nThis package is api compatible with the original [cli-table](https://github.com/Automattic/cli-table).\nSo all the original documentation still applies (copied below).\n\n### Horizontal Tables\n```javascript\nvar Table = require('cli-table3');\n\n// instantiate\nvar table = new Table({\n head: ['TH 1 label', 'TH 2 label']\n , colWidths: [100, 200]\n});\n\n// table is an Array, so you can `push`, `unshift`, `splice` and friends\ntable.push(\n ['First value', 'Second value']\n , ['First value', 'Second value']\n);\n\nconsole.log(table.toString());\n```\n\n### Vertical Tables\n```javascript\nvar Table = require('cli-table3');\nvar table = new Table();\n\ntable.push(\n { 'Some key': 'Some value' }\n , { 'Another key': 'Another value' }\n);\n\nconsole.log(table.toString());\n```\n### Cross Tables\nCross tables are very similar to vertical tables, with two key differences:\n\n1. They require a `head` setting when instantiated that has an empty string as the first header\n2. The individual rows take the general form of { \"Header\": [\"Row\", \"Values\"] }\n\n```javascript\nvar Table = require('cli-table3');\nvar table = new Table({ head: [\"\", \"Top Header 1\", \"Top Header 2\"] });\n\ntable.push(\n { 'Left Header 1': ['Value Row 1 Col 1', 'Value Row 1 Col 2'] }\n , { 'Left Header 2': ['Value Row 2 Col 1', 'Value Row 2 Col 2'] }\n);\n\nconsole.log(table.toString());\n```\n\n### Custom styles\nThe ```chars``` property controls how the table is drawn:\n```javascript\nvar table = new Table({\n chars: { 'top': '═' , 'top-mid': '╤' , 'top-left': '╔' , 'top-right': '╗'\n , 'bottom': '═' , 'bottom-mid': '╧' , 'bottom-left': '╚' , 'bottom-right': '╝'\n , 'left': '║' , 'left-mid': '╟' , 'mid': '─' , 'mid-mid': '┼'\n , 'right': '║' , 'right-mid': '╢' , 'middle': '│' }\n});\n\ntable.push(\n ['foo', 'bar', 'baz']\n , ['frob', 'bar', 'quuz']\n);\n\nconsole.log(table.toString());\n// Outputs:\n//\n//╔══════╤═════╤══════╗\n//║ foo │ bar │ baz ║\n//╟──────┼─────┼──────╢\n//║ frob │ bar │ quuz ║\n//╚══════╧═════╧══════╝\n```\n\nEmpty decoration lines will be skipped, to avoid vertical separator rows just\nset the 'mid', 'left-mid', 'mid-mid', 'right-mid' to the empty string:\n```javascript\nvar table = new Table({ chars: {'mid': '', 'left-mid': '', 'mid-mid': '', 'right-mid': ''} });\ntable.push(\n ['foo', 'bar', 'baz']\n , ['frobnicate', 'bar', 'quuz']\n);\n\nconsole.log(table.toString());\n// Outputs: (note the lack of the horizontal line between rows)\n//┌────────────┬─────┬──────┐\n//│ foo │ bar │ baz │\n//│ frobnicate │ bar │ quuz │\n//└────────────┴─────┴──────┘\n```\n\nBy setting all chars to empty with the exception of 'middle' being set to a\nsingle space and by setting padding to zero, it's possible to get the most\ncompact layout with no decorations:\n```javascript\nvar table = new Table({\n chars: { 'top': '' , 'top-mid': '' , 'top-left': '' , 'top-right': ''\n , 'bottom': '' , 'bottom-mid': '' , 'bottom-left': '' , 'bottom-right': ''\n , 'left': '' , 'left-mid': '' , 'mid': '' , 'mid-mid': ''\n , 'right': '' , 'right-mid': '' , 'middle': ' ' },\n style: { 'padding-left': 0, 'padding-right': 0 }\n});\n\ntable.push(\n ['foo', 'bar', 'baz']\n , ['frobnicate', 'bar', 'quuz']\n);\n\nconsole.log(table.toString());\n// Outputs:\n//foo bar baz\n//frobnicate bar quuz\n```\n\n## Build Targets\n\nClone the repository and run `yarn install` to install all its submodules, then run one of the following commands:\n\n###### Run the tests with coverage reports.\n```bash\n$ yarn test:coverage\n```\n\n###### Run the tests every time a file changes.\n```bash\n$ yarn test:watch\n```\n\n###### Update the documentation.\n```bash\n$ yarn docs\n```\n\n## Credits\n\n- James Talmage - author <james.talmage@jrtechnical.com> ([jamestalmage](http://github.com/jamestalmage))\n- Guillermo Rauch - author of the original cli-table <guillermo@learnboost.com> ([Guille](http://github.com/guille))\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014 James Talmage <james.talmage@jrtechnical.com>\n\nOriginal cli-table code/documentation: Copyright (c) 2010 LearnBoost <dev@learnboost.com>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/cli-table/cli-table3.git"
},
"scripts": {
"changelog": "lerna-changelog",
"docs": "node ./scripts/update-docs.js",
"prettier": "prettier --write '{examples,lib,scripts,src,test}/**/*.js'",
"test": "jest --color",
"test:watch": "jest --color --watchAll --notify"
},
"types": "index.d.ts",
"version": "0.5.1"
}