@teambit/logger 0.0.470 → 0.0.471

package/dist/logger.d.ts

@@ -10,16 +10,49 @@ export declare class Logger implements IBitLogger {
     error(message: string, ...meta: any[]): void;
     fatal(message: string, ...meta: any[]): void;
     get isLoaderStarted(): boolean;
+    /**
+     * use it for a long running process. upon creation it logs the `processDescription`.
+     * if the process involves iteration over a list of items, such as running tag on a list of
+     * components, then pass the `totalItems` as the total of the total components in the list.
+     * later, during the iteration, call `LongProcessLogger.logProgress(componentName)`.
+     * once done, call `LongProcessLogger.end()`
+     * the status-line will show all messages in the terminal.
+     */
     createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;
+    /**
+     * single status-line on the bottom of the screen.
+     * the text is replaced every time this method is called.
+     */
     setStatusLine(text: string): void;
+    /**
+     * remove the text from the last line on the screen.
+     */
     clearStatusLine(): void;
+    /**
+     * print to the screen. if message is empty, print the last logged message.
+     */
     console(message?: string): void;
+    /**
+     * print to the screen as a title, with bold text.
+     */
     consoleTitle(message: string): void;
+    /**
+     * print to the screen with a green `✔` prefix. if message is empty, print the last logged message.
+     */
     consoleSuccess(message?: string): void;
+    /**
+     * turn off the logger.
+     */
     off(): import("@teambit/legacy/dist/cli/loader/loader").Loader;
     on(): import("@teambit/legacy/dist/cli/loader/loader").Loader;
     profile(id: string, console?: boolean): void;
+    /**
+     * print to the screen with a red `✖` prefix. if message is empty, print the last logged message.
+     */
     consoleFailure(message?: string): void;
+    /**
+     * print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.
+     */
     consoleWarning(message?: string): void;
     private colorMessage;
 }

package/dist/long-process-logger.d.ts

@@ -1,4 +1,13 @@
 import type { Logger } from './logger';
+/**
+ * use it for a long running process. upon creation it logs the `processDescription`.
+ * if the process involves iteration over a list of items, such as running tag on a list of
+ * components, then pass the `totalItems` as the total components in the list.
+ * later, during the iteration, call `logProgress(componentName)`.
+ * once done, call `end()`.
+ * the status-line will show all messages in the terminal.
+ * see README for more data.
+ */
 export declare class LongProcessLogger {
     private logPublisher;
     private extensionName;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/logger",
-  "version": "0.0.470",
+  "version": "0.0.471",
   "homepage": "https://bit.dev/teambit/harmony/logger",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "logger",
-    "version": "0.0.470"
+    "version": "0.0.471"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -15,7 +15,7 @@
     "pretty-time": "1.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.385"
+    "@teambit/cli": "0.0.386"
   },
   "devDependencies": {
     "@types/mocha": "5.2.7",
@@ -24,10 +24,10 @@
     "@types/react-dom": "^17.0.5",
     "@types/react": "^17.0.8",
     "@types/node": "12.20.4",
-    "@teambit/harmony.aspect-docs.logger": "0.0.104"
+    "@teambit/harmony.aspect-docs.logger": "0.0.105"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -55,7 +55,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },