@teambit/logger 0.0.469 → 0.0.473

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.469",
+  "version": "0.0.473",
   "homepage": "https://bit.dev/teambit/harmony/logger",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "logger",
-    "version": "0.0.469"
+    "version": "0.0.473"
   },
   "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.384"
+    "@teambit/cli": "0.0.388"
   },
   "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.103"
+    "@teambit/harmony.aspect-docs.logger": "0.0.107"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.170",
+    "@teambit/legacy": "1.0.174",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -55,12 +55,20 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.170",
+        "@teambit/legacy": "1.0.174",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx",
+    "*.js",
+    "*.json"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },

package/index.ts

@@ -1,4 +0,0 @@
-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

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

package/logger.docs.mdx

@@ -1,8 +0,0 @@
----
-description: Modern logging for component-driven applications.
-labels: ['logger', 'component-based', 'bit']
----
-
-import { Logger } from '@teambit/harmony.aspect-docs.logger';
-
-<Logger />

package/logger.main.runtime.ts

@@ -1,19 +0,0 @@
-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

@@ -1,119 +0,0 @@
-import loader from '@teambit/legacy/dist/cli/loader';
-import logger, { IBitLogger } from '@teambit/legacy/dist/logger/logger';
-import chalk from 'chalk';
-import stc from 'string-to-color';
-
-import { 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): LongProcessLogger {
-    return new LongProcessLogger(this, this.extensionName, processDescription, totalItems);
-  }
-  /**
-   * single status-line on the bottom of the screen.
-   * the text is replaced every time this method is called.
-   */
-  setStatusLine(text: string) {
-    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) {
-    if (message) this.info(message);
-    if (!loader.isStarted && logger.shouldWriteToConsole) {
-      // eslint-disable-next-line no-console
-      console.log(message);
-    } 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) {
-    if (message) this.info(message);
-    loader.succeed(message);
-  }
-
-  /**
-   * 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);
-    loader.warn(message);
-  }
-
-  private colorMessage(message: string) {
-    const text = `${this.extensionName}, ${message}`;
-    if (logger.isJsonFormat) return text;
-    return chalk.hex(stc(this.extensionName))(text);
-  }
-}

package/long-process-logger.ts

@@ -1,48 +0,0 @@
-import prettyTime from 'pretty-time';
-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 class LongProcessLogger {
-  constructor(
-    private logPublisher: Logger,
-    private extensionName: string,
-    private processDescription: string,
-    private totalItems?: number,
-    private currentItem = 0,
-    private startTime = process.hrtime()
-  ) {
-    this.start();
-  }
-
-  logProgress(itemName = '') {
-    this.currentItem += 1;
-    const message = `${this.processDescription} (${this.currentItem}/${this.totalItems}). ${itemName}`;
-    this.logPublisher.debug(message);
-    this.logPublisher.setStatusLine(`${this.extensionName}, ${message}`);
-  }
-
-  end() {
-    const duration = process.hrtime(this.startTime);
-    const message = `${this.processDescription} (completed in ${prettyTime(duration)})`;
-    this.logAndConsole(message);
-  }
-
-  private start() {
-    const totalItemsStr = this.totalItems ? `(total: ${this.totalItems})` : '';
-    const message = `${this.processDescription} ${totalItemsStr}`;
-    this.logAndConsole(message);
-  }
-
-  private logAndConsole(message: string) {
-    this.logPublisher.info(message);
-    this.logPublisher.setStatusLine(`${this.extensionName}, ${message}`);
-  }
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}