UNPKG

@zkochan/pnpm

Version:

Fast, disk space efficient package manager

117 lines (116 loc) 6.09 kB
{ "_args": [ [ { "raw": "boxen@^1.2.1", "scope": null, "escapedName": "boxen", "name": "boxen", "rawSpec": "^1.2.1", "spec": ">=1.2.1 <2.0.0", "type": "range" }, "/home/zkochan/src/pnpm/packages/pnpm/node_modules/update-notifier" ] ], "_from": "boxen@>=1.2.1 <2.0.0", "_id": "boxen@1.3.0", "_inCache": true, "_location": "/boxen", "_nodeVersion": "8.9.0", "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/boxen-1.3.0.tgz_1512091816286_0.3364733885973692" }, "_npmUser": { "name": "sindresorhus", "email": "sindresorhus@gmail.com" }, "_npmVersion": "5.5.1", "_phantomChildren": {}, "_requested": { "raw": "boxen@^1.2.1", "scope": null, "escapedName": "boxen", "name": "boxen", "rawSpec": "^1.2.1", "spec": ">=1.2.1 <2.0.0", "type": "range" }, "_requiredBy": [ "/update-notifier" ], "_resolved": "https://registry.npmjs.org/boxen/-/boxen-1.3.0.tgz", "_shasum": "55c6c39a8ba58d9c61ad22cd877532deb665a20b", "_shrinkwrap": null, "_spec": "boxen@^1.2.1", "_where": "/home/zkochan/src/pnpm/packages/pnpm/node_modules/update-notifier", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "sindresorhus.com" }, "bugs": { "url": "https://github.com/sindresorhus/boxen/issues" }, "dependencies": { "ansi-align": "^2.0.0", "camelcase": "^4.0.0", "chalk": "^2.0.1", "cli-boxes": "^1.0.0", "string-width": "^2.0.0", "term-size": "^1.2.0", "widest-line": "^2.0.0" }, "description": "Create boxes in the terminal", "devDependencies": { "ava": "*", "nyc": "^11.0.3", "xo": "*" }, "directories": {}, "dist": { "integrity": "sha512-TNPjfTr432qx7yOjQyaXm3dSR0MH9vXp7eT1BFSl/C51g+EFnOR9hTg1IreahGBmDNCehscshe45f+C1TBZbLw==", "shasum": "55c6c39a8ba58d9c61ad22cd877532deb665a20b", "tarball": "https://registry.npmjs.org/boxen/-/boxen-1.3.0.tgz" }, "engines": { "node": ">=4" }, "files": [ "index.js" ], "gitHead": "f968a18b60af6aa05ca1ab572f7b50cb4310d013", "homepage": "https://github.com/sindresorhus/boxen#readme", "keywords": [ "cli", "box", "boxes", "terminal", "term", "console", "ascii", "unicode", "border", "text" ], "license": "MIT", "maintainers": [ { "name": "sindresorhus", "email": "sindresorhus@gmail.com" } ], "name": "boxen", "optionalDependencies": {}, "readme": "# <img src=\"screenshot.png\" width=\"400\" alt=\"boxen\">\n\n> Create boxes in the terminal\n\n[![Build Status](https://travis-ci.org/sindresorhus/boxen.svg?branch=master)](https://travis-ci.org/sindresorhus/boxen)\n\n\n## Install\n\n```\n$ npm install boxen\n```\n\n\n## Usage\n\n```js\nconst boxen = require('boxen');\n\nconsole.log(boxen('unicorn', {padding: 1}));\n/*\n┌─────────────┐\n│ │\n│ unicorn │\n│ │\n└─────────────┘\n*/\n\nconsole.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));\n/*\n\n ╔═════════════╗\n ║ ║\n ║ unicorn ║\n ║ ║\n ╚═════════════╝\n\n*/\n```\n\n\n## API\n\n### boxen(input, [options])\n\n#### input\n\nType: `string`\n\nText inside the box.\n\n#### options\n\n##### borderColor\n\nType: `string`<br>\nValues: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray`\n\nColor of the box border.\n\n##### borderStyle\n\nType: `string` `object`<br>\nDefault: `single`<br>\nValues:\n- `single`\n```\n┌───┐\n│foo│\n└───┘\n```\n- `double`\n```\n╔═══╗\n║foo║\n╚═══╝\n```\n- `round` (`single` sides with round corners)\n```\n╭───╮\n│foo│\n╰───╯\n```\n- `single-double` (`single` on top and bottom, `double` on right and left)\n```\n╓───╖\n║foo║\n╙───╜\n```\n- `double-single` (`double` on top and bottom, `single` on right and left)\n```\n╒═══╕\n│foo│\n╘═══╛\n```\n- `classic`\n```\n+---+\n|foo|\n+---+\n```\n\nStyle of the box border.\n\nCan be any of the above predefined styles or an object with the following keys:\n\n```js\n{\n\ttopLeft: '+',\n\ttopRight: '+',\n\tbottomLeft: '+',\n\tbottomRight: '+',\n\thorizontal: '-',\n\tvertical: '|'\n}\n```\n\n##### dimBorder\n\nType: `boolean`<br>\nDefault: `false`\n\nReduce opacity of the border.\n\n##### padding\n\nType: `number` `Object`<br>\nDefault: `0`\n\nSpace between the text and box border.\n\nAccepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right padding is 3 times the top/bottom to make it look nice.\n\n##### margin\n\nType: `number` `Object`<br>\nDefault: `0`\n\nSpace around the box.\n\nAccepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right margin is 3 times the top/bottom to make it look nice.\n\n##### float\n\nType: `string`<br>\nValues: `right` `center` `left`<br>\nDefault: `left`\n\nFloat the box on the available terminal screen space.\n\n##### backgroundColor\n\nType: `string`<br>\nValues: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white`\n\nColor of the background.\n\n##### align\n\nType: `string`<br>\nDefault: `left`<br>\nValues: `left` `center` `right`\n\nAlign the text in the box based on the widest line.\n\n\n## Related\n\n- [boxen-cli](https://github.com/sindresorhus/boxen-cli) - CLI for this module\n- [cli-boxes](https://github.com/sindresorhus/cli-boxes) - Boxes for use in the terminal\n\n\n## License\n\nMIT © [Sindre Sorhus](https://sindresorhus.com)\n", "readmeFilename": "readme.md", "repository": { "type": "git", "url": "git+https://github.com/sindresorhus/boxen.git" }, "scripts": { "test": "xo && nyc ava" }, "version": "1.3.0" }