{"id":20767739,"url":"https://github.com/dmnsgn/console-ansi","last_synced_at":"2025-04-30T11:20:41.933Z","repository":{"id":57205929,"uuid":"350507311","full_name":"dmnsgn/console-ansi","owner":"dmnsgn","description":"Easy console coloring and prefixing via Proxy object with ANSI strings.","archived":false,"fork":false,"pushed_at":"2024-07-06T13:30:29.000Z","size":880,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T21:22:11.380Z","etag":null,"topics":["ansi","ansi-colors","chalk","colors","console","prefix","proxy","symbol","theme"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmnsgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-22T22:25:51.000Z","updated_at":"2024-07-06T13:30:32.000Z","dependencies_parsed_at":"2024-07-06T14:57:45.951Z","dependency_job_id":null,"html_url":"https://github.com/dmnsgn/console-ansi","commit_stats":{"total_commits":27,"total_committers":1,"mean_commits":27.0,"dds":0.0,"last_synced_commit":"517588d58b86f64a138580813f4e3183377349a3"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fconsole-ansi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fconsole-ansi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fconsole-ansi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fconsole-ansi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmnsgn","download_url":"https://codeload.github.com/dmnsgn/console-ansi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251688994,"owners_count":21627812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi","ansi-colors","chalk","colors","console","prefix","proxy","symbol","theme"],"created_at":"2024-11-17T11:33:14.335Z","updated_at":"2025-04-30T11:20:41.879Z","avatar_url":"https://github.com/dmnsgn.png","language":"JavaScript","funding_links":["https://paypal.me/dmnsgn"],"categories":[],"sub_categories":[],"readme":"# console-ansi\n\n[![npm version](https://img.shields.io/npm/v/console-ansi)](https://www.npmjs.com/package/console-ansi)\n[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/console-ansi)\n[![npm minzipped size](https://img.shields.io/bundlephobia/minzip/console-ansi)](https://bundlephobia.com/package/console-ansi)\n[![dependencies](https://img.shields.io/librariesio/release/npm/console-ansi)](https://github.com/dmnsgn/console-ansi/blob/main/package.json)\n[![types](https://img.shields.io/npm/types/console-ansi)](https://github.com/microsoft/TypeScript)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org)\n[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)\n[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)\n[![license](https://img.shields.io/github/license/dmnsgn/console-ansi)](https://github.com/dmnsgn/console-ansi/blob/main/LICENSE.md)\n\nEasy console coloring and prefixing via Proxy object with ANSI strings. Works in Node.js and in browsers that support ANSI strings.\n\n[![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn)\n[![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)\n[![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn)\n\n![](https://raw.githubusercontent.com/dmnsgn/console-ansi/main/screenshot.jpg)\n\n## Installation\n\n```bash\nnpm install console-ansi\n```\n\n## Usage\n\n```js\nimport console, { styles } from \"console-ansi\";\n\n// Set prefix\nconsole.prefix = \"[test]\";\n\n// Call the console object methods as usual\nconsole.time(\"Test time\");\nconsole.log(\"Test log\");\nconsole.info(\"Test info\");\nconsole.warn(\"Test warn\");\nconsole.error(\"Test error\");\nconsole.timeEnd(\"Test time\");\n\n// Customise color\nconsole.theme.log = styles.blue;\nconsole.log(\"Test log blue\");\n\n// Remove symbols\nconsole.symbol = {};\n```\n\n## API\n\n\u003c!-- api-start --\u003e\n\n## Modules\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#module_console-ansi\"\u003econsole-ansi\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Typedefs\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsi\"\u003eConsoleAnsi\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsiThemeAttributeArray\"\u003eConsoleAnsiThemeAttributeArray\u003c/a\u003e : \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eArray for ANSI definition [start, end].\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsiTheme\"\u003eConsoleAnsiTheme\u003c/a\u003e : \u003ccode\u003eObject.\u0026lt;string, ConsoleAnsiThemeAttributeArray\u0026gt;\u003c/code\u003e | \u003ccode\u003eObject.\u0026lt;string, Array.\u0026lt;ConsoleAnsiThemeAttributeArray\u0026gt;\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eTheme object consisting of ANSI styles or Array of ANSI styles.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsiLevel\"\u003eConsoleAnsiLevel\u003c/a\u003e : \u003ccode\u003estring\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eCurrent log level. Can be any console method but levels property only defines log(1)/info(2)/warn(3)/error(4).\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsiLevels\"\u003eConsoleAnsiLevels\u003c/a\u003e : \u003ccode\u003eObject.\u0026lt;ConsoleAnsiLevel, number\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eLevels object consisting of console method as keys and numbered priority.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#ConsoleAnsiSymbol\"\u003eConsoleAnsiSymbol\u003c/a\u003e : \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eMap of unicode symbols to be prepended to certain console methods.\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"module_console-ansi\"\u003e\u003c/a\u003e\n\n## console-ansi\n\n- [console-ansi](#module_console-ansi)\n  - [.styles](#module_console-ansi.styles) : [\u003ccode\u003eConsoleAnsiTheme\u003c/code\u003e](#ConsoleAnsiTheme)\n  - [.default](#module_console-ansi.default) : [\u003ccode\u003eConsoleAnsi\u003c/code\u003e](#ConsoleAnsi)\n  - [.getConsole(options)](#module_console-ansi.getConsole) ⇒ [\u003ccode\u003eConsoleAnsi\u003c/code\u003e](#ConsoleAnsi)\n\n\u003ca name=\"module_console-ansi.styles\"\u003e\u003c/a\u003e\n\n### console-ansi.styles : [\u003ccode\u003eConsoleAnsiTheme\u003c/code\u003e](#ConsoleAnsiTheme)\n\nBasic ANSI escape codes map\n\n**Kind**: static property of [\u003ccode\u003econsole-ansi\u003c/code\u003e](#module_console-ansi)\n**See**\n\n- [Wikipedia ANSI](\u003chttps://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters\u003e)\n- [Node.js util](https://nodejs.org/api/util.html#util_customizing_util_inspect_colors)\n\n\u003ca name=\"module_console-ansi.default\"\u003e\u003c/a\u003e\n\n### console-ansi.default : [\u003ccode\u003eConsoleAnsi\u003c/code\u003e](#ConsoleAnsi)\n\nExport a Proxy object to automatically style the console with ANSI strings.\n\n**Kind**: static property of [\u003ccode\u003econsole-ansi\u003c/code\u003e](#module_console-ansi)\n\u003ca name=\"module_console-ansi.getConsole\"\u003e\u003c/a\u003e\n\n### console-ansi.getConsole(options) ⇒ [\u003ccode\u003eConsoleAnsi\u003c/code\u003e](#ConsoleAnsi)\n\nGet an instance of the Proxy-ed console. Useful if you need different prefixes for instance.\n\n**Kind**: static method of [\u003ccode\u003econsole-ansi\u003c/code\u003e](#module_console-ansi)\n\n| Param   | Type                                     |\n| ------- | ---------------------------------------- |\n| options | [\u003ccode\u003eConsoleAnsi\u003c/code\u003e](#ConsoleAnsi) |\n\n\u003ca name=\"ConsoleAnsi\"\u003e\u003c/a\u003e\n\n## ConsoleAnsi : \u003ccode\u003eobject\u003c/code\u003e\n\n**Kind**: global typedef\n**Properties**\n\n| Name      | Type                                                 | Default                                                                                                 | Description                                                                        |\n| --------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [prefix]  | \u003ccode\u003estring\u003c/code\u003e                                  | \u003ccode\u003e\u0026quot;\\\u0026quot;\\\u0026quot;\u0026quot;\u003c/code\u003e                                                                 | A string to prepend to every log.                                                  |\n| [theme]   | [\u003ccode\u003eConsoleAnsiTheme\u003c/code\u003e](#ConsoleAnsiTheme)   |                                                                                                         | Color definition associated to console methods.                                    |\n| [level]   | [\u003ccode\u003eConsoleAnsiLevel\u003c/code\u003e](#ConsoleAnsiLevel)   | \u003ccode\u003e\u0026quot;log\u0026quot;\u003c/code\u003e                                                                            | A minimum log level value. See ConsoleAnsiLevels.                                  |\n| [levels]  | [\u003ccode\u003eConsoleAnsiLevels\u003c/code\u003e](#ConsoleAnsiLevels) | \u003ccode\u003e{ error: 5, warn: 4, info: 3, log: 2 }\u003c/code\u003e                                                     | Numbered priority associated to console methods to match above for level property. |\n| [symbol]  | [\u003ccode\u003eConsoleAnsiSymbol\u003c/code\u003e](#ConsoleAnsiSymbol) | \u003ccode\u003e{ log: \u0026quot;✔\u0026quot;, info: \u0026quot;ℹ\u0026quot;, warn: \u0026quot;⚠\u0026quot;, error: \u0026quot;✖\u0026quot; }\u003c/code\u003e | Unicode symbols to prepend to defined console methods.                             |\n| [noColor] | \u003ccode\u003eboolean\u003c/code\u003e                                 | \u003ccode\u003efalse\u003c/code\u003e                                                                                      | Disable color ansi sequence.                                                       |\n\n\u003ca name=\"ConsoleAnsiThemeAttributeArray\"\u003e\u003c/a\u003e\n\n## ConsoleAnsiThemeAttributeArray : \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e\n\nArray for ANSI definition [start, end].\n\n**Kind**: global typedef\n\u003ca name=\"ConsoleAnsiTheme\"\u003e\u003c/a\u003e\n\n## ConsoleAnsiTheme : \u003ccode\u003eObject.\u0026lt;string, ConsoleAnsiThemeAttributeArray\u0026gt;\u003c/code\u003e \\| \u003ccode\u003eObject.\u0026lt;string, Array.\u0026lt;ConsoleAnsiThemeAttributeArray\u0026gt;\u0026gt;\u003c/code\u003e\n\nTheme object consisting of ANSI styles or Array of ANSI styles.\n\n**Kind**: global typedef\n\u003ca name=\"ConsoleAnsiLevel\"\u003e\u003c/a\u003e\n\n## ConsoleAnsiLevel : \u003ccode\u003estring\u003c/code\u003e\n\nCurrent log level. Can be any console method but levels property only defines log(1)/info(2)/warn(3)/error(4).\n\n**Kind**: global typedef\n\u003ca name=\"ConsoleAnsiLevels\"\u003e\u003c/a\u003e\n\n## ConsoleAnsiLevels : \u003ccode\u003eObject.\u0026lt;ConsoleAnsiLevel, number\u0026gt;\u003c/code\u003e\n\nLevels object consisting of console method as keys and numbered priority.\n\n**Kind**: global typedef\n\u003ca name=\"ConsoleAnsiSymbol\"\u003e\u003c/a\u003e\n\n## ConsoleAnsiSymbol : \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e\n\nMap of unicode symbols to be prepended to certain console methods.\n\n**Kind**: global typedef\n\n\u003c!-- api-end --\u003e\n\n## License\n\nMIT. See [license file](https://github.com/dmnsgn/console-ansi/blob/main/LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fconsole-ansi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmnsgn%2Fconsole-ansi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fconsole-ansi/lists"}