{ "manifest": { "name": "renderkid", "version": "3.0.0", "description": "Stylish console.log for node", "main": "lib/RenderKid.js", "dependencies": { "css-select": "^4.1.3", "dom-converter": "^0.2.0", "htmlparser2": "^6.1.0", "lodash": "^4.17.21", "strip-ansi": "^6.0.1" }, "devDependencies": { "@babel/core": "^7.14.5", "@babel/preset-env": "^7.14.5", "chai": "^4.3.4", "chai-changes": "^1.3.6", "chai-fuzzy": "^1.6.1", "coffeescript": "^2.5.1", "mocha": "^9.1.3", "sinon": "^11.1.1", "sinon-chai": "^3.7.0" }, "scripts": { "test": "mocha \"test/**/*.coffee\"", "test:watch": "npm run test -- --watch", "compile": "coffee --bare --transpile --output ./lib ./src", "compile:watch": "coffee --watch --bare --transpile --output ./lib ./src", "watch": "npm run compile:watch & npm run test:watch", "prepublish": "npm run compile" }, "repository": { "type": "git", "url": "https://github.com/AriaMinaei/RenderKid.git" }, "bugs": { "url": "https://github.com/AriaMinaei/RenderKid/issues" }, "author": { "name": "Aria Minaei" }, "license": "MIT", "_registry": "npm", "_loc": "/homez.1033/heliovt/.cache/yarn/v6/npm-renderkid-3.0.0-5fd823e4d6951d37358ecc9a58b1f06836b6268a-integrity/node_modules/renderkid/package.json", "readmeFilename": "README.md", "readme": "# RenderKid\n[![Build Status](https://secure.travis-ci.org/AriaMinaei/RenderKid.png)](http://travis-ci.org/AriaMinaei/RenderKid)\n\nRenderKid allows you to use HTML and CSS to style your CLI output, making it easy to create a beautiful, readable, and consistent look for your nodejs tool.\n\n## Installation\n\nInstall with npm:\n```\n$ npm install renderkid\n```\n\n## Usage\n\n```coffeescript\nRenderKid = require('renderkid')\n\nr = new RenderKid()\n\nr.style({\n \"ul\": {\n display: \"block\"\n margin: \"2 0 2\"\n }\n\n \"li\": {\n display: \"block\"\n marginBottom: \"1\"\n }\n\n \"key\": {\n color: \"grey\"\n marginRight: \"1\"\n }\n\n \"value\": {\n color: \"bright-white\"\n }\n})\n\noutput = r.render(\"\n\n\")\n\nconsole.log(output)\n```\n\n![screenshot of usage](https://github.com/AriaMinaei/RenderKid/raw/master/docs/images/usage.png)\n\n## Stylesheet properties\n\n### Display mode\n\nElements can have a `display` of either `inline`, `block`, or `none`:\n```coffeescript\nr.style({\n \"div\": {\n display: \"block\"\n }\n\n \"span\": {\n display: \"inline\" # default\n }\n\n \"hidden\": {\n display: \"none\"\n }\n})\n\noutput = r.render(\"\n
This will fill one or more rows.
\nThese will be in the same line.\nThis won't be displayed.\n\")\n\nconsole.log(output)\n```\n\n![screenshot of usage](https://github.com/AriaMinaei/RenderKid/raw/master/docs/images/display.png)\n\n\n### Margin\n\nMargins work just like they do in browsers:\n```coffeescript\nr.style({\n \"li\": {\n display: \"block\"\n\n marginTop: \"1\"\n marginRight: \"2\"\n marginBottom: \"3\"\n marginLeft: \"4\"\n\n # or the shorthand version:\n \"margin\": \"1 2 3 4\"\n },\n\n \"highlight\": {\n display: \"inline\"\n marginLeft: \"2\"\n marginRight: \"2\"\n }\n})\n\nr.render(\"\n\n\")\n```\n\n### Padding\n\nSee margins above. Paddings work the same way, only inward.\n\n### Width and Height\n\nBlock elements can have explicit width and height:\n```coffeescript\nr.style({\n \"box\": {\n display: \"block\"\n \"width\": \"4\"\n \"height\": \"2\"\n }\n})\n\nr.render(\"This is a box and some of its text will be truncated.\")\n```\n\n### Colors\n\nYou can set a custom color and background color for each element:\n\n```coffeescript\nr.style({\n \"error\": {\n color: \"black\"\n background: \"red\"\n }\n})\n```\n\nList of colors currently supported are `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `grey`, `bright-red`, `bright-green`, `bright-yellow`, `bright-blue`, `bright-magenta`, `bright-cyan`, `bright-white`.\n\n### Bullet points\n\nBlock elements can have bullet points on their margins. Let's start with an example:\n```coffeescript\nr.style({\n \"li\": {\n # To add bullet points to an element, first you\n # should make some room for the bullet point by\n # giving your element some margin to the left:\n marginLeft: \"4\",\n\n # Now we can add a bullet point to our margin:\n bullet: '\"-\"'\n }\n})\n\n# The four hyphens are there for visual reference\nr.render(\"\n----\n
  • Item 1
    • \n
  • Item 2
    • \n
  • Item 3
    • \n----\n\")\n```\nAnd here is the result:\n\n![screenshot of bullet points, 1](https://github.com/AriaMinaei/RenderKid/raw/master/docs/images/bullets-1.png)\n", "licenseText": "The MIT License (MIT)\n\nCopyright (c) 2015 Aria Minaei\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n" }, "artifacts": [], "remote": { "resolved": "https://registry.yarnpkg.com/renderkid/-/renderkid-3.0.0.tgz#5fd823e4d6951d37358ecc9a58b1f06836b6268a", "type": "tarball", "reference": "https://registry.yarnpkg.com/renderkid/-/renderkid-3.0.0.tgz", "hash": "5fd823e4d6951d37358ecc9a58b1f06836b6268a", "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", "registry": "npm", "packageName": "renderkid", "cacheIntegrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg== sha1-X9gj5NaVHTc1jsyaWLHwaDa2Joo=" }, "registry": "npm", "hash": "5fd823e4d6951d37358ecc9a58b1f06836b6268a" }