@teambit/logger 0.0.932 → 0.0.933

package/dist/logger.composition.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const Logo: () => React.JSX.Element;
+/// <reference types="react" />
+export declare const Logo: () => JSX.Element;

package/dist/logger.main.runtime.d.ts

@@ -1,7 +1,7 @@
 import { Logger } from './logger';
 export declare class LoggerMain {
     static runtime: import("@teambit/harmony").RuntimeDefinition;
-    static dependencies: never[];
+    static dependencies: any[];
     createLogger(extensionName: string): Logger;
     static provider(): Promise<LoggerMain>;
 }

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

@@ -1,5 +1,5 @@
 import type { Logger } from './logger';
-export declare type ConsoleOnStart = 'normal' | 'title';
+export type ConsoleOnStart = 'normal' | 'title';
 /**
  * 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
@@ -16,7 +16,7 @@ export declare class LongProcessLogger {
     private totalItems?;
     private currentItem;
     private startTime;
-    constructor(logPublisher: Logger, extensionName: string, processDescription: string, totalItems?: number | undefined, shouldConsole?: ConsoleOnStart);
+    constructor(logPublisher: Logger, extensionName: string, processDescription: string, totalItems?: number, shouldConsole?: ConsoleOnStart);
     logProgress(itemName?: string, showProcessDescription?: boolean): void;
     end(shouldConsole?: 'success' | 'error'): void;
     getProgress(): string;

package/dist/{preview-1703505948637.js → preview-1703647408454.js}

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

package/index.ts

@@ -0,0 +1,4 @@
+export { Logger } from './logger';
+export type { LoggerMain } from './logger.main.runtime';
+export { LoggerAspect } from './logger.aspect';
+export { LongProcessLogger } from './long-process-logger';

package/logger.aspect.ts

@@ -0,0 +1,7 @@
+import { Aspect } from '@teambit/harmony';
+
+export const LoggerAspect = Aspect.create({
+  id: 'teambit.harmony/logger',
+  dependencies: [],
+  defaultConfig: {},
+});

package/logger.main.runtime.ts

@@ -0,0 +1,19 @@
+import { MainRuntime } from '@teambit/cli';
+
+import { Logger } from './logger';
+import { LoggerAspect } from './logger.aspect';
+
+export class LoggerMain {
+  static runtime = MainRuntime;
+  static dependencies = [];
+
+  createLogger(extensionName: string): Logger {
+    return new Logger(extensionName);
+  }
+
+  static async provider() {
+    return new LoggerMain();
+  }
+}
+
+LoggerAspect.addRuntime(LoggerMain);

package/logger.ts

@@ -0,0 +1,154 @@
+import loader from '@teambit/legacy/dist/cli/loader';
+import logger, { IBitLogger } from '@teambit/legacy/dist/logger/logger';
+import chalk from 'chalk';
+
+import { ConsoleOnStart, LongProcessLogger } from './long-process-logger';
+
+export class Logger implements IBitLogger {
+  constructor(private extensionName: string) {}
+
+  trace(message: string, ...meta: any[]) {
+    logger.trace(this.colorMessage(message), ...meta);
+  }
+  debug(message: string, ...meta: any[]) {
+    logger.debug(this.colorMessage(message), ...meta);
+  }
+  info(message: string, ...meta: any[]) {
+    logger.info(this.colorMessage(message), ...meta);
+  }
+  warn(message: string, ...meta: any[]) {
+    logger.warn(this.colorMessage(message), ...meta);
+  }
+  error(message: string, ...meta: any[]) {
+    logger.error(this.colorMessage(message), ...meta);
+  }
+  fatal(message: string, ...meta: any[]) {
+    logger.fatal(this.colorMessage(message), ...meta);
+  }
+
+  get isLoaderStarted() {
+    return loader.isStarted;
+  }
+  /**
+   * 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,
+    shouldConsole?: ConsoleOnStart
+  ): LongProcessLogger {
+    return new LongProcessLogger(this, this.extensionName, processDescription, totalItems, shouldConsole);
+  }
+  /**
+   * single status-line on the bottom of the screen.
+   * the text is replaced every time this method is called.
+   */
+  setStatusLine(text: string, shouldPrintOnCI = false) {
+    if (process.env.CI && !shouldPrintOnCI) return;
+    loader.setTextAndRestart(text);
+  }
+  /**
+   * remove the text from the last line on the screen.
+   */
+  clearStatusLine() {
+    loader.stop();
+  }
+  /**
+   * print to the screen. if message is empty, print the last logged message.
+   */
+  console(message?: string, ...meta: any[]) {
+    if (message) this.info(message, meta);
+    if (!loader.isStarted && logger.shouldWriteToConsole) {
+      // eslint-disable-next-line no-console
+      console.log(message, ...meta);
+    } else {
+      loader.stopAndPersist({ text: message });
+    }
+  }
+
+  /**
+   * @deprecated
+   * try using consoleWarning. if not possible, rename this method to a clearer one
+   */
+  consoleWarn(message?: string, ...meta: any[]) {
+    if (message) this.warn(message, ...meta);
+    if (!loader.isStarted && logger.shouldWriteToConsole) {
+      // eslint-disable-next-line no-console
+      console.warn(message, ...meta);
+    } else {
+      loader.stopAndPersist({ text: message });
+    }
+  }
+
+  /**
+   * @deprecated
+   * try using consoleFailure. if not possible, rename this method to a clearer one
+   */
+  consoleError(message?: string, ...meta: any[]) {
+    if (message) this.error(message, ...meta);
+    if (!loader.isStarted && logger.shouldWriteToConsole) {
+      // eslint-disable-next-line no-console
+      console.error(message, ...meta);
+    } else {
+      loader.stopAndPersist({ text: message });
+    }
+  }
+
+  /**
+   * print to the screen as a title, with bold text.
+   */
+  consoleTitle(message: string) {
+    this.info(message);
+    loader.stopAndPersist({ text: chalk.bold(message) });
+  }
+  /**
+   * print to the screen with a green `✔` prefix. if message is empty, print the last logged message.
+   */
+  consoleSuccess(message?: string, startTime?: [number, number]) {
+    if (message) this.info(message);
+    loader.succeed(message, startTime);
+  }
+
+  /**
+   * turn off the logger.
+   */
+  off() {
+    return loader.off();
+  }
+
+  on() {
+    return loader.on();
+  }
+
+  profile(id: string, console?: boolean) {
+    logger.profile(id, console);
+  }
+
+  /**
+   * print to the screen with a red `✖` prefix. if message is empty, print the last logged message.
+   */
+  consoleFailure(message?: string) {
+    if (message) this.error(message);
+    loader.fail(message);
+  }
+  /**
+   * print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.
+   */
+  consoleWarning(message?: string) {
+    if (message) {
+      this.warn(message);
+      message = chalk.yellow(message);
+    }
+    loader.warn(message);
+  }
+
+  private colorMessage(message: string) {
+    if (logger.isJsonFormat) return `${this.extensionName}, ${message}`;
+    return `${chalk.bold(this.extensionName)}, ${message}`;
+  }
+}

package/long-process-logger.ts

@@ -0,0 +1,63 @@
+import prettyTime from 'pretty-time';
+import type { Logger } from './logger';
+
+export type ConsoleOnStart = 'normal' | 'title';
+
+/**
+ * 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 class LongProcessLogger {
+  private currentItem = 0;
+  private startTime = process.hrtime();
+  constructor(
+    private logPublisher: Logger,
+    private extensionName: string,
+    private processDescription: string,
+    private totalItems?: number,
+    shouldConsole?: ConsoleOnStart
+  ) {
+    this.start(shouldConsole);
+  }
+
+  logProgress(itemName = '', showProcessDescription = true) {
+    this.currentItem += 1;
+    const processDesc = showProcessDescription ? `${this.processDescription} ` : '';
+    const message = `${processDesc}${this.getProgress()} ${itemName}`;
+    this.logPublisher.debug(message);
+    this.logPublisher.setStatusLine(message, true);
+  }
+
+  end(shouldConsole?: 'success' | 'error') {
+    if (process.env.CI && !shouldConsole) shouldConsole = 'success';
+    const description = this.processDescription;
+    const duration = process.hrtime(this.startTime);
+    const completedOrFailedStr = !shouldConsole || shouldConsole === 'success' ? 'Succeeded' : 'Failed';
+    const message = `${description}. ${completedOrFailedStr} in ${prettyTime(duration)}`;
+    this.logPublisher.info(message);
+    if (shouldConsole) {
+      if (shouldConsole === 'success') this.logPublisher.consoleSuccess(message);
+      else this.logPublisher.consoleFailure(message);
+    } else this.logPublisher.setStatusLine(message);
+  }
+
+  getProgress() {
+    return `(${this.currentItem}/${this.totalItems})`;
+  }
+
+  private start(shouldConsole?: ConsoleOnStart) {
+    if (process.env.CI && !shouldConsole) shouldConsole = 'normal';
+    const totalItemsStr = this.totalItems ? `(total: ${this.totalItems})` : '';
+    const message = `${this.processDescription} ${totalItemsStr}`;
+    this.logPublisher.info(message);
+    if (shouldConsole) {
+      if (shouldConsole === 'title') this.logPublisher.consoleTitle(message);
+      else this.logPublisher.console(message);
+    } else this.logPublisher.setStatusLine(message);
+  }
+}

package/package.json

@@ -1,34 +1,30 @@
 {
   "name": "@teambit/logger",
-  "version": "0.0.932",
+  "version": "0.0.933",
   "homepage": "https://bit.cloud/teambit/harmony/logger",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "logger",
-    "version": "0.0.932"
+    "version": "0.0.933"
   },
   "dependencies": {
     "chalk": "2.4.2",
     "pretty-time": "1.1.0",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.839"
+    "@teambit/cli": "0.0.840"
   },
   "devDependencies": {
-    "@types/react": "^17.0.8",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5",
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13",
     "@teambit/harmony.aspect-docs.logger": "0.0.165"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "@types/react": "^18.2.12",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -42,7 +38,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -51,12 +47,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}