{"_id":"clorox","_rev":"222356","name":"clorox","description":"Node.js library for colorizing text using ANSI escape sequences.","dist-tags":{"latest":"2.2.0"},"maintainers":[{"name":"npm","email":""}],"time":{"modified":"2021-06-03T15:40:45.000Z","created":"2017-10-12T11:56:39.072Z","2.2.0":"2018-07-13T10:04:38.031Z","2.1.0":"2018-07-12T02:39:02.963Z","2.0.1":"2018-07-11T17:17:37.762Z","2.0.0":"2018-07-11T17:13:35.283Z","1.0.3":"2018-03-05T04:54:36.717Z","1.0.2":"2018-02-27T09:00:21.204Z","1.0.1":"2017-10-12T16:56:52.478Z","1.0.0":"2017-10-12T11:56:39.072Z"},"users":{},"author":{"name":"Jorge Bucaran"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"versions":{"2.2.0":{"name":"clorox","version":"2.2.0","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov tape test/*.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js"],"keywords":["clorox","color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^12.0.2","tape":"^4.9.1"},"gitHead":"cbd8086b6d98fa849c50f4c78802ea9a083be5ff","_id":"clorox@2.2.0","_npmVersion":"5.5.1","_nodeVersion":"8.9.0","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"4422de98c60d15f2c2894e3f3cecee8919d62ef3","size":3206,"noattachment":false,"key":"/clorox/-/clorox-2.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-2.2.0.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_2.2.0_1531476277944_0.5543899158009722"},"_hasShrinkwrap":false,"publish_time":1531476278031,"_cnpm_publish_time":1531476278031,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"2.1.0":{"name":"clorox","version":"2.1.0","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov tape test/*.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js"],"keywords":["clorox","color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^12.0.2","tape":"^4.9.1"},"gitHead":"32de3d7f316cfce3d48fdefcb30e30ff10adfd4e","_id":"clorox@2.1.0","_npmVersion":"5.5.1","_nodeVersion":"8.9.0","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"9619783cf0230dcd1e33555fa5058f97d6bca593","size":3079,"noattachment":false,"key":"/clorox/-/clorox-2.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-2.1.0.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_2.1.0_1531363142907_0.007795009565353173"},"_hasShrinkwrap":false,"publish_time":1531363142963,"_cnpm_publish_time":1531363142963,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"2.0.1":{"name":"clorox","version":"2.0.1","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov tape test/*.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js"],"keywords":["clorox","color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^12.0.2","tape":"^4.9.1"},"gitHead":"b7ad528912c50cac00259f63dd2e65e5e5daef43","_id":"clorox@2.0.1","_npmVersion":"6.1.0","_nodeVersion":"10.0.0","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"537b81dc5bbdefb117c1c51a04b2c0c2c6d34103","size":2784,"noattachment":false,"key":"/clorox/-/clorox-2.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-2.0.1.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_2.0.1_1531329457680_0.8788375756652664"},"_hasShrinkwrap":false,"publish_time":1531329457762,"_cnpm_publish_time":1531329457762,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"2.0.0":{"name":"clorox","version":"2.0.0","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov tape test/*.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js"],"keywords":["clorox","color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^12.0.2","tape":"^4.9.1"},"gitHead":"4646456f6e5079cb736916dcf20bc5df97a4fb6c","_id":"clorox@2.0.0","_npmVersion":"6.1.0","_nodeVersion":"10.0.0","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"07ccc8828f6a15f2aab34ffa6ff52b88e67d5355","size":2784,"noattachment":false,"key":"/clorox/-/clorox-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-2.0.0.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_2.0.0_1531329215208_0.028422633019887122"},"_hasShrinkwrap":false,"publish_time":1531329215283,"_cnpm_publish_time":1531329215283,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"1.0.3":{"name":"clorox","version":"1.0.3","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov node test.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js","ansi.js"],"keywords":["color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^11.4.1"},"gitHead":"549a79324af5e87f968e7a6591daef83c67037b3","_id":"clorox@1.0.3","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"6fa63653f280c33d69f548fb14d239ddcfa1590d","size":2655,"noattachment":false,"key":"/clorox/-/clorox-1.0.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-1.0.3.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_1.0.3_1520225676662_0.5847649686750058"},"_hasShrinkwrap":false,"publish_time":1520225676717,"_cnpm_publish_time":1520225676717,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"1.0.2":{"name":"clorox","version":"1.0.2","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc -r lcov node test.js && nyc report","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/jorgebucaran/clorox.git"},"files":["index.js","ansi.js"],"keywords":["color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"homepage":"https://github.com/jorgebucaran/clorox","devDependencies":{"nyc":"^11.4.1"},"gitHead":"e48fe3b225baee3162f985b5a53c7392c96ff7b6","_id":"clorox@1.0.2","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"jorgebucaran","email":"mail@jorgebucaran.com"},"dist":{"shasum":"f89dbaba26046f7327dfabc2dd97e76af91d742d","size":2667,"noattachment":false,"key":"/clorox/-/clorox-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-1.0.2.tgz"},"maintainers":[{"name":"npm","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox_1.0.2_1519722021155_0.8140050152716374"},"_hasShrinkwrap":false,"publish_time":1519722021204,"_cnpm_publish_time":1519722021204,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"1.0.1":{"name":"clorox","version":"1.0.1","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc node test.js && nyc report --reporter=text-lcov > coverage/coverage.lcov","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push origin master && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/JorgeBucaran/clorox.git"},"files":["index.js","ansi.js"],"keywords":["color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/JorgeBucaran/clorox/issues"},"homepage":"https://github.com/JorgeBucaran/clorox","devDependencies":{"nyc":"^11.2.1"},"gitHead":"d09a0313a7c7f8b9eb32078601af7a11192acb25","_id":"clorox@1.0.1","_npmVersion":"5.3.0","_nodeVersion":"8.5.0","_npmUser":{"name":"jorgebucaran","email":"jbucaran@gmail.com"},"dist":{"shasum":"a68773a44cc0857ed64b7a63aa49f5f0cae9ffed","size":2700,"noattachment":false,"key":"/clorox/-/clorox-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-1.0.1.tgz"},"maintainers":[{"name":"npm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox-1.0.1.tgz_1507827412405_0.7853056609164923"},"directories":{},"publish_time":1507827412478,"_hasShrinkwrap":false,"_cnpm_publish_time":1507827412478,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"},"1.0.0":{"name":"clorox","version":"1.0.0","description":"Node.js library for colorizing text using ANSI escape sequences.","main":"index.js","scripts":{"test":"nyc node test.js && nyc report --reporter=text-lcov > coverage/coverage.lcov","release":"npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/JorgeBucaran/clorox.git"},"files":["index.js","ansi.js"],"keywords":["color","terminal","cli","ansi"],"author":{"name":"Jorge Bucaran"},"license":"MIT","bugs":{"url":"https://github.com/JorgeBucaran/clorox/issues"},"homepage":"https://github.com/JorgeBucaran/clorox","devDependencies":{"nyc":"^11.2.1"},"gitHead":"b7603a8a33e3805d1ef662f184d715cbf8a4593b","_id":"clorox@1.0.0","_npmVersion":"5.3.0","_nodeVersion":"8.5.0","_npmUser":{"name":"jorgebucaran","email":"jbucaran@gmail.com"},"dist":{"shasum":"0cd2b46ac3728d670895a0e0ff7e37f2eadb0d68","size":2689,"noattachment":false,"key":"/clorox/-/clorox-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/clorox/download/clorox-1.0.0.tgz"},"maintainers":[{"name":"npm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/clorox-1.0.0.tgz_1507809398931_0.2436912595294416"},"directories":{},"publish_time":1507809399072,"_hasShrinkwrap":false,"_cnpm_publish_time":1507809399072,"deprecated":"Clorox is now Turbocolor!! - Please upgrade <3 'npm i turbocolor'"}},"readme":"# Clorox\n\n[![](http://img.shields.io/travis/jorgebucaran/clorox.svg)](https://travis-ci.org/jorgebucaran/clorox)\n[![Codecov](https://img.shields.io/codecov/c/github/jorgebucaran/clorox/master.svg)](https://codecov.io/gh/jorgebucaran/clorox)\n[![](https://img.shields.io/npm/v/clorox.svg)](https://www.npmjs.org/package/clorox)\n\nClorox is a Node.js library for colorizing text using [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code).\n\n- **All-in-one** — Not broken into a dozen modules that only work together.\n- **Eco-friendly** — No modifications were made to the [String.prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/prototype) in the making of this package.\n- **It Just Works™** — Auto-detects color support and [degrades gracefully](https://en.wikipedia.org/wiki/Fault_tolerance) without contaminating your terminal with broken escape codes.\n\n## Installation\n\n<pre>\nnpm i <a href=\"https://www.npmjs.com/package/clorox\">clorox</a>\n</pre>\n\n## Usage\n\n```jsx\nconst { Clorox: x } = require(\"clorox\")\n```\n\nWrite with color.\n\n```jsx\nconsole.log(x.red(\"Bonjour!\"))\n```\n\nChain expressions.\n\n```jsx\nconsole.log(x.red.underline(\"Hello\") + x.blue.bold(\"World\") + \"!\")\n```\n\nCompose a color expression using [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals).\n\n```jsx\nconsole.log(`\n  Oil: ${x.bgBlack.white(42)}\n  Gold: ${x.yellow(150)}\n  Lumber: ${x.green(10000)}\n`)\n```\n\nNest expressions to reuse styles.\n\n```jsx\nconsole.log(`Normal ${x.bold(`Bold ${x.blue(\"Bold/Blue\")} Bold`)} Normal`)\n```\n\nUse [string substitution](https://nodejs.org/api/console.html#console_console_log_data_args) for easier formatting.\n\n```jsx\nconsole.log(x.green(\"Total: $%f\"), 1.99)\n```\n\n## Styles\n\nClorox exports ANSI escape codes which you can use for manually styling console output. They can be useful for testing your actual output matches the expected output.\n\nEach [style](#available-styles) has an `open`, `close` and `strip` property. The `strip` property is useful for removing the previously closed escape code within a nested expression.\n\n```jsx\nconst { STYLES } = require(\"clorox\")\n\nconsole.log(`${STYLES.red.open}Red${STYLES.red.close}`)\n```\n\n### Available Styles\n\n| Colors  | Background Colors | Modifiers         |\n| ------- | ----------------- | ----------------- |\n| black   | bgBlack           | dim               |\n| red     | bgRed             | **bold**          |\n| green   | bgGreen           | hidden            |\n| yellow  | bgYellow          | _italic_          |\n| blue    | bgBlue            | underline         |\n| magenta | bgMagenta         | inverse           |\n| cyan    | bgCyan            | ~~strikethrough~~ |\n| white   | bgWhite           | reset             |\n| gray    |                   |                   |\n\n## License\n\nClorox is MIT licensed. See [LICENSE](LICENSE.md).\n","_attachments":{},"homepage":"https://github.com/jorgebucaran/clorox","bugs":{"url":"https://github.com/jorgebucaran/clorox/issues"},"license":"MIT"}