@teambit/logger 0.0.980 → 0.0.982

package/artifacts/__bit_junit.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="0" failures="0" errors="0" skipped="0">
-  <testsuite name="teambit.harmony/logger@0.0.980" tests="0" failures="0" errors="0" skipped="0"/>
+  <testsuite name="teambit.harmony/logger@0.0.982" tests="0" failures="0" errors="0" skipped="0"/>
 </testsuites>

package/artifacts/preview/teambit_harmony_logger-preview.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/logger-preview"]=t():e["teambit.harmony/logger-preview"]=t()}(self,(()=>(()=>{"use strict";var e={25309:(e,t,n)=>{Object.defineProperty(t,"V",{enumerable:!0,get:function(){return o.default}});var o=r(n(8468));function r(e){return e&&e.__esModule?e:{default:e}}r.__bit_component={id:"teambit.harmony/aspect-docs/logger@0.0.168",homepage:"https://bit.cloud/teambit/harmony/aspect-docs/logger",exported:!0}},8468:(e,t,n)=>{var o={id:"teambit.harmony/aspect-docs/logger@0.0.168",homepage:"https://bit.cloud/teambit/harmony/aspect-docs/logger",exported:!0};Object.defineProperty(t,"__esModule",{value:!0}),t.default=c,s(n(41594));var r=n(5016),a=["components"];function s(e){return e&&e.__esModule?e:{default:e}}function i(){return i=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)({}).hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},i.apply(null,arguments)}function l(e,t){if(null==e)return{};var n,o,r=m(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||{}.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function m(e,t){if(null==e)return{};var n={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(t.indexOf(o)>=0)continue;n[o]=e[o]}return n}s.__bit_component=o,i.__bit_component=o,l.__bit_component=o,m.__bit_component=o;var d={},p="wrapper";function c(e){var t=e.components,n=l(e,a);return(0,r.mdx)(p,i({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)("h2",null,"Create a logger"),(0,r.mdx)("p",null,"In your extension, add ",(0,r.mdx)("inlineCode",{parentName:"p"},"LoggerMain")," as a dependency and create a new logger by running"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"LoggerMain.createLogger('your-extension-id');\n")),(0,r.mdx)("h2",null,"Log to a file"),(0,r.mdx)("p",null,"The following standard methods are available to log into a file. By default it's the ",(0,r.mdx)("inlineCode",{parentName:"p"},"debug.log")," file located at ",(0,r.mdx)("inlineCode",{parentName:"p"},"~/Library/Caches/Bit/logs")," for Mac/Linux or ",(0,r.mdx)("inlineCode",{parentName:"p"},"%LOCALAPPDATA%\\Bit")," for Windows."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"logger.trace(message: string, ...meta: any[]);\nlogger.debug(message: string, ...meta: any[]);\nlogger.info(message: string, ...meta: any[]);\nlogger.warn(message: string, ...meta: any[]);\nlogger.error(message: string, ...meta: any[]);\n")),(0,r.mdx)("p",null,"The message color is coded uniquely per extension-id. This way, it's easier to scroll the logs and distinguish between the extensions."),(0,r.mdx)("p",null,"The format of the message logged to the file is ",(0,r.mdx)("strong",{parentName:"p"},'"TIMESTAMP LEVEL: EXT-ID, MSG ',"[META]",'"'),'. The "',"[META]",'" part is ',(0,r.mdx)("inlineCode",{parentName:"p"},"JSON.stringify")," of the second parameter in case it's an object. Otherwise, it's ignored."),(0,r.mdx)("p",null,"JSON format is available as well. To use it, run ",(0,r.mdx)("inlineCode",{parentName:"p"},"bit config set log_json_format true"),"."),(0,r.mdx)("p",null,"It's possible to have the console as an extra layer so these messages will be printed to the screen as well, see below."),(0,r.mdx)("h3",null,"Log stack trace"),(0,r.mdx)("p",null,"Normally, there is no need to log the Error object because it being caught by the end of the process and gets logged by Bit. Sometimes though it is needed to locally catch the error and continue, which can be useful to log the entire error object include the stack trace. In which case, pass the error object as the second parameter. e.g. ",(0,r.mdx)("inlineCode",{parentName:"p"},"catch(err) { logger.error('got an error during component-load', err); }")),(0,r.mdx)("h3",null,"Log also to the console"),(0,r.mdx)("p",null,"To see the same massages above printed into the screen, use the global flag ",(0,r.mdx)("inlineCode",{parentName:"p"},"--log [level]"),". For example, ",(0,r.mdx)("inlineCode",{parentName:"p"},"bit status --log=error"),". If the level was not entered, it defaults to ",(0,r.mdx)("inlineCode",{parentName:"p"},"info"),"."),(0,r.mdx)("p",null,"Alternatively, you can set an environment variable ",(0,r.mdx)("inlineCode",{parentName:"p"},"BIT_LOG")," with the desired level."),(0,r.mdx)("p",null,"The format of the message logged to the console is ",(0,r.mdx)("strong",{parentName:"p"},'"MSG ',"[META]",'"'),' The "',"[META]",'" part is the same as above.'),(0,r.mdx)("h2",null,"Report progress"),(0,r.mdx)("p",null,"During the command execution it's helpful to see the progress on the screen. The following options log to the file and in addition, print to the screen. Use only these methods and avoid calling ",(0,r.mdx)("inlineCode",{parentName:"p"},"console.log")," to not break the output (or potentially the JSON structure)."),(0,r.mdx)("blockquote",null,(0,r.mdx)("p",{parentName:"blockquote"},'Please note that these methods print to the screen only when a command is not considered "internal" (such commands normally run on the remote server) and when a command is not used with ',(0,r.mdx)("inlineCode",{parentName:"p"},"--json")," flag. To specifically disable console-printing to a command, set the ",(0,r.mdx)("inlineCode",{parentName:"p"},"loader")," property to ",(0,r.mdx)("inlineCode",{parentName:"p"},"false"),".")),(0,r.mdx)("h3",null,"Status Line (spinner)"),(0,r.mdx)("p",null,"The status-line is a single line on the bottom of the screen, with a spinner/loader prefix. It's changing constantly during the command execution. This is the main indicator for the end-user of what's going on at the moment."),(0,r.mdx)("p",null,"To set the text of this status-line, call:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"logger.setStatusLine((text: string));\n")),(0,r.mdx)("p",null,"Once the command completed, the spinner is stopped and the status-line is cleared. Then, the command results are printed. If, for some reason, it is needed to clear the status-line before, just call ",(0,r.mdx)("inlineCode",{parentName:"p"},"logger.clearStatusLine()"),"."),(0,r.mdx)("h3",null,"Persist text"),(0,r.mdx)("p",null,"Sometimes it's helpful to indicate that a phase has completed. Either successfully or failed. The following methods help with this:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"// print to the screen with a green `✔` prefix. if message is empty, print the last logged message.\nlogger.consoleSuccess(message?: string);\n\n// print to the screen with a red `✖` prefix. if message is empty, print the last logged message.\nlogger.consoleFailure(message?: string);\n")),(0,r.mdx)("p",null,"To print without any prefix, use ",(0,r.mdx)("inlineCode",{parentName:"p"},"logger.console(message);")),(0,r.mdx)("h3",null,"Long Running Process Logger"),(0,r.mdx)("p",null,"Run the following to get an instance of the ",(0,r.mdx)("inlineCode",{parentName:"p"},"LongProcessLogger")," and start logging the process description."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"logger.createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;\n")),(0,r.mdx)("p",null,"If the process involves iteration over a list of items, such as running tag on a list of components, then pass the ",(0,r.mdx)("inlineCode",{parentName:"p"},"totalItems")," as the total number of the components in the list."),(0,r.mdx)("p",null,"Later, during the iteration, call ",(0,r.mdx)("inlineCode",{parentName:"p"},"logProgress(componentName)")," on the ",(0,r.mdx)("inlineCode",{parentName:"p"},"LongProcessLogger")," instance.\nonce done, call ",(0,r.mdx)("inlineCode",{parentName:"p"},"end()"),", which logs the duration of the process in ms."),(0,r.mdx)("p",null,"Here is an example of the messages produced by this longProcessLogger. The status-line always shows the last message."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"teambit.workspace/workspace, loading components (total: 20)\nteambit.workspace/workspace, loading components (1/20). ui/button\nteambit.workspace/workspace, loading components (2/20). ui/form\n...\nteambit.workspace/workspace, loading components (20/20). ui/page\nteambit.workspace/workspace, loading components (completed in 200ms)\n")),(0,r.mdx)("p",null,"An example when there is no ",(0,r.mdx)("inlineCode",{parentName:"p"},"totalItems"),"."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"teambit.workspace/workspace, loading components\nteambit.workspace/workspace, loading components (completed in 200ms)\n")))}c.__bit_component=o,c.isMDXComponent=!0},9438:(e,t,n)=>{var o={id:"teambit.harmony/logger@0.0.980",homepage:"https://bit.cloud/teambit/harmony/logger",exported:!0};function r(){const e=a(n(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=o,a.__bit_component=o;const s=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/logger.svg"}));s.__bit_component=o,t.Logo=s},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React}},t={};function n(o){var r=t[o];if(void 0!==r)return r.exports;var a=t[o]={exports:{}};return e[o](a,a.exports,n),a.exports}n.d=(e,t)=>{for(var o in t)n.o(t,o)&&!n.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};n.r(o),n.d(o,{compositions:()=>u,compositions_metadata:()=>f,overview:()=>h});var r={};n.r(r),n.d(r,{default:()=>g});var a=n(9438),s=(n(41594),n(5016));const i=TeambitMdxUiMdxScopeContext;var l=n(25309),m=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)({}).hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},d.apply(null,arguments)}var p={},c="wrapper";function g(e){var t=e.components,n=function(e,t){if(null==e)return{};var n,o,r=function(e,t){if(null==e)return{};var n={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(t.indexOf(o)>=0)continue;n[o]=e[o]}return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||{}.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}(e,m);return(0,s.mdx)(c,d({},p,n,{components:t,mdxType:"MDXLayout"}),(0,s.mdx)(i.MDXScopeProvider,{components:{Logger:l.V},mdxType:"MDXScopeProvider"},(0,s.mdx)(l.V,{mdxType:"Logger"})))}g.isMDXComponent=!0;const u=[a],h=[r],f={compositions:[{displayName:"Logo",identifier:"Logo"}]};return o})()));
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/logger-preview"]=t():e["teambit.harmony/logger-preview"]=t()}(self,(()=>(()=>{"use strict";var e={25309:(e,t,n)=>{Object.defineProperty(t,"V",{enumerable:!0,get:function(){return o.default}});var o=r(n(8468));function r(e){return e&&e.__esModule?e:{default:e}}r.__bit_component={id:"teambit.harmony/aspect-docs/logger@0.0.168",homepage:"https://bit.cloud/teambit/harmony/aspect-docs/logger",exported:!0}},8468:(e,t,n)=>{var o={id:"teambit.harmony/aspect-docs/logger@0.0.168",homepage:"https://bit.cloud/teambit/harmony/aspect-docs/logger",exported:!0};Object.defineProperty(t,"__esModule",{value:!0}),t.default=c,s(n(41594));var r=n(5016),a=["components"];function s(e){return e&&e.__esModule?e:{default:e}}function i(){return i=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)({}).hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},i.apply(null,arguments)}function l(e,t){if(null==e)return{};var n,o,r=m(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||{}.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function m(e,t){if(null==e)return{};var n={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(t.indexOf(o)>=0)continue;n[o]=e[o]}return n}s.__bit_component=o,i.__bit_component=o,l.__bit_component=o,m.__bit_component=o;var d={},p="wrapper";function c(e){var t=e.components,n=l(e,a);return(0,r.mdx)(p,i({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)("h2",null,"Create a logger"),(0,r.mdx)("p",null,"In your extension, add ",(0,r.mdx)("inlineCode",{parentName:"p"},"LoggerMain")," as a dependency and create a new logger by running"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"LoggerMain.createLogger('your-extension-id');\n")),(0,r.mdx)("h2",null,"Log to a file"),(0,r.mdx)("p",null,"The following standard methods are available to log into a file. By default it's the ",(0,r.mdx)("inlineCode",{parentName:"p"},"debug.log")," file located at ",(0,r.mdx)("inlineCode",{parentName:"p"},"~/Library/Caches/Bit/logs")," for Mac/Linux or ",(0,r.mdx)("inlineCode",{parentName:"p"},"%LOCALAPPDATA%\\Bit")," for Windows."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"logger.trace(message: string, ...meta: any[]);\nlogger.debug(message: string, ...meta: any[]);\nlogger.info(message: string, ...meta: any[]);\nlogger.warn(message: string, ...meta: any[]);\nlogger.error(message: string, ...meta: any[]);\n")),(0,r.mdx)("p",null,"The message color is coded uniquely per extension-id. This way, it's easier to scroll the logs and distinguish between the extensions."),(0,r.mdx)("p",null,"The format of the message logged to the file is ",(0,r.mdx)("strong",{parentName:"p"},'"TIMESTAMP LEVEL: EXT-ID, MSG ',"[META]",'"'),'. The "',"[META]",'" part is ',(0,r.mdx)("inlineCode",{parentName:"p"},"JSON.stringify")," of the second parameter in case it's an object. Otherwise, it's ignored."),(0,r.mdx)("p",null,"JSON format is available as well. To use it, run ",(0,r.mdx)("inlineCode",{parentName:"p"},"bit config set log_json_format true"),"."),(0,r.mdx)("p",null,"It's possible to have the console as an extra layer so these messages will be printed to the screen as well, see below."),(0,r.mdx)("h3",null,"Log stack trace"),(0,r.mdx)("p",null,"Normally, there is no need to log the Error object because it being caught by the end of the process and gets logged by Bit. Sometimes though it is needed to locally catch the error and continue, which can be useful to log the entire error object include the stack trace. In which case, pass the error object as the second parameter. e.g. ",(0,r.mdx)("inlineCode",{parentName:"p"},"catch(err) { logger.error('got an error during component-load', err); }")),(0,r.mdx)("h3",null,"Log also to the console"),(0,r.mdx)("p",null,"To see the same massages above printed into the screen, use the global flag ",(0,r.mdx)("inlineCode",{parentName:"p"},"--log [level]"),". For example, ",(0,r.mdx)("inlineCode",{parentName:"p"},"bit status --log=error"),". If the level was not entered, it defaults to ",(0,r.mdx)("inlineCode",{parentName:"p"},"info"),"."),(0,r.mdx)("p",null,"Alternatively, you can set an environment variable ",(0,r.mdx)("inlineCode",{parentName:"p"},"BIT_LOG")," with the desired level."),(0,r.mdx)("p",null,"The format of the message logged to the console is ",(0,r.mdx)("strong",{parentName:"p"},'"MSG ',"[META]",'"'),' The "',"[META]",'" part is the same as above.'),(0,r.mdx)("h2",null,"Report progress"),(0,r.mdx)("p",null,"During the command execution it's helpful to see the progress on the screen. The following options log to the file and in addition, print to the screen. Use only these methods and avoid calling ",(0,r.mdx)("inlineCode",{parentName:"p"},"console.log")," to not break the output (or potentially the JSON structure)."),(0,r.mdx)("blockquote",null,(0,r.mdx)("p",{parentName:"blockquote"},'Please note that these methods print to the screen only when a command is not considered "internal" (such commands normally run on the remote server) and when a command is not used with ',(0,r.mdx)("inlineCode",{parentName:"p"},"--json")," flag. To specifically disable console-printing to a command, set the ",(0,r.mdx)("inlineCode",{parentName:"p"},"loader")," property to ",(0,r.mdx)("inlineCode",{parentName:"p"},"false"),".")),(0,r.mdx)("h3",null,"Status Line (spinner)"),(0,r.mdx)("p",null,"The status-line is a single line on the bottom of the screen, with a spinner/loader prefix. It's changing constantly during the command execution. This is the main indicator for the end-user of what's going on at the moment."),(0,r.mdx)("p",null,"To set the text of this status-line, call:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"logger.setStatusLine((text: string));\n")),(0,r.mdx)("p",null,"Once the command completed, the spinner is stopped and the status-line is cleared. Then, the command results are printed. If, for some reason, it is needed to clear the status-line before, just call ",(0,r.mdx)("inlineCode",{parentName:"p"},"logger.clearStatusLine()"),"."),(0,r.mdx)("h3",null,"Persist text"),(0,r.mdx)("p",null,"Sometimes it's helpful to indicate that a phase has completed. Either successfully or failed. The following methods help with this:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"// print to the screen with a green `✔` prefix. if message is empty, print the last logged message.\nlogger.consoleSuccess(message?: string);\n\n// print to the screen with a red `✖` prefix. if message is empty, print the last logged message.\nlogger.consoleFailure(message?: string);\n")),(0,r.mdx)("p",null,"To print without any prefix, use ",(0,r.mdx)("inlineCode",{parentName:"p"},"logger.console(message);")),(0,r.mdx)("h3",null,"Long Running Process Logger"),(0,r.mdx)("p",null,"Run the following to get an instance of the ",(0,r.mdx)("inlineCode",{parentName:"p"},"LongProcessLogger")," and start logging the process description."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-js"},"logger.createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;\n")),(0,r.mdx)("p",null,"If the process involves iteration over a list of items, such as running tag on a list of components, then pass the ",(0,r.mdx)("inlineCode",{parentName:"p"},"totalItems")," as the total number of the components in the list."),(0,r.mdx)("p",null,"Later, during the iteration, call ",(0,r.mdx)("inlineCode",{parentName:"p"},"logProgress(componentName)")," on the ",(0,r.mdx)("inlineCode",{parentName:"p"},"LongProcessLogger")," instance.\nonce done, call ",(0,r.mdx)("inlineCode",{parentName:"p"},"end()"),", which logs the duration of the process in ms."),(0,r.mdx)("p",null,"Here is an example of the messages produced by this longProcessLogger. The status-line always shows the last message."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"teambit.workspace/workspace, loading components (total: 20)\nteambit.workspace/workspace, loading components (1/20). ui/button\nteambit.workspace/workspace, loading components (2/20). ui/form\n...\nteambit.workspace/workspace, loading components (20/20). ui/page\nteambit.workspace/workspace, loading components (completed in 200ms)\n")),(0,r.mdx)("p",null,"An example when there is no ",(0,r.mdx)("inlineCode",{parentName:"p"},"totalItems"),"."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"teambit.workspace/workspace, loading components\nteambit.workspace/workspace, loading components (completed in 200ms)\n")))}c.__bit_component=o,c.isMDXComponent=!0},26232:(e,t,n)=>{var o={id:"teambit.harmony/logger@0.0.982",homepage:"https://bit.cloud/teambit/harmony/logger",exported:!0};function r(){const e=a(n(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=o,a.__bit_component=o;const s=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/logger.svg"}));s.__bit_component=o,t.Logo=s},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React}},t={};function n(o){var r=t[o];if(void 0!==r)return r.exports;var a=t[o]={exports:{}};return e[o](a,a.exports,n),a.exports}n.d=(e,t)=>{for(var o in t)n.o(t,o)&&!n.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};n.r(o),n.d(o,{compositions:()=>u,compositions_metadata:()=>f,overview:()=>h});var r={};n.r(r),n.d(r,{default:()=>g});var a=n(26232),s=(n(41594),n(5016));const i=TeambitMdxUiMdxScopeContext;var l=n(25309),m=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)({}).hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},d.apply(null,arguments)}var p={},c="wrapper";function g(e){var t=e.components,n=function(e,t){if(null==e)return{};var n,o,r=function(e,t){if(null==e)return{};var n={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(t.indexOf(o)>=0)continue;n[o]=e[o]}return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||{}.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}(e,m);return(0,s.mdx)(c,d({},p,n,{components:t,mdxType:"MDXLayout"}),(0,s.mdx)(i.MDXScopeProvider,{components:{Logger:l.V},mdxType:"MDXScopeProvider"},(0,s.mdx)(l.V,{mdxType:"Logger"})))}g.isMDXComponent=!0;const u=[a],h=[r],f={compositions:[{displayName:"Logo",identifier:"Logo"}]};return o})()));

package/artifacts/schema.json

@@ -566,7 +566,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * use it for a long running process. upon creation it logs the `processDescription`.\n   * if the process involves iteration over a list of items, such as running tag on a list of\n   * components, then pass the `totalItems` as the total of the total components in the list.\n   * later, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\n   * once done, call `LongProcessLogger.end()`\n   * the status-line will show all messages in the terminal.\n   */",
-                "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total of the total components in the list.\nlater, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\nonce done, call `LongProcessLogger.end()`\nthe status-line will show all messages in the terminal."
+                "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total of the total components in the list.\nlater, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\nonce done, call `LongProcessLogger.end()`\nthe status-line will show all messages in the terminal.",
+                "tags": []
               },
               "signature": "(method) Logger.createLongProcessLogger(processDescription: string, totalItems?: number, shouldConsole?: ConsoleOnStart): LongProcessLogger",
               "name": "createLongProcessLogger",
@@ -659,7 +660,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * single status-line on the bottom of the screen.\n   * the text is replaced every time this method is called.\n   */",
-                "comment": "single status-line on the bottom of the screen.\nthe text is replaced every time this method is called."
+                "comment": "single status-line on the bottom of the screen.\nthe text is replaced every time this method is called.",
+                "tags": []
               },
               "signature": "(method) Logger.setStatusLine(text: string, shouldPrintOnCI?: boolean): void",
               "name": "setStatusLine",
@@ -732,7 +734,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * remove the text from the last line on the screen.\n   */",
-                "comment": "remove the text from the last line on the screen."
+                "comment": "remove the text from the last line on the screen.",
+                "tags": []
               },
               "signature": "(method) Logger.clearStatusLine(): void",
               "name": "clearStatusLine",
@@ -763,7 +766,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen. if message is empty, print the last logged message."
+                "comment": "print to the screen. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.console(message?: string, ...meta: any[]): void",
               "name": "console",
@@ -843,6 +847,7 @@
                   "character": 3
                 },
                 "raw": "/**\n   * @deprecated\n   * try using consoleWarning. if not possible, rename this method to a clearer one\n   */",
+                "comment": "",
                 "tags": [
                   {
                     "__schema": "TagSchema",
@@ -934,6 +939,7 @@
                   "character": 3
                 },
                 "raw": "/**\n   * @deprecated\n   * try using consoleFailure. if not possible, rename this method to a clearer one\n   */",
+                "comment": "",
                 "tags": [
                   {
                     "__schema": "TagSchema",
@@ -1025,7 +1031,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen as a title, with bold text.\n   */",
-                "comment": "print to the screen as a title, with bold text."
+                "comment": "print to the screen as a title, with bold text.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleTitle(message: string): void",
               "name": "consoleTitle",
@@ -1077,7 +1084,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a green `✔` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a green `✔` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a green `✔` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleSuccess(message?: string, startTime?: [number, number]): void",
               "name": "consoleSuccess",
@@ -1168,7 +1176,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * turn off the logger.\n   */",
-                "comment": "turn off the logger."
+                "comment": "turn off the logger.",
+                "tags": []
               },
               "signature": "(method) Logger.off(): Loader",
               "name": "off",
@@ -1282,7 +1291,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a red `✖` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a red `✖` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a red `✖` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleFailure(message?: string): void",
               "name": "consoleFailure",
@@ -1334,7 +1344,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a red `⚠` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleWarning(message?: string): void",
               "name": "consoleWarning",
@@ -1386,7 +1397,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * a recent change on Windows caused the check mark to be printed as purple.\n   * see https://github.com/chalk/chalk/issues/625\n   */",
-                "comment": "a recent change on Windows caused the check mark to be printed as purple.\nsee https://github.com/chalk/chalk/issues/625"
+                "comment": "a recent change on Windows caused the check mark to be printed as purple.\nsee https://github.com/chalk/chalk/issues/625",
+                "tags": []
               },
               "signature": "(method) Logger.successSymbol(): string",
               "name": "successSymbol",
@@ -1428,7 +1440,7 @@
                   "_legacy": {
                     "scope": "teambit.harmony",
                     "name": "logger",
-                    "version": "0.0.980"
+                    "version": "0.0.982"
                   },
                   "_scope": "teambit.harmony"
                 }
@@ -1626,7 +1638,8 @@
               "character": 1
             },
             "raw": "/**\n * use it for a long running process. upon creation it logs the `processDescription`.\n * if the process involves iteration over a list of items, such as running tag on a list of\n * components, then pass the `totalItems` as the total components in the list.\n * later, during the iteration, call `logProgress(componentName)`.\n * once done, call `end()`.\n * the status-line will show all messages in the terminal.\n * see README for more data.\n */",
-            "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total components in the list.\nlater, during the iteration, call `logProgress(componentName)`.\nonce done, call `end()`.\nthe status-line will show all messages in the terminal.\nsee README for more data."
+            "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total components in the list.\nlater, during the iteration, call `logProgress(componentName)`.\nonce done, call `end()`.\nthe status-line will show all messages in the terminal.\nsee README for more data.",
+            "tags": []
           },
           "signature": "class LongProcessLogger",
           "name": "LongProcessLogger",
@@ -2462,7 +2475,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * use it for a long running process. upon creation it logs the `processDescription`.\n   * if the process involves iteration over a list of items, such as running tag on a list of\n   * components, then pass the `totalItems` as the total of the total components in the list.\n   * later, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\n   * once done, call `LongProcessLogger.end()`\n   * the status-line will show all messages in the terminal.\n   */",
-                "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total of the total components in the list.\nlater, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\nonce done, call `LongProcessLogger.end()`\nthe status-line will show all messages in the terminal."
+                "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total of the total components in the list.\nlater, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\nonce done, call `LongProcessLogger.end()`\nthe status-line will show all messages in the terminal.",
+                "tags": []
               },
               "signature": "(method) Logger.createLongProcessLogger(processDescription: string, totalItems?: number, shouldConsole?: ConsoleOnStart): LongProcessLogger",
               "name": "createLongProcessLogger",
@@ -2555,7 +2569,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * single status-line on the bottom of the screen.\n   * the text is replaced every time this method is called.\n   */",
-                "comment": "single status-line on the bottom of the screen.\nthe text is replaced every time this method is called."
+                "comment": "single status-line on the bottom of the screen.\nthe text is replaced every time this method is called.",
+                "tags": []
               },
               "signature": "(method) Logger.setStatusLine(text: string, shouldPrintOnCI?: boolean): void",
               "name": "setStatusLine",
@@ -2628,7 +2643,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * remove the text from the last line on the screen.\n   */",
-                "comment": "remove the text from the last line on the screen."
+                "comment": "remove the text from the last line on the screen.",
+                "tags": []
               },
               "signature": "(method) Logger.clearStatusLine(): void",
               "name": "clearStatusLine",
@@ -2659,7 +2675,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen. if message is empty, print the last logged message."
+                "comment": "print to the screen. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.console(message?: string, ...meta: any[]): void",
               "name": "console",
@@ -2739,6 +2756,7 @@
                   "character": 3
                 },
                 "raw": "/**\n   * @deprecated\n   * try using consoleWarning. if not possible, rename this method to a clearer one\n   */",
+                "comment": "",
                 "tags": [
                   {
                     "__schema": "TagSchema",
@@ -2830,6 +2848,7 @@
                   "character": 3
                 },
                 "raw": "/**\n   * @deprecated\n   * try using consoleFailure. if not possible, rename this method to a clearer one\n   */",
+                "comment": "",
                 "tags": [
                   {
                     "__schema": "TagSchema",
@@ -2921,7 +2940,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen as a title, with bold text.\n   */",
-                "comment": "print to the screen as a title, with bold text."
+                "comment": "print to the screen as a title, with bold text.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleTitle(message: string): void",
               "name": "consoleTitle",
@@ -2973,7 +2993,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a green `✔` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a green `✔` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a green `✔` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleSuccess(message?: string, startTime?: [number, number]): void",
               "name": "consoleSuccess",
@@ -3064,7 +3085,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * turn off the logger.\n   */",
-                "comment": "turn off the logger."
+                "comment": "turn off the logger.",
+                "tags": []
               },
               "signature": "(method) Logger.off(): Loader",
               "name": "off",
@@ -3178,7 +3200,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a red `✖` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a red `✖` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a red `✖` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleFailure(message?: string): void",
               "name": "consoleFailure",
@@ -3230,7 +3253,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.\n   */",
-                "comment": "print to the screen with a red `⚠` prefix. if message is empty, print the last logged message."
+                "comment": "print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.",
+                "tags": []
               },
               "signature": "(method) Logger.consoleWarning(message?: string): void",
               "name": "consoleWarning",
@@ -3282,7 +3306,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * a recent change on Windows caused the check mark to be printed as purple.\n   * see https://github.com/chalk/chalk/issues/625\n   */",
-                "comment": "a recent change on Windows caused the check mark to be printed as purple.\nsee https://github.com/chalk/chalk/issues/625"
+                "comment": "a recent change on Windows caused the check mark to be printed as purple.\nsee https://github.com/chalk/chalk/issues/625",
+                "tags": []
               },
               "signature": "(method) Logger.successSymbol(): string",
               "name": "successSymbol",
@@ -3324,7 +3349,7 @@
                   "_legacy": {
                     "scope": "teambit.harmony",
                     "name": "logger",
-                    "version": "0.0.980"
+                    "version": "0.0.982"
                   },
                   "_scope": "teambit.harmony"
                 }
@@ -3433,7 +3458,8 @@
               "character": 1
             },
             "raw": "/**\n * use it for a long running process. upon creation it logs the `processDescription`.\n * if the process involves iteration over a list of items, such as running tag on a list of\n * components, then pass the `totalItems` as the total components in the list.\n * later, during the iteration, call `logProgress(componentName)`.\n * once done, call `end()`.\n * the status-line will show all messages in the terminal.\n * see README for more data.\n */",
-            "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total components in the list.\nlater, during the iteration, call `logProgress(componentName)`.\nonce done, call `end()`.\nthe status-line will show all messages in the terminal.\nsee README for more data."
+            "comment": "use it for a long running process. upon creation it logs the `processDescription`.\nif the process involves iteration over a list of items, such as running tag on a list of\ncomponents, then pass the `totalItems` as the total components in the list.\nlater, during the iteration, call `logProgress(componentName)`.\nonce done, call `end()`.\nthe status-line will show all messages in the terminal.\nsee README for more data.",
+            "tags": []
           },
           "signature": "class LongProcessLogger",
           "name": "LongProcessLogger",
@@ -3718,7 +3744,7 @@
   "componentId": {
     "scope": "teambit.harmony",
     "name": "logger",
-    "version": "0.0.980"
+    "version": "0.0.982"
   },
   "taggedModuleExports": []
 }

package/dist/{preview-1718853656395.js → preview-1719154175406.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_logger@0.0.980/dist/logger.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_logger@0.0.980/dist/logger.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_logger@0.0.982/dist/logger.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_logger@0.0.982/dist/logger.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@teambit/logger",
-  "version": "0.0.980",
+  "version": "0.0.982",
   "homepage": "https://bit.cloud/teambit/harmony/logger",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "logger",
-    "version": "0.0.980"
+    "version": "0.0.982"
   },
   "dependencies": {
     "chalk": "2.4.2",
     "dreidels": "0.6.1",
     "pretty-time": "1.1.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.887"
+    "@teambit/cli": "0.0.889"
   },
   "devDependencies": {
     "@types/mocha": "9.1.0",