{"id":20514535,"url":"https://github.com/rollup/log","last_synced_at":"2025-04-14T00:13:24.057Z","repository":{"id":57139055,"uuid":"140502605","full_name":"rollup/log","owner":"rollup","description":"🌳","archived":false,"fork":false,"pushed_at":"2019-01-01T16:22:35.000Z","size":236,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T02:30:26.885Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/rollup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-11T00:50:31.000Z","updated_at":"2021-05-26T16:31:50.000Z","dependencies_parsed_at":"2022-08-29T01:10:23.007Z","dependency_job_id":null,"html_url":"https://github.com/rollup/log","commit_stats":null,"previous_names":["rollup-cabal/log"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollup%2Flog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollup%2Flog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollup%2Flog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollup%2Flog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rollup","download_url":"https://codeload.github.com/rollup/log/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248799956,"owners_count":21163404,"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":[],"created_at":"2024-11-15T21:17:01.497Z","updated_at":"2025-04-14T00:13:24.027Z","avatar_url":"https://github.com/rollup.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[tests]: \thttps://img.shields.io/circleci/project/github/rollup-cabal/log.svg\n[tests-url]: https://circleci.com/gh/rollup-cabal/log\n\n[cover]: https://codecov.io/gh/rollup-cabal/log/branch/master/graph/badge.svg\n[cover-url]: https://codecov.io/gh/rollup-cabal/log\n\n[chat]: https://img.shields.io/badge/gitter-rollup%2Frollup-brightgreen.svg\n[chat-url]: https://gitter.im/rollup/rollup\n\n[size]: https://packagephobia.now.sh/badge?p=log\n[size-url]: https://packagephobia.now.sh/result?p=log\n\n# @rollup-cabal/log\n\n[![tests][tests]][tests-url]\n[![cover][cover]][cover-url]\n[![chat][chat]][chat-url]\n[![size][size]][size-url]\n\n\u003cp align=\"center\"\u003e\n🌳\n\t\u003cbr\u003e\n\t\u003cimg src=\".github/screenshot.svg\" width=\"320\"\u003e\n\t\u003cbr\u003e\n\u003c/p\u003e\n\nA logger that provides targeted log levels and display options.\n\n_Note: This module requires Node 8.11.0._\n\n## Install\n\nUsing npm:\n\n```console\n$ npm install @rollup-cabal/log\n```\n\nUsing yarn:\n\n```console\n$ yarn add @rollup-cabal/log\n```\n\n## Usage\n\n```js\nimport { logger } from '@rollup-cabal/log';\n\nconst log = logger()\n\nlog.info('batman');\n\n//→ ⓡ batman\n```\n\n## API\n\n### logger([options])\n\nEach log [instance](#instance) is unique by default. To persist an instance and\nfetch it elsewhere, provide an `id` property on `options`.\n\n#### options\n\nType: `object`\n\n##### id\n\nType: `string`\n\nA unique identifier for a log instance.\n\n##### level\n\nType: `string`\u003cbr\u003e\nDefault: `info`\u003cbr\u003e\nValues: `trace` `debug` `info` `warn` `error`\n\nThe minimum log level to display output for. Output for levels above the set\nlevel will be displayed. Log levels shown in _Values_ above are in order of\nlowest to highest.\n\nSetting a level of `'info'` will display output for `log.info`,\n`log.warn`, and `log.error`. Setting a level of `'error'` will display output\nonly for `log.error`.\n\n##### preface\n\nType: `string`\n\nText to display before each log message.\n\n```js\nimport { logger } from '@rollup-cabal/log';\n\nconst log = logger({ preface: '⋊ batcave ⋉' });\n\nlog.info('batman');\n\n//→ ⓡ ⋊ batcave ⋉ batman\n```\n\n##### timestamp\n\nType: `string`\u003cbr\u003e\nDefault: `boolean`\n\nSet to `true` to display a timestamp before each log message.\n\n```js\nimport { logger } from '@rollup-cabal/log';\n\nconst log = logger({ timestamp: true });\n\nlog.info('batman');\n\n//→ [00:00:00] ⓡ batman\n```\n\n##### stderr\n\nType: `Array[string]`\u003cbr\u003e\nDefault: `['info', 'warn', 'error', 'pass', 'fail']`\n\nDefines the levels which output to `stderr` by default. This setting is useful\nfor directing select loggers to output only specific levels to `stderr` while\nallowing other levels to output to `stdout`.\n\n```js\nimport { logger } from '@rollup-cabal/log';\n\nconst log = logger({ stderr: ['warn', 'error'] });\n\nlog.info('batman');\n\n// stdout → ⓡ batman\n\nlog.warn('riddler');\n\n// stderr → ⓡ riddler\n```\n\n### Instance\n\n#### .info(text: `string`)\n\nDisplays output to `stderr` prefaced with `ⓡ` colored blue. Akin to\n`console.log`.\n\n#### .warn(text: `string`)\n\nDisplays output to `stderr` prefaced with `ⓡ` colored yellow.\n\n#### .error(text: `string`)\n\nDisplays output to `stderr` prefaced with `ⓡ` colored red.\n\n#### .debug(text: `string`)\n\nDisplays output to `stdout` prefaced with `ⓡ` colored magenta.\n\n#### .trace(text: `string`)\n\nDisplays trace output akin to `console.trace` to `stdout` prefaced with `ⓡ`\ncolored cyan.\n\n#### .pass(text: `string`)\n\nDisplays output to `stderr` prefaced with `ⓡ` colored green. The output is\npersisted regardless of the set `level`.\n\n#### .fail(text: `string`)\n\nDisplays output to `stderr` prefaced with `ⓡ` colored red. The output is\npersisted regardless of the set `level`.\n\n## Meta\n\n[CONTRIBUTING](./.github/CONTRIBUTING)\n\n[LICENSE (MIT)](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollup%2Flog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frollup%2Flog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollup%2Flog/lists"}