@teambit/harmony.aspect-docs.logger 0.0.174 → 0.0.176

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -1,9 +1,2 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.Logger = void 0;
7
- var logger_mdx_1 = require("./logger.mdx");
8
- Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return __importDefault(logger_mdx_1).default; } });
1
+ export { default as Logger } from './logger.mdx';
9
2
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAiD;AAAxC,qHAAA,OAAO,OAAU"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,cAAc,CAAC"}
@@ -1,15 +1,6 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.LoggerDocs = void 0;
7
- const react_1 = __importDefault(require("react"));
8
- const documenter_theme_theme_compositions_1 = require("@teambit/documenter.theme.theme-compositions");
9
- const mdx_ui_mdx_layout_1 = require("@teambit/mdx.ui.mdx-layout");
10
- const index_1 = require("./index");
11
- const LoggerDocs = () => (react_1.default.createElement(documenter_theme_theme_compositions_1.ThemeCompositions, null,
12
- react_1.default.createElement(mdx_ui_mdx_layout_1.MDXLayout, null,
13
- react_1.default.createElement(index_1.Logger, null))));
14
- exports.LoggerDocs = LoggerDocs;
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
3
+ import { MDXLayout } from '@teambit/mdx.ui.mdx-layout';
4
+ import { Logger } from './index';
5
+ export const LoggerDocs = () => (_jsx(ThemeCompositions, { children: _jsx(MDXLayout, { children: _jsx(Logger, {}) }) }));
15
6
  //# sourceMappingURL=logger.composition.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.composition.js","sourceRoot":"","sources":["../logger.composition.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,sGAAiF;AACjF,kEAAuD;AACvD,mCAAiC;AAE1B,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,CAC9B,8BAAC,uDAAiB;IAChB,8BAAC,6BAAS;QACR,8BAAC,cAAM,OAAG,CACA,CACM,CACrB,CAAC;AANW,QAAA,UAAU,cAMrB"}
1
+ {"version":3,"file":"logger.composition.js","sourceRoot":"","sources":["../logger.composition.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,CAC9B,KAAC,iBAAiB,cAChB,KAAC,SAAS,cACR,KAAC,MAAM,KAAG,GACA,GACM,CACrB,CAAC"}
@@ -1,11 +1,3 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports["default"] = MDXContent;
7
- var _jsxRuntime = require("react/jsx-runtime");
8
- var _react = require("@mdx-js/react");
9
1
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
2
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
11
3
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -13,6 +5,8 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
13
5
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
14
6
  function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
15
7
  MDXContent.isMDXComponent = true;
8
+ import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
9
+ import { useMDXComponents as _provideComponents } from "@mdx-js/react";
16
10
  function _createMdxContent(props) {
17
11
  var _components = _objectSpread(_objectSpread({
18
12
  blockquote: "blockquote",
@@ -22,163 +16,163 @@ function _createMdxContent(props) {
22
16
  p: "p",
23
17
  pre: "pre",
24
18
  strong: "strong"
25
- }, (0, _react.useMDXComponents)()), props.components);
26
- return (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
27
- children: [(0, _jsxRuntime.jsx)(_components.h2, {
19
+ }, _provideComponents()), props.components);
20
+ return _jsxs(_Fragment, {
21
+ children: [_jsx(_components.h2, {
28
22
  children: "Create a logger"
29
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
30
- children: ["In your extension, add ", (0, _jsxRuntime.jsx)(_components.code, {
23
+ }), "\n", _jsxs(_components.p, {
24
+ children: ["In your extension, add ", _jsx(_components.code, {
31
25
  children: "LoggerMain"
32
26
  }), " as a dependency and create a new logger by running"]
33
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
34
- children: (0, _jsxRuntime.jsx)(_components.code, {
27
+ }), "\n", _jsx(_components.pre, {
28
+ children: _jsx(_components.code, {
35
29
  children: "LoggerMain.createLogger('your-extension-id');\n"
36
30
  })
37
- }), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
31
+ }), "\n", _jsx(_components.h2, {
38
32
  children: "Log to a file"
39
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
40
- children: ["The following standard methods are available to log into a file. By default it's the ", (0, _jsxRuntime.jsx)(_components.code, {
33
+ }), "\n", _jsxs(_components.p, {
34
+ children: ["The following standard methods are available to log into a file. By default it's the ", _jsx(_components.code, {
41
35
  children: "debug.log"
42
- }), " file located at ", (0, _jsxRuntime.jsx)(_components.code, {
36
+ }), " file located at ", _jsx(_components.code, {
43
37
  children: "~/Library/Caches/Bit/logs"
44
- }), " for Mac/Linux or ", (0, _jsxRuntime.jsx)(_components.code, {
38
+ }), " for Mac/Linux or ", _jsx(_components.code, {
45
39
  children: "%LOCALAPPDATA%\\Bit"
46
40
  }), " for Windows."]
47
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
48
- children: (0, _jsxRuntime.jsx)(_components.code, {
41
+ }), "\n", _jsx(_components.pre, {
42
+ children: _jsx(_components.code, {
49
43
  className: "language-ts",
50
44
  children: "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"
51
45
  })
52
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
46
+ }), "\n", _jsx(_components.p, {
53
47
  children: "The message color is coded uniquely per extension-id. This way, it's easier to scroll the logs and distinguish between the extensions."
54
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
55
- children: ["The format of the message logged to the file is ", (0, _jsxRuntime.jsx)(_components.strong, {
48
+ }), "\n", _jsxs(_components.p, {
49
+ children: ["The format of the message logged to the file is ", _jsx(_components.strong, {
56
50
  children: "\"TIMESTAMP LEVEL: EXT-ID, MSG [META]\""
57
- }), ". The \"[META]\" part is ", (0, _jsxRuntime.jsx)(_components.code, {
51
+ }), ". The \"[META]\" part is ", _jsx(_components.code, {
58
52
  children: "JSON.stringify"
59
53
  }), " of the second parameter in case it's an object. Otherwise, it's ignored."]
60
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
61
- children: ["JSON format is available as well. To use it, run ", (0, _jsxRuntime.jsx)(_components.code, {
54
+ }), "\n", _jsxs(_components.p, {
55
+ children: ["JSON format is available as well. To use it, run ", _jsx(_components.code, {
62
56
  children: "bit config set log_json_format true"
63
57
  }), "."]
64
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
58
+ }), "\n", _jsx(_components.p, {
65
59
  children: "It's possible to have the console as an extra layer so these messages will be printed to the screen as well, see below."
66
- }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
60
+ }), "\n", _jsx(_components.h3, {
67
61
  children: "Log stack trace"
68
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
69
- children: ["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, _jsxRuntime.jsx)(_components.code, {
62
+ }), "\n", _jsxs(_components.p, {
63
+ children: ["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. ", _jsx(_components.code, {
70
64
  children: "catch(err) { logger.error('got an error during component-load', err); }"
71
65
  })]
72
- }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
66
+ }), "\n", _jsx(_components.h3, {
73
67
  children: "Log also to the console"
74
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
75
- children: ["To see the same massages above printed into the screen, use the global flag ", (0, _jsxRuntime.jsx)(_components.code, {
68
+ }), "\n", _jsxs(_components.p, {
69
+ children: ["To see the same massages above printed into the screen, use the global flag ", _jsx(_components.code, {
76
70
  children: "--log [level]"
77
- }), ". For example, ", (0, _jsxRuntime.jsx)(_components.code, {
71
+ }), ". For example, ", _jsx(_components.code, {
78
72
  children: "bit status --log=error"
79
- }), ". If the level was not entered, it defaults to ", (0, _jsxRuntime.jsx)(_components.code, {
73
+ }), ". If the level was not entered, it defaults to ", _jsx(_components.code, {
80
74
  children: "info"
81
75
  }), "."]
82
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
83
- children: ["Alternatively, you can set an environment variable ", (0, _jsxRuntime.jsx)(_components.code, {
76
+ }), "\n", _jsxs(_components.p, {
77
+ children: ["Alternatively, you can set an environment variable ", _jsx(_components.code, {
84
78
  children: "BIT_LOG"
85
79
  }), " with the desired level."]
86
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
87
- children: ["The format of the message logged to the console is ", (0, _jsxRuntime.jsx)(_components.strong, {
80
+ }), "\n", _jsxs(_components.p, {
81
+ children: ["The format of the message logged to the console is ", _jsx(_components.strong, {
88
82
  children: "\"MSG [META]\""
89
83
  }), " The \"[META]\" part is the same as above."]
90
- }), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
84
+ }), "\n", _jsx(_components.h2, {
91
85
  children: "Report progress"
92
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
93
- children: ["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, _jsxRuntime.jsx)(_components.code, {
86
+ }), "\n", _jsxs(_components.p, {
87
+ children: ["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 ", _jsx(_components.code, {
94
88
  children: "console.log"
95
89
  }), " to not break the output (or potentially the JSON structure)."]
96
- }), "\n", (0, _jsxRuntime.jsxs)(_components.blockquote, {
97
- children: ["\n", (0, _jsxRuntime.jsxs)(_components.p, {
98
- children: ["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, _jsxRuntime.jsx)(_components.code, {
90
+ }), "\n", _jsxs(_components.blockquote, {
91
+ children: ["\n", _jsxs(_components.p, {
92
+ children: ["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 ", _jsx(_components.code, {
99
93
  children: "--json"
100
- }), " flag. To specifically disable console-printing to a command, set the ", (0, _jsxRuntime.jsx)(_components.code, {
94
+ }), " flag. To specifically disable console-printing to a command, set the ", _jsx(_components.code, {
101
95
  children: "loader"
102
- }), " property to ", (0, _jsxRuntime.jsx)(_components.code, {
96
+ }), " property to ", _jsx(_components.code, {
103
97
  children: "false"
104
98
  }), "."]
105
99
  }), "\n"]
106
- }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
100
+ }), "\n", _jsx(_components.h3, {
107
101
  children: "Status Line (spinner)"
108
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
102
+ }), "\n", _jsx(_components.p, {
109
103
  children: "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."
110
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
104
+ }), "\n", _jsx(_components.p, {
111
105
  children: "To set the text of this status-line, call:"
112
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
113
- children: (0, _jsxRuntime.jsx)(_components.code, {
106
+ }), "\n", _jsx(_components.pre, {
107
+ children: _jsx(_components.code, {
114
108
  className: "language-js",
115
109
  children: "logger.setStatusLine((text: string));\n"
116
110
  })
117
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
118
- children: ["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, _jsxRuntime.jsx)(_components.code, {
111
+ }), "\n", _jsxs(_components.p, {
112
+ children: ["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 ", _jsx(_components.code, {
119
113
  children: "logger.clearStatusLine()"
120
114
  }), "."]
121
- }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
115
+ }), "\n", _jsx(_components.h3, {
122
116
  children: "Persist text"
123
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
117
+ }), "\n", _jsx(_components.p, {
124
118
  children: "Sometimes it's helpful to indicate that a phase has completed. Either successfully or failed. The following methods help with this:"
125
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
126
- children: (0, _jsxRuntime.jsx)(_components.code, {
119
+ }), "\n", _jsx(_components.pre, {
120
+ children: _jsx(_components.code, {
127
121
  className: "language-js",
128
122
  children: "// 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"
129
123
  })
130
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
131
- children: ["To print without any prefix, use ", (0, _jsxRuntime.jsx)(_components.code, {
124
+ }), "\n", _jsxs(_components.p, {
125
+ children: ["To print without any prefix, use ", _jsx(_components.code, {
132
126
  children: "logger.console(message);"
133
127
  })]
134
- }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
128
+ }), "\n", _jsx(_components.h3, {
135
129
  children: "Long Running Process Logger"
136
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
137
- children: ["Run the following to get an instance of the ", (0, _jsxRuntime.jsx)(_components.code, {
130
+ }), "\n", _jsxs(_components.p, {
131
+ children: ["Run the following to get an instance of the ", _jsx(_components.code, {
138
132
  children: "LongProcessLogger"
139
133
  }), " and start logging the process description."]
140
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
141
- children: (0, _jsxRuntime.jsx)(_components.code, {
134
+ }), "\n", _jsx(_components.pre, {
135
+ children: _jsx(_components.code, {
142
136
  className: "language-js",
143
137
  children: "logger.createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;\n"
144
138
  })
145
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
146
- children: ["If the process involves iteration over a list of items, such as running tag on a list of components, then pass the ", (0, _jsxRuntime.jsx)(_components.code, {
139
+ }), "\n", _jsxs(_components.p, {
140
+ children: ["If the process involves iteration over a list of items, such as running tag on a list of components, then pass the ", _jsx(_components.code, {
147
141
  children: "totalItems"
148
142
  }), " as the total number of the components in the list."]
149
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
150
- children: ["Later, during the iteration, call ", (0, _jsxRuntime.jsx)(_components.code, {
143
+ }), "\n", _jsxs(_components.p, {
144
+ children: ["Later, during the iteration, call ", _jsx(_components.code, {
151
145
  children: "logProgress(componentName)"
152
- }), " on the ", (0, _jsxRuntime.jsx)(_components.code, {
146
+ }), " on the ", _jsx(_components.code, {
153
147
  children: "LongProcessLogger"
154
- }), " instance.\nonce done, call ", (0, _jsxRuntime.jsx)(_components.code, {
148
+ }), " instance.\nonce done, call ", _jsx(_components.code, {
155
149
  children: "end()"
156
150
  }), ", which logs the duration of the process in ms."]
157
- }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
151
+ }), "\n", _jsx(_components.p, {
158
152
  children: "Here is an example of the messages produced by this longProcessLogger. The status-line always shows the last message."
159
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
160
- children: (0, _jsxRuntime.jsx)(_components.code, {
153
+ }), "\n", _jsx(_components.pre, {
154
+ children: _jsx(_components.code, {
161
155
  className: "language-bash",
162
156
  children: "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"
163
157
  })
164
- }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
165
- children: ["An example when there is no ", (0, _jsxRuntime.jsx)(_components.code, {
158
+ }), "\n", _jsxs(_components.p, {
159
+ children: ["An example when there is no ", _jsx(_components.code, {
166
160
  children: "totalItems"
167
161
  }), "."]
168
- }), "\n", (0, _jsxRuntime.jsx)(_components.pre, {
169
- children: (0, _jsxRuntime.jsx)(_components.code, {
162
+ }), "\n", _jsx(_components.pre, {
163
+ children: _jsx(_components.code, {
170
164
  className: "language-bash",
171
165
  children: "teambit.workspace/workspace, loading components\nteambit.workspace/workspace, loading components (completed in 200ms)\n"
172
166
  })
173
167
  })]
174
168
  });
175
169
  }
176
- function MDXContent() {
170
+ export default function MDXContent() {
177
171
  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
178
- var _provideComponents$pr = _objectSpread(_objectSpread({}, (0, _react.useMDXComponents)()), props.components),
172
+ var _provideComponents$pr = _objectSpread(_objectSpread({}, _provideComponents()), props.components),
179
173
  MDXLayout = _provideComponents$pr.wrapper;
180
- return MDXLayout ? (0, _jsxRuntime.jsx)(MDXLayout, _objectSpread(_objectSpread({}, props), {}, {
181
- children: (0, _jsxRuntime.jsx)(_createMdxContent, _objectSpread({}, props))
174
+ return MDXLayout ? _jsx(MDXLayout, _objectSpread(_objectSpread({}, props), {}, {
175
+ children: _jsx(_createMdxContent, _objectSpread({}, props))
182
176
  })) : _createMdxContent(props);
183
177
  }
184
178
 
@@ -1 +1 @@
1
- {"version":3,"names":["_jsxRuntime","require","_react","_typeof","o","Symbol","iterator","constructor","prototype","ownKeys","e","r","t","Object","keys","getOwnPropertySymbols","filter","getOwnPropertyDescriptor","enumerable","push","apply","_objectSpread","arguments","length","forEach","_defineProperty","getOwnPropertyDescriptors","defineProperties","defineProperty","_toPropertyKey","value","configurable","writable","i","_toPrimitive","toPrimitive","call","TypeError","String","Number","MDXContent","isMDXComponent","_createMdxContent","props","_components","blockquote","code","h2","h3","p","pre","strong","_provideComponents","components","_jsxs","_Fragment","children","_jsx","className","undefined","_provideComponents$pr","MDXLayout","wrapper"],"sourceRoot":"/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.174","sources":["logger.mdx.js"],"sourcesContent":["MDXContent.isMDXComponent = true;\nimport {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from \"react/jsx-runtime\";\nimport {useMDXComponents as _provideComponents} from \"@mdx-js/react\";\nfunction _createMdxContent(props) {\n const _components = {\n blockquote: \"blockquote\",\n code: \"code\",\n h2: \"h2\",\n h3: \"h3\",\n p: \"p\",\n pre: \"pre\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h2, {\n children: \"Create a logger\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"In your extension, add \", _jsx(_components.code, {\n children: \"LoggerMain\"\n }), \" as a dependency and create a new logger by running\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n children: \"LoggerMain.createLogger('your-extension-id');\\n\"\n })\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Log to a file\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The following standard methods are available to log into a file. By default it's the \", _jsx(_components.code, {\n children: \"debug.log\"\n }), \" file located at \", _jsx(_components.code, {\n children: \"~/Library/Caches/Bit/logs\"\n }), \" for Mac/Linux or \", _jsx(_components.code, {\n children: \"%LOCALAPPDATA%\\\\Bit\"\n }), \" for Windows.\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-ts\",\n children: \"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\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"The message color is coded uniquely per extension-id. This way, it's easier to scroll the logs and distinguish between the extensions.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The format of the message logged to the file is \", _jsx(_components.strong, {\n children: \"\\\"TIMESTAMP LEVEL: EXT-ID, MSG [META]\\\"\"\n }), \". The \\\"[META]\\\" part is \", _jsx(_components.code, {\n children: \"JSON.stringify\"\n }), \" of the second parameter in case it's an object. Otherwise, it's ignored.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"JSON format is available as well. To use it, run \", _jsx(_components.code, {\n children: \"bit config set log_json_format true\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"It's possible to have the console as an extra layer so these messages will be printed to the screen as well, see below.\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Log stack trace\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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. \", _jsx(_components.code, {\n children: \"catch(err) { logger.error('got an error during component-load', err); }\"\n })]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Log also to the console\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To see the same massages above printed into the screen, use the global flag \", _jsx(_components.code, {\n children: \"--log [level]\"\n }), \". For example, \", _jsx(_components.code, {\n children: \"bit status --log=error\"\n }), \". If the level was not entered, it defaults to \", _jsx(_components.code, {\n children: \"info\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Alternatively, you can set an environment variable \", _jsx(_components.code, {\n children: \"BIT_LOG\"\n }), \" with the desired level.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The format of the message logged to the console is \", _jsx(_components.strong, {\n children: \"\\\"MSG [META]\\\"\"\n }), \" The \\\"[META]\\\" part is the same as above.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Report progress\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"console.log\"\n }), \" to not break the output (or potentially the JSON structure).\"]\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"--json\"\n }), \" flag. To specifically disable console-printing to a command, set the \", _jsx(_components.code, {\n children: \"loader\"\n }), \" property to \", _jsx(_components.code, {\n children: \"false\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Status Line (spinner)\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"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.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"To set the text of this status-line, call:\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"logger.setStatusLine((text: string));\\n\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"logger.clearStatusLine()\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Persist text\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Sometimes it's helpful to indicate that a phase has completed. Either successfully or failed. The following methods help with this:\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"// 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\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To print without any prefix, use \", _jsx(_components.code, {\n children: \"logger.console(message);\"\n })]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Long Running Process Logger\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Run the following to get an instance of the \", _jsx(_components.code, {\n children: \"LongProcessLogger\"\n }), \" and start logging the process description.\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"logger.createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;\\n\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the process involves iteration over a list of items, such as running tag on a list of components, then pass the \", _jsx(_components.code, {\n children: \"totalItems\"\n }), \" as the total number of the components in the list.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Later, during the iteration, call \", _jsx(_components.code, {\n children: \"logProgress(componentName)\"\n }), \" on the \", _jsx(_components.code, {\n children: \"LongProcessLogger\"\n }), \" instance.\\nonce done, call \", _jsx(_components.code, {\n children: \"end()\"\n }), \", which logs the duration of the process in ms.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Here is an example of the messages produced by this longProcessLogger. The status-line always shows the last message.\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-bash\",\n children: \"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\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An example when there is no \", _jsx(_components.code, {\n children: \"totalItems\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-bash\",\n children: \"teambit.workspace/workspace, loading components\\nteambit.workspace/workspace, loading components (completed in 200ms)\\n\"\n })\n })]\n });\n}\nexport default function MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\n"],"mappings":";;;;;;AACA,IAAAA,WAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AAAqE,SAAAE,QAAAC,CAAA,sCAAAD,OAAA,wBAAAE,MAAA,uBAAAA,MAAA,CAAAC,QAAA,aAAAF,CAAA,kBAAAA,CAAA,gBAAAA,CAAA,WAAAA,CAAA,yBAAAC,MAAA,IAAAD,CAAA,CAAAG,WAAA,KAAAF,MAAA,IAAAD,CAAA,KAAAC,MAAA,CAAAG,SAAA,qBAAAJ,CAAA,KAAAD,OAAA,CAAAC,CAAA;AAAA,SAAAK,QAAAC,CAAA,EAAAC,CAAA,QAAAC,CAAA,GAAAC,MAAA,CAAAC,IAAA,CAAAJ,CAAA,OAAAG,MAAA,CAAAE,qBAAA,QAAAX,CAAA,GAAAS,MAAA,CAAAE,qBAAA,CAAAL,CAAA,GAAAC,CAAA,KAAAP,CAAA,GAAAA,CAAA,CAAAY,MAAA,WAAAL,CAAA,WAAAE,MAAA,CAAAI,wBAAA,CAAAP,CAAA,EAAAC,CAAA,EAAAO,UAAA,OAAAN,CAAA,CAAAO,IAAA,CAAAC,KAAA,CAAAR,CAAA,EAAAR,CAAA,YAAAQ,CAAA;AAAA,SAAAS,cAAAX,CAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAW,SAAA,CAAAC,MAAA,EAAAZ,CAAA,UAAAC,CAAA,WAAAU,SAAA,CAAAX,CAAA,IAAAW,SAAA,CAAAX,CAAA,QAAAA,CAAA,OAAAF,OAAA,CAAAI,MAAA,CAAAD,CAAA,OAAAY,OAAA,WAAAb,CAAA,IAAAc,eAAA,CAAAf,CAAA,EAAAC,CAAA,EAAAC,CAAA,CAAAD,CAAA,SAAAE,MAAA,CAAAa,yBAAA,GAAAb,MAAA,CAAAc,gBAAA,CAAAjB,CAAA,EAAAG,MAAA,CAAAa,yBAAA,CAAAd,CAAA,KAAAH,OAAA,CAAAI,MAAA,CAAAD,CAAA,GAAAY,OAAA,WAAAb,CAAA,IAAAE,MAAA,CAAAe,cAAA,CAAAlB,CAAA,EAAAC,CAAA,EAAAE,MAAA,CAAAI,wBAAA,CAAAL,CAAA,EAAAD,CAAA,iBAAAD,CAAA;AAAA,SAAAe,gBAAAf,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAkB,cAAA,CAAAlB,CAAA,MAAAD,CAAA,GAAAG,MAAA,CAAAe,cAAA,CAAAlB,CAAA,EAAAC,CAAA,IAAAmB,KAAA,EAAAlB,CAAA,EAAAM,UAAA,MAAAa,YAAA,MAAAC,QAAA,UAAAtB,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAmB,eAAAjB,CAAA,QAAAqB,CAAA,GAAAC,YAAA,CAAAtB,CAAA,gCAAAT,OAAA,CAAA8B,CAAA,IAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAtB,CAAA,EAAAD,CAAA,oBAAAR,OAAA,CAAAS,CAAA,MAAAA,CAAA,SAAAA,CAAA,MAAAF,CAAA,GAAAE,CAAA,CAAAP,MAAA,CAAA8B,WAAA,kBAAAzB,CAAA,QAAAuB,CAAA,GAAAvB,CAAA,CAAA0B,IAAA,CAAAxB,CAAA,EAAAD,CAAA,gCAAAR,OAAA,CAAA8B,CAAA,UAAAA,CAAA,YAAAI,SAAA,yEAAA1B,CAAA,GAAA2B,MAAA,GAAAC,MAAA,EAAA3B,CAAA;AAFrE4B,UAAU,CAACC,cAAc,GAAG,IAAI;AAGhC,SAASC,iBAAiBA,CAACC,KAAK,EAAE;EAChC,IAAMC,WAAW,GAAAvB,aAAA,CAAAA,aAAA;IACfwB,UAAU,EAAE,YAAY;IACxBC,IAAI,EAAE,MAAM;IACZC,EAAE,EAAE,IAAI;IACRC,EAAE,EAAE,IAAI;IACRC,CAAC,EAAE,GAAG;IACNC,GAAG,EAAE,KAAK;IACVC,MAAM,EAAE;EAAQ,GACb,IAAAC,uBAAkB,EAAC,CAAC,GACpBT,KAAK,CAACU,UAAU,CACpB;EACD,OAAO,IAAAC,gBAAK,EAACC,oBAAS,EAAE;IACtBC,QAAQ,EAAE,CAAC,IAAAC,eAAI,EAACb,WAAW,CAACG,EAAE,EAAE;MAC9BS,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,yBAAyB,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC3DU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,qDAAqD;IAC3D,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BU,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACG,EAAE,EAAE;MAC7BS,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,uFAAuF,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACzHU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC9CU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,oBAAoB,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/CU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,eAAe;IACrB,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,aAAa;QACxBF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,kDAAkD,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACO,MAAM,EAAE;QACtFK,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,2BAA2B,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACtDU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,2EAA2E;IACjF,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,mDAAmD,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACrFU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACI,EAAE,EAAE;MAC7BQ,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,qVAAqV,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACvXU,QAAQ,EAAE;MACZ,CAAC,CAAC;IACJ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACI,EAAE,EAAE;MAC7BQ,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,8EAA8E,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAChHU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iBAAiB,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC5CU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iDAAiD,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC5EU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,qDAAqD,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACvFU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,0BAA0B;IAChC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,qDAAqD,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACO,MAAM,EAAE;QACzFK,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,4CAA4C;IAClD,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACG,EAAE,EAAE;MAC7BS,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,oMAAoM,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACtOU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,+DAA+D;IACrE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACC,UAAU,EAAE;MACtCW,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;QACpCO,QAAQ,EAAE,CAAC,8LAA8L,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;UAChOU,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,wEAAwE,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;UACnGU,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,eAAe,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;UAC1CU,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,GAAG;MACT,CAAC,CAAC,EAAE,IAAI;IACV,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACI,EAAE,EAAE;MAC7BQ,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,aAAa;QACxBF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,yMAAyM,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC3OU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACI,EAAE,EAAE;MAC7BQ,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,aAAa;QACxBF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,mCAAmC,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACrEU,QAAQ,EAAE;MACZ,CAAC,CAAC;IACJ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACI,EAAE,EAAE;MAC7BQ,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,8CAA8C,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAChFU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,6CAA6C;IACnD,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,aAAa;QACxBF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,qHAAqH,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACvJU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,qDAAqD;IAC3D,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,oCAAoC,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACtEU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,UAAU,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACrCU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,8BAA8B,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QACzDU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iDAAiD;IACvD,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACK,CAAC,EAAE;MAC5BO,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,eAAe;QAC1BF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAF,gBAAK,EAACV,WAAW,CAACK,CAAC,EAAE;MAC7BO,QAAQ,EAAE,CAAC,8BAA8B,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAChEU,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACM,GAAG,EAAE;MAC9BM,QAAQ,EAAE,IAAAC,eAAI,EAACb,WAAW,CAACE,IAAI,EAAE;QAC/BY,SAAS,EAAE,eAAe;QAC1BF,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ;AACe,SAAShB,UAAUA,CAAA,EAAa;EAAA,IAAZG,KAAK,GAAArB,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAqC,SAAA,GAAArC,SAAA,MAAG,CAAC,CAAC;EAC3C,IAAAsC,qBAAA,GAAAvC,aAAA,CAAAA,aAAA,KACK,IAAA+B,uBAAkB,EAAC,CAAC,GACpBT,KAAK,CAACU,UAAU;IAFLQ,SAAS,GAAAD,qBAAA,CAAlBE,OAAO;EAId,OAAOD,SAAS,GAAG,IAAAJ,eAAI,EAACI,SAAS,EAAAxC,aAAA,CAAAA,aAAA,KAC5BsB,KAAK;IACRa,QAAQ,EAAE,IAAAC,eAAI,EAACf,iBAAiB,EAAArB,aAAA,KAC3BsB,KAAK,CACT;EAAC,EACH,CAAC,GAAGD,iBAAiB,CAACC,KAAK,CAAC;AAC/B","ignoreList":[]}
1
+ {"version":3,"names":["MDXContent","isMDXComponent","Fragment","_Fragment","jsx","_jsx","jsxs","_jsxs","useMDXComponents","_provideComponents","_createMdxContent","props","_components","_objectSpread","blockquote","code","h2","h3","p","pre","strong","components","children","className","arguments","length","undefined","_provideComponents$pr","MDXLayout","wrapper"],"sourceRoot":"/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.176","sources":["logger.mdx.js"],"sourcesContent":["MDXContent.isMDXComponent = true;\nimport {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from \"react/jsx-runtime\";\nimport {useMDXComponents as _provideComponents} from \"@mdx-js/react\";\nfunction _createMdxContent(props) {\n const _components = {\n blockquote: \"blockquote\",\n code: \"code\",\n h2: \"h2\",\n h3: \"h3\",\n p: \"p\",\n pre: \"pre\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h2, {\n children: \"Create a logger\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"In your extension, add \", _jsx(_components.code, {\n children: \"LoggerMain\"\n }), \" as a dependency and create a new logger by running\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n children: \"LoggerMain.createLogger('your-extension-id');\\n\"\n })\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Log to a file\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The following standard methods are available to log into a file. By default it's the \", _jsx(_components.code, {\n children: \"debug.log\"\n }), \" file located at \", _jsx(_components.code, {\n children: \"~/Library/Caches/Bit/logs\"\n }), \" for Mac/Linux or \", _jsx(_components.code, {\n children: \"%LOCALAPPDATA%\\\\Bit\"\n }), \" for Windows.\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-ts\",\n children: \"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\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"The message color is coded uniquely per extension-id. This way, it's easier to scroll the logs and distinguish between the extensions.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The format of the message logged to the file is \", _jsx(_components.strong, {\n children: \"\\\"TIMESTAMP LEVEL: EXT-ID, MSG [META]\\\"\"\n }), \". The \\\"[META]\\\" part is \", _jsx(_components.code, {\n children: \"JSON.stringify\"\n }), \" of the second parameter in case it's an object. Otherwise, it's ignored.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"JSON format is available as well. To use it, run \", _jsx(_components.code, {\n children: \"bit config set log_json_format true\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"It's possible to have the console as an extra layer so these messages will be printed to the screen as well, see below.\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Log stack trace\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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. \", _jsx(_components.code, {\n children: \"catch(err) { logger.error('got an error during component-load', err); }\"\n })]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Log also to the console\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To see the same massages above printed into the screen, use the global flag \", _jsx(_components.code, {\n children: \"--log [level]\"\n }), \". For example, \", _jsx(_components.code, {\n children: \"bit status --log=error\"\n }), \". If the level was not entered, it defaults to \", _jsx(_components.code, {\n children: \"info\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Alternatively, you can set an environment variable \", _jsx(_components.code, {\n children: \"BIT_LOG\"\n }), \" with the desired level.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The format of the message logged to the console is \", _jsx(_components.strong, {\n children: \"\\\"MSG [META]\\\"\"\n }), \" The \\\"[META]\\\" part is the same as above.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Report progress\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"console.log\"\n }), \" to not break the output (or potentially the JSON structure).\"]\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"--json\"\n }), \" flag. To specifically disable console-printing to a command, set the \", _jsx(_components.code, {\n children: \"loader\"\n }), \" property to \", _jsx(_components.code, {\n children: \"false\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Status Line (spinner)\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"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.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"To set the text of this status-line, call:\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"logger.setStatusLine((text: string));\\n\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"logger.clearStatusLine()\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Persist text\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Sometimes it's helpful to indicate that a phase has completed. Either successfully or failed. The following methods help with this:\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"// 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\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To print without any prefix, use \", _jsx(_components.code, {\n children: \"logger.console(message);\"\n })]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Long Running Process Logger\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Run the following to get an instance of the \", _jsx(_components.code, {\n children: \"LongProcessLogger\"\n }), \" and start logging the process description.\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-js\",\n children: \"logger.createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;\\n\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the process involves iteration over a list of items, such as running tag on a list of components, then pass the \", _jsx(_components.code, {\n children: \"totalItems\"\n }), \" as the total number of the components in the list.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Later, during the iteration, call \", _jsx(_components.code, {\n children: \"logProgress(componentName)\"\n }), \" on the \", _jsx(_components.code, {\n children: \"LongProcessLogger\"\n }), \" instance.\\nonce done, call \", _jsx(_components.code, {\n children: \"end()\"\n }), \", which logs the duration of the process in ms.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Here is an example of the messages produced by this longProcessLogger. The status-line always shows the last message.\"\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-bash\",\n children: \"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\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An example when there is no \", _jsx(_components.code, {\n children: \"totalItems\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.pre, {\n children: _jsx(_components.code, {\n className: \"language-bash\",\n children: \"teambit.workspace/workspace, loading components\\nteambit.workspace/workspace, loading components (completed in 200ms)\\n\"\n })\n })]\n });\n}\nexport default function MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\n"],"mappings":";;;;;;AAAAA,UAAU,CAACC,cAAc,GAAG,IAAI;AAChC,SAAQC,QAAQ,IAAIC,SAAS,EAAEC,GAAG,IAAIC,IAAI,EAAEC,IAAI,IAAIC,KAAK,QAAO,mBAAmB;AACnF,SAAQC,gBAAgB,IAAIC,kBAAkB,QAAO,eAAe;AACpE,SAASC,iBAAiBA,CAACC,KAAK,EAAE;EAChC,IAAMC,WAAW,GAAAC,aAAA,CAAAA,aAAA;IACfC,UAAU,EAAE,YAAY;IACxBC,IAAI,EAAE,MAAM;IACZC,EAAE,EAAE,IAAI;IACRC,EAAE,EAAE,IAAI;IACRC,CAAC,EAAE,GAAG;IACNC,GAAG,EAAE,KAAK;IACVC,MAAM,EAAE;EAAQ,GACbX,kBAAkB,CAAC,CAAC,GACpBE,KAAK,CAACU,UAAU,CACpB;EACD,OAAOd,KAAK,CAACJ,SAAS,EAAE;IACtBmB,QAAQ,EAAE,CAACjB,IAAI,CAACO,WAAW,CAACI,EAAE,EAAE;MAC9BM,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,yBAAyB,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC3DO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,qDAAqD;IAC3D,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BO,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACI,EAAE,EAAE;MAC7BM,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,uFAAuF,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACzHO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,mBAAmB,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC9CO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,oBAAoB,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/CO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,eAAe;IACrB,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,aAAa;QACxBD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,kDAAkD,EAAEjB,IAAI,CAACO,WAAW,CAACQ,MAAM,EAAE;QACtFE,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,2BAA2B,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACtDO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,2EAA2E;IACjF,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,mDAAmD,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACrFO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACK,EAAE,EAAE;MAC7BK,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,qVAAqV,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACvXO,QAAQ,EAAE;MACZ,CAAC,CAAC;IACJ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACK,EAAE,EAAE;MAC7BK,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,8EAA8E,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAChHO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iBAAiB,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC5CO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iDAAiD,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC5EO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,qDAAqD,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACvFO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,0BAA0B;IAChC,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,qDAAqD,EAAEjB,IAAI,CAACO,WAAW,CAACQ,MAAM,EAAE;QACzFE,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,4CAA4C;IAClD,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACI,EAAE,EAAE;MAC7BM,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,oMAAoM,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACtOO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,+DAA+D;IACrE,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACE,UAAU,EAAE;MACtCQ,QAAQ,EAAE,CAAC,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;QACpCI,QAAQ,EAAE,CAAC,8LAA8L,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;UAChOO,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,wEAAwE,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;UACnGO,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,eAAe,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;UAC1CO,QAAQ,EAAE;QACZ,CAAC,CAAC,EAAE,GAAG;MACT,CAAC,CAAC,EAAE,IAAI;IACV,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACK,EAAE,EAAE;MAC7BK,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,aAAa;QACxBD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,yMAAyM,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC3OO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACK,EAAE,EAAE;MAC7BK,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,aAAa;QACxBD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,mCAAmC,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACrEO,QAAQ,EAAE;MACZ,CAAC,CAAC;IACJ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACK,EAAE,EAAE;MAC7BK,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,8CAA8C,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAChFO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,6CAA6C;IACnD,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,aAAa;QACxBD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,qHAAqH,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACvJO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,qDAAqD;IAC3D,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,oCAAoC,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACtEO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,UAAU,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACrCO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,8BAA8B,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QACzDO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,iDAAiD;IACvD,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACM,CAAC,EAAE;MAC5BI,QAAQ,EAAE;IACZ,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,eAAe;QAC1BD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC,EAAE,IAAI,EAAEf,KAAK,CAACK,WAAW,CAACM,CAAC,EAAE;MAC7BI,QAAQ,EAAE,CAAC,8BAA8B,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAChEO,QAAQ,EAAE;MACZ,CAAC,CAAC,EAAE,GAAG;IACT,CAAC,CAAC,EAAE,IAAI,EAAEjB,IAAI,CAACO,WAAW,CAACO,GAAG,EAAE;MAC9BG,QAAQ,EAAEjB,IAAI,CAACO,WAAW,CAACG,IAAI,EAAE;QAC/BQ,SAAS,EAAE,eAAe;QAC1BD,QAAQ,EAAE;MACZ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ;AACA,eAAe,SAAStB,UAAUA,CAAA,EAAa;EAAA,IAAZW,KAAK,GAAAa,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAC3C,IAAAG,qBAAA,GAAAd,aAAA,CAAAA,aAAA,KACKJ,kBAAkB,CAAC,CAAC,GACpBE,KAAK,CAACU,UAAU;IAFLO,SAAS,GAAAD,qBAAA,CAAlBE,OAAO;EAId,OAAOD,SAAS,GAAGvB,IAAI,CAACuB,SAAS,EAAAf,aAAA,CAAAA,aAAA,KAC5BF,KAAK;IACRW,QAAQ,EAAEjB,IAAI,CAACK,iBAAiB,EAAAG,aAAA,KAC3BF,KAAK,CACT;EAAC,EACH,CAAC,GAAGD,iBAAiB,CAACC,KAAK,CAAC;AAC/B","ignoreList":[]}
@@ -1,5 +1,5 @@
1
- import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.174/dist/logger.composition.js';
2
- import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.174/dist/logger.docs.mdx';
1
+ import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.176/dist/logger.composition.js';
2
+ import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.harmony_aspect-docs_logger@0.0.176/dist/logger.docs.mdx';
3
3
 
4
4
  export const compositions = [compositions_0];
5
5
  export const overview = [overview_0];
package/package.json CHANGED
@@ -1,32 +1,24 @@
1
1
  {
2
2
  "name": "@teambit/harmony.aspect-docs.logger",
3
- "version": "0.0.174",
3
+ "version": "0.0.176",
4
4
  "homepage": "https://bit.cloud/teambit/harmony/aspect-docs/logger",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.harmony",
8
8
  "name": "aspect-docs/logger",
9
- "version": "0.0.174"
10
- },
11
- "dependencies": {
12
- "core-js": "^3.0.0",
13
- "@mdx-js/react": "1.6.22",
14
- "@teambit/mdx.ui.mdx-scope-context": "1.0.0"
9
+ "version": "0.0.176"
15
10
  },
11
+ "dependencies": {},
16
12
  "devDependencies": {
17
- "@types/react": "^19.0.0",
18
13
  "@types/mocha": "9.1.0",
19
- "@types/node": "12.20.4",
20
- "@types/react-dom": "^19.0.0",
21
- "@types/jest": "^26.0.0",
22
- "@babel/runtime": "7.20.0",
23
- "@types/testing-library__jest-dom": "5.9.5",
24
- "@teambit/documenter.theme.theme-compositions": "4.1.5",
25
- "@teambit/mdx.ui.mdx-layout": "1.0.12"
14
+ "@types/jest": "^29.2.2",
15
+ "@types/testing-library__jest-dom": "^5.9.5",
16
+ "@teambit/mdx.mdx-env": "3.0.1"
26
17
  },
27
18
  "peerDependencies": {
28
- "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
29
- "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
19
+ "react": "^17.0.0 || ^18.0.0",
20
+ "@teambit/mdx.ui.mdx-layout": "^1.0.12",
21
+ "@teambit/documenter.theme.theme-compositions": "^4.1.5"
30
22
  },
31
23
  "license": "Apache-2.0",
32
24
  "optionalDependencies": {},
package/types/asset.d.ts CHANGED
@@ -5,7 +5,9 @@ declare module '*.png' {
5
5
  declare module '*.svg' {
6
6
  import type { FunctionComponent, SVGProps } from 'react';
7
7
 
8
- export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
8
+ export const ReactComponent: FunctionComponent<
9
+ SVGProps<SVGSVGElement> & { title?: string }
10
+ >;
9
11
  const src: string;
10
12
  export default src;
11
13
  }
@@ -27,3 +29,15 @@ declare module '*.bmp' {
27
29
  const value: any;
28
30
  export = value;
29
31
  }
32
+ declare module '*.otf' {
33
+ const value: any;
34
+ export = value;
35
+ }
36
+ declare module '*.woff' {
37
+ const value: any;
38
+ export = value;
39
+ }
40
+ declare module '*.woff2' {
41
+ const value: any;
42
+ export = value;
43
+ }