@teambit/logger 0.0.845 → 0.0.847
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/logger.d.ts +3 -3
- package/dist/logger.js +4 -3
- package/dist/logger.js.map +1 -1
- package/dist/long-process-logger.d.ts +5 -4
- package/dist/long-process-logger.js +32 -16
- package/dist/long-process-logger.js.map +1 -1
- package/dist/{preview-1690773444566.js → preview-1691637443382.js} +2 -2
- package/package-tar/teambit-logger-0.0.847.tgz +0 -0
- package/package.json +4 -4
- package/package-tar/teambit-logger-0.0.845.tgz +0 -0
package/dist/logger.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { IBitLogger } from '@teambit/legacy/dist/logger/logger';
|
|
2
|
-
import { LongProcessLogger } from './long-process-logger';
|
|
2
|
+
import { ConsoleOnStart, LongProcessLogger } from './long-process-logger';
|
|
3
3
|
export declare class Logger implements IBitLogger {
|
|
4
4
|
private extensionName;
|
|
5
5
|
constructor(extensionName: string);
|
|
@@ -18,12 +18,12 @@ export declare class Logger implements IBitLogger {
|
|
|
18
18
|
* once done, call `LongProcessLogger.end()`
|
|
19
19
|
* the status-line will show all messages in the terminal.
|
|
20
20
|
*/
|
|
21
|
-
createLongProcessLogger(processDescription: string, totalItems?: number): LongProcessLogger;
|
|
21
|
+
createLongProcessLogger(processDescription: string, totalItems?: number, shouldConsole?: ConsoleOnStart): LongProcessLogger;
|
|
22
22
|
/**
|
|
23
23
|
* single status-line on the bottom of the screen.
|
|
24
24
|
* the text is replaced every time this method is called.
|
|
25
25
|
*/
|
|
26
|
-
setStatusLine(text: string): void;
|
|
26
|
+
setStatusLine(text: string, shouldPrintOnCI?: boolean): void;
|
|
27
27
|
/**
|
|
28
28
|
* remove the text from the last line on the screen.
|
|
29
29
|
*/
|
package/dist/logger.js
CHANGED
|
@@ -67,14 +67,15 @@ class Logger {
|
|
|
67
67
|
* once done, call `LongProcessLogger.end()`
|
|
68
68
|
* the status-line will show all messages in the terminal.
|
|
69
69
|
*/
|
|
70
|
-
createLongProcessLogger(processDescription, totalItems) {
|
|
71
|
-
return new (_longProcessLogger().LongProcessLogger)(this, this.extensionName, processDescription, totalItems);
|
|
70
|
+
createLongProcessLogger(processDescription, totalItems, shouldConsole) {
|
|
71
|
+
return new (_longProcessLogger().LongProcessLogger)(this, this.extensionName, processDescription, totalItems, shouldConsole);
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* single status-line on the bottom of the screen.
|
|
75
75
|
* the text is replaced every time this method is called.
|
|
76
76
|
*/
|
|
77
|
-
setStatusLine(text) {
|
|
77
|
+
setStatusLine(text, shouldPrintOnCI = false) {
|
|
78
|
+
if (process.env.CI && !shouldPrintOnCI) return;
|
|
78
79
|
_loader().default.setTextAndRestart(text);
|
|
79
80
|
}
|
|
80
81
|
/**
|
package/dist/logger.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_loader","data","_interopRequireDefault","require","_logger","_chalk","_longProcessLogger","Logger","constructor","extensionName","trace","message","meta","logger","colorMessage","debug","info","warn","error","fatal","isLoaderStarted","loader","isStarted","createLongProcessLogger","processDescription","totalItems","LongProcessLogger","setStatusLine","text","setTextAndRestart","clearStatusLine","stop","console","shouldWriteToConsole","log","stopAndPersist","consoleWarn","consoleError","consoleTitle","chalk","bold","consoleSuccess","startTime","succeed","off","on","profile","id","consoleFailure","fail","consoleWarning","yellow","isJsonFormat","exports"],"sources":["logger.ts"],"sourcesContent":["import loader from '@teambit/legacy/dist/cli/loader';\nimport logger, { IBitLogger } from '@teambit/legacy/dist/logger/logger';\nimport chalk from 'chalk';\n\nimport { LongProcessLogger } from './long-process-logger';\n\nexport class Logger implements IBitLogger {\n constructor(private extensionName: string) {}\n\n trace(message: string, ...meta: any[]) {\n logger.trace(this.colorMessage(message), ...meta);\n }\n debug(message: string, ...meta: any[]) {\n logger.debug(this.colorMessage(message), ...meta);\n }\n info(message: string, ...meta: any[]) {\n logger.info(this.colorMessage(message), ...meta);\n }\n warn(message: string, ...meta: any[]) {\n logger.warn(this.colorMessage(message), ...meta);\n }\n error(message: string, ...meta: any[]) {\n logger.error(this.colorMessage(message), ...meta);\n }\n fatal(message: string, ...meta: any[]) {\n logger.fatal(this.colorMessage(message), ...meta);\n }\n\n get isLoaderStarted() {\n return loader.isStarted;\n }\n /**\n * use it for a long running process. upon creation it logs the `processDescription`.\n * if the process involves iteration over a list of items, such as running tag on a list of\n * components, then pass the `totalItems` as the total of the total components in the list.\n * later, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\n * once done, call `LongProcessLogger.end()`\n * the status-line will show all messages in the terminal.\n */\n createLongProcessLogger(processDescription: string
|
|
1
|
+
{"version":3,"names":["_loader","data","_interopRequireDefault","require","_logger","_chalk","_longProcessLogger","Logger","constructor","extensionName","trace","message","meta","logger","colorMessage","debug","info","warn","error","fatal","isLoaderStarted","loader","isStarted","createLongProcessLogger","processDescription","totalItems","shouldConsole","LongProcessLogger","setStatusLine","text","shouldPrintOnCI","process","env","CI","setTextAndRestart","clearStatusLine","stop","console","shouldWriteToConsole","log","stopAndPersist","consoleWarn","consoleError","consoleTitle","chalk","bold","consoleSuccess","startTime","succeed","off","on","profile","id","consoleFailure","fail","consoleWarning","yellow","isJsonFormat","exports"],"sources":["logger.ts"],"sourcesContent":["import loader from '@teambit/legacy/dist/cli/loader';\nimport logger, { IBitLogger } from '@teambit/legacy/dist/logger/logger';\nimport chalk from 'chalk';\n\nimport { ConsoleOnStart, LongProcessLogger } from './long-process-logger';\n\nexport class Logger implements IBitLogger {\n constructor(private extensionName: string) {}\n\n trace(message: string, ...meta: any[]) {\n logger.trace(this.colorMessage(message), ...meta);\n }\n debug(message: string, ...meta: any[]) {\n logger.debug(this.colorMessage(message), ...meta);\n }\n info(message: string, ...meta: any[]) {\n logger.info(this.colorMessage(message), ...meta);\n }\n warn(message: string, ...meta: any[]) {\n logger.warn(this.colorMessage(message), ...meta);\n }\n error(message: string, ...meta: any[]) {\n logger.error(this.colorMessage(message), ...meta);\n }\n fatal(message: string, ...meta: any[]) {\n logger.fatal(this.colorMessage(message), ...meta);\n }\n\n get isLoaderStarted() {\n return loader.isStarted;\n }\n /**\n * use it for a long running process. upon creation it logs the `processDescription`.\n * if the process involves iteration over a list of items, such as running tag on a list of\n * components, then pass the `totalItems` as the total of the total components in the list.\n * later, during the iteration, call `LongProcessLogger.logProgress(componentName)`.\n * once done, call `LongProcessLogger.end()`\n * the status-line will show all messages in the terminal.\n */\n createLongProcessLogger(\n processDescription: string,\n totalItems?: number,\n shouldConsole?: ConsoleOnStart\n ): LongProcessLogger {\n return new LongProcessLogger(this, this.extensionName, processDescription, totalItems, shouldConsole);\n }\n /**\n * single status-line on the bottom of the screen.\n * the text is replaced every time this method is called.\n */\n setStatusLine(text: string, shouldPrintOnCI = false) {\n if (process.env.CI && !shouldPrintOnCI) return;\n loader.setTextAndRestart(text);\n }\n /**\n * remove the text from the last line on the screen.\n */\n clearStatusLine() {\n loader.stop();\n }\n /**\n * print to the screen. if message is empty, print the last logged message.\n */\n console(message?: string, ...meta: any[]) {\n if (message) this.info(message, meta);\n if (!loader.isStarted && logger.shouldWriteToConsole) {\n // eslint-disable-next-line no-console\n console.log(message, ...meta);\n } else {\n loader.stopAndPersist({ text: message });\n }\n }\n\n /**\n * @deprecated\n * try using consoleWarning. if not possible, rename this method to a clearer one\n */\n consoleWarn(message?: string, ...meta: any[]) {\n if (message) this.warn(message, ...meta);\n if (!loader.isStarted && logger.shouldWriteToConsole) {\n // eslint-disable-next-line no-console\n console.warn(message, ...meta);\n } else {\n loader.stopAndPersist({ text: message });\n }\n }\n\n /**\n * @deprecated\n * try using consoleFailure. if not possible, rename this method to a clearer one\n */\n consoleError(message?: string, ...meta: any[]) {\n if (message) this.error(message, ...meta);\n if (!loader.isStarted && logger.shouldWriteToConsole) {\n // eslint-disable-next-line no-console\n console.error(message, ...meta);\n } else {\n loader.stopAndPersist({ text: message });\n }\n }\n\n /**\n * print to the screen as a title, with bold text.\n */\n consoleTitle(message: string) {\n this.info(message);\n loader.stopAndPersist({ text: chalk.bold(message) });\n }\n /**\n * print to the screen with a green `✔` prefix. if message is empty, print the last logged message.\n */\n consoleSuccess(message?: string, startTime?: [number, number]) {\n if (message) this.info(message);\n loader.succeed(message, startTime);\n }\n\n /**\n * turn off the logger.\n */\n off() {\n return loader.off();\n }\n\n on() {\n return loader.on();\n }\n\n profile(id: string, console?: boolean) {\n logger.profile(id, console);\n }\n\n /**\n * print to the screen with a red `✖` prefix. if message is empty, print the last logged message.\n */\n consoleFailure(message?: string) {\n if (message) this.error(message);\n loader.fail(message);\n }\n /**\n * print to the screen with a red `⚠` prefix. if message is empty, print the last logged message.\n */\n consoleWarning(message?: string) {\n if (message) {\n this.warn(message);\n message = chalk.yellow(message);\n }\n loader.warn(message);\n }\n\n private colorMessage(message: string) {\n if (logger.isJsonFormat) return `${this.extensionName}, ${message}`;\n return `${chalk.bold(this.extensionName)}, ${message}`;\n }\n}\n"],"mappings":";;;;;;;;AAAA,SAAAA,QAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,OAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,OAAA;EAAA,MAAAJ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAE,MAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAK,mBAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,kBAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEO,MAAMM,MAAM,CAAuB;EACxCC,WAAWA,CAASC,aAAqB,EAAE;IAAA,KAAvBA,aAAqB,GAArBA,aAAqB;EAAG;EAE5CC,KAAKA,CAACC,OAAe,EAAE,GAAGC,IAAW,EAAE;IACrCC,iBAAM,CAACH,KAAK,CAAC,IAAI,CAACI,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EACnD;EACAG,KAAKA,CAACJ,OAAe,EAAE,GAAGC,IAAW,EAAE;IACrCC,iBAAM,CAACE,KAAK,CAAC,IAAI,CAACD,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EACnD;EACAI,IAAIA,CAACL,OAAe,EAAE,GAAGC,IAAW,EAAE;IACpCC,iBAAM,CAACG,IAAI,CAAC,IAAI,CAACF,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EAClD;EACAK,IAAIA,CAACN,OAAe,EAAE,GAAGC,IAAW,EAAE;IACpCC,iBAAM,CAACI,IAAI,CAAC,IAAI,CAACH,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EAClD;EACAM,KAAKA,CAACP,OAAe,EAAE,GAAGC,IAAW,EAAE;IACrCC,iBAAM,CAACK,KAAK,CAAC,IAAI,CAACJ,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EACnD;EACAO,KAAKA,CAACR,OAAe,EAAE,GAAGC,IAAW,EAAE;IACrCC,iBAAM,CAACM,KAAK,CAAC,IAAI,CAACL,YAAY,CAACH,OAAO,CAAC,EAAE,GAAGC,IAAI,CAAC;EACnD;EAEA,IAAIQ,eAAeA,CAAA,EAAG;IACpB,OAAOC,iBAAM,CAACC,SAAS;EACzB;EACA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,uBAAuBA,CACrBC,kBAA0B,EAC1BC,UAAmB,EACnBC,aAA8B,EACX;IACnB,OAAO,KAAIC,sCAAiB,EAAC,IAAI,EAAE,IAAI,CAAClB,aAAa,EAAEe,kBAAkB,EAAEC,UAAU,EAAEC,aAAa,CAAC;EACvG;EACA;AACF;AACA;AACA;EACEE,aAAaA,CAACC,IAAY,EAAEC,eAAe,GAAG,KAAK,EAAE;IACnD,IAAIC,OAAO,CAACC,GAAG,CAACC,EAAE,IAAI,CAACH,eAAe,EAAE;IACxCT,iBAAM,CAACa,iBAAiB,CAACL,IAAI,CAAC;EAChC;EACA;AACF;AACA;EACEM,eAAeA,CAAA,EAAG;IAChBd,iBAAM,CAACe,IAAI,CAAC,CAAC;EACf;EACA;AACF;AACA;EACEC,OAAOA,CAAC1B,OAAgB,EAAE,GAAGC,IAAW,EAAE;IACxC,IAAID,OAAO,EAAE,IAAI,CAACK,IAAI,CAACL,OAAO,EAAEC,IAAI,CAAC;IACrC,IAAI,CAACS,iBAAM,CAACC,SAAS,IAAIT,iBAAM,CAACyB,oBAAoB,EAAE;MACpD;MACAD,OAAO,CAACE,GAAG,CAAC5B,OAAO,EAAE,GAAGC,IAAI,CAAC;IAC/B,CAAC,MAAM;MACLS,iBAAM,CAACmB,cAAc,CAAC;QAAEX,IAAI,EAAElB;MAAQ,CAAC,CAAC;IAC1C;EACF;;EAEA;AACF;AACA;AACA;EACE8B,WAAWA,CAAC9B,OAAgB,EAAE,GAAGC,IAAW,EAAE;IAC5C,IAAID,OAAO,EAAE,IAAI,CAACM,IAAI,CAACN,OAAO,EAAE,GAAGC,IAAI,CAAC;IACxC,IAAI,CAACS,iBAAM,CAACC,SAAS,IAAIT,iBAAM,CAACyB,oBAAoB,EAAE;MACpD;MACAD,OAAO,CAACpB,IAAI,CAACN,OAAO,EAAE,GAAGC,IAAI,CAAC;IAChC,CAAC,MAAM;MACLS,iBAAM,CAACmB,cAAc,CAAC;QAAEX,IAAI,EAAElB;MAAQ,CAAC,CAAC;IAC1C;EACF;;EAEA;AACF;AACA;AACA;EACE+B,YAAYA,CAAC/B,OAAgB,EAAE,GAAGC,IAAW,EAAE;IAC7C,IAAID,OAAO,EAAE,IAAI,CAACO,KAAK,CAACP,OAAO,EAAE,GAAGC,IAAI,CAAC;IACzC,IAAI,CAACS,iBAAM,CAACC,SAAS,IAAIT,iBAAM,CAACyB,oBAAoB,EAAE;MACpD;MACAD,OAAO,CAACnB,KAAK,CAACP,OAAO,EAAE,GAAGC,IAAI,CAAC;IACjC,CAAC,MAAM;MACLS,iBAAM,CAACmB,cAAc,CAAC;QAAEX,IAAI,EAAElB;MAAQ,CAAC,CAAC;IAC1C;EACF;;EAEA;AACF;AACA;EACEgC,YAAYA,CAAChC,OAAe,EAAE;IAC5B,IAAI,CAACK,IAAI,CAACL,OAAO,CAAC;IAClBU,iBAAM,CAACmB,cAAc,CAAC;MAAEX,IAAI,EAAEe,gBAAK,CAACC,IAAI,CAAClC,OAAO;IAAE,CAAC,CAAC;EACtD;EACA;AACF;AACA;EACEmC,cAAcA,CAACnC,OAAgB,EAAEoC,SAA4B,EAAE;IAC7D,IAAIpC,OAAO,EAAE,IAAI,CAACK,IAAI,CAACL,OAAO,CAAC;IAC/BU,iBAAM,CAAC2B,OAAO,CAACrC,OAAO,EAAEoC,SAAS,CAAC;EACpC;;EAEA;AACF;AACA;EACEE,GAAGA,CAAA,EAAG;IACJ,OAAO5B,iBAAM,CAAC4B,GAAG,CAAC,CAAC;EACrB;EAEAC,EAAEA,CAAA,EAAG;IACH,OAAO7B,iBAAM,CAAC6B,EAAE,CAAC,CAAC;EACpB;EAEAC,OAAOA,CAACC,EAAU,EAAEf,OAAiB,EAAE;IACrCxB,iBAAM,CAACsC,OAAO,CAACC,EAAE,EAAEf,OAAO,CAAC;EAC7B;;EAEA;AACF;AACA;EACEgB,cAAcA,CAAC1C,OAAgB,EAAE;IAC/B,IAAIA,OAAO,EAAE,IAAI,CAACO,KAAK,CAACP,OAAO,CAAC;IAChCU,iBAAM,CAACiC,IAAI,CAAC3C,OAAO,CAAC;EACtB;EACA;AACF;AACA;EACE4C,cAAcA,CAAC5C,OAAgB,EAAE;IAC/B,IAAIA,OAAO,EAAE;MACX,IAAI,CAACM,IAAI,CAACN,OAAO,CAAC;MAClBA,OAAO,GAAGiC,gBAAK,CAACY,MAAM,CAAC7C,OAAO,CAAC;IACjC;IACAU,iBAAM,CAACJ,IAAI,CAACN,OAAO,CAAC;EACtB;EAEQG,YAAYA,CAACH,OAAe,EAAE;IACpC,IAAIE,iBAAM,CAAC4C,YAAY,EAAE,OAAQ,GAAE,IAAI,CAAChD,aAAc,KAAIE,OAAQ,EAAC;IACnE,OAAQ,GAAEiC,gBAAK,CAACC,IAAI,CAAC,IAAI,CAACpC,aAAa,CAAE,KAAIE,OAAQ,EAAC;EACxD;AACF;AAAC+C,OAAA,CAAAnD,MAAA,GAAAA,MAAA"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Logger } from './logger';
|
|
2
|
+
export declare type ConsoleOnStart = 'normal' | 'title';
|
|
2
3
|
/**
|
|
3
4
|
* use it for a long running process. upon creation it logs the `processDescription`.
|
|
4
5
|
* if the process involves iteration over a list of items, such as running tag on a list of
|
|
@@ -15,9 +16,9 @@ export declare class LongProcessLogger {
|
|
|
15
16
|
private totalItems?;
|
|
16
17
|
private currentItem;
|
|
17
18
|
private startTime;
|
|
18
|
-
constructor(logPublisher: Logger, extensionName: string, processDescription: string, totalItems?: number | undefined,
|
|
19
|
-
logProgress(itemName?: string): void;
|
|
20
|
-
end(
|
|
19
|
+
constructor(logPublisher: Logger, extensionName: string, processDescription: string, totalItems?: number | undefined, shouldConsole?: ConsoleOnStart);
|
|
20
|
+
logProgress(itemName?: string, showProcessDescription?: boolean): void;
|
|
21
|
+
end(shouldConsole?: 'success' | 'error'): void;
|
|
22
|
+
getProgress(): string;
|
|
21
23
|
private start;
|
|
22
|
-
private logAndConsole;
|
|
23
24
|
}
|
|
@@ -5,6 +5,13 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
value: true
|
|
6
6
|
});
|
|
7
7
|
exports.LongProcessLogger = void 0;
|
|
8
|
+
function _defineProperty2() {
|
|
9
|
+
const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
10
|
+
_defineProperty2 = function () {
|
|
11
|
+
return data;
|
|
12
|
+
};
|
|
13
|
+
return data;
|
|
14
|
+
}
|
|
8
15
|
function _prettyTime() {
|
|
9
16
|
const data = _interopRequireDefault(require("pretty-time"));
|
|
10
17
|
_prettyTime = function () {
|
|
@@ -22,35 +29,44 @@ function _prettyTime() {
|
|
|
22
29
|
* see README for more data.
|
|
23
30
|
*/
|
|
24
31
|
class LongProcessLogger {
|
|
25
|
-
constructor(logPublisher, extensionName, processDescription, totalItems,
|
|
32
|
+
constructor(logPublisher, extensionName, processDescription, totalItems, shouldConsole) {
|
|
26
33
|
this.logPublisher = logPublisher;
|
|
27
34
|
this.extensionName = extensionName;
|
|
28
35
|
this.processDescription = processDescription;
|
|
29
36
|
this.totalItems = totalItems;
|
|
30
|
-
this
|
|
31
|
-
this
|
|
32
|
-
this.start();
|
|
37
|
+
(0, _defineProperty2().default)(this, "currentItem", 0);
|
|
38
|
+
(0, _defineProperty2().default)(this, "startTime", process.hrtime());
|
|
39
|
+
this.start(shouldConsole);
|
|
33
40
|
}
|
|
34
|
-
logProgress(itemName = '') {
|
|
41
|
+
logProgress(itemName = '', showProcessDescription = true) {
|
|
35
42
|
this.currentItem += 1;
|
|
36
|
-
const
|
|
43
|
+
const processDesc = showProcessDescription ? `${this.processDescription} ` : '';
|
|
44
|
+
const message = `${processDesc}${this.getProgress()} ${itemName}`;
|
|
37
45
|
this.logPublisher.debug(message);
|
|
38
|
-
this.logPublisher.setStatusLine(
|
|
46
|
+
this.logPublisher.setStatusLine(message, true);
|
|
39
47
|
}
|
|
40
|
-
end(
|
|
41
|
-
|
|
48
|
+
end(shouldConsole) {
|
|
49
|
+
if (process.env.CI && !shouldConsole) shouldConsole = 'success';
|
|
50
|
+
const description = this.processDescription;
|
|
42
51
|
const duration = process.hrtime(this.startTime);
|
|
43
|
-
const
|
|
44
|
-
|
|
52
|
+
const completedOrFailedStr = !shouldConsole || shouldConsole === 'success' ? 'Completed' : 'Failed';
|
|
53
|
+
const message = `${description}. ${completedOrFailedStr} in ${(0, _prettyTime().default)(duration)}`;
|
|
54
|
+
this.logPublisher.info(message);
|
|
55
|
+
if (shouldConsole) {
|
|
56
|
+
if (shouldConsole === 'success') this.logPublisher.consoleSuccess(message);else this.logPublisher.consoleFailure(message);
|
|
57
|
+
} else this.logPublisher.setStatusLine(message);
|
|
58
|
+
}
|
|
59
|
+
getProgress() {
|
|
60
|
+
return `(${this.currentItem}/${this.totalItems})`;
|
|
45
61
|
}
|
|
46
|
-
start() {
|
|
62
|
+
start(shouldConsole) {
|
|
63
|
+
if (process.env.CI && !shouldConsole) shouldConsole = 'normal';
|
|
47
64
|
const totalItemsStr = this.totalItems ? `(total: ${this.totalItems})` : '';
|
|
48
65
|
const message = `${this.processDescription} ${totalItemsStr}`;
|
|
49
|
-
this.logAndConsole(message);
|
|
50
|
-
}
|
|
51
|
-
logAndConsole(message) {
|
|
52
66
|
this.logPublisher.info(message);
|
|
53
|
-
|
|
67
|
+
if (shouldConsole) {
|
|
68
|
+
if (shouldConsole === 'title') this.logPublisher.consoleTitle(message);else this.logPublisher.console(message);
|
|
69
|
+
} else this.logPublisher.setStatusLine(message);
|
|
54
70
|
}
|
|
55
71
|
}
|
|
56
72
|
exports.LongProcessLogger = LongProcessLogger;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_prettyTime","data","_interopRequireDefault","require","LongProcessLogger","constructor","logPublisher","extensionName","processDescription","totalItems","
|
|
1
|
+
{"version":3,"names":["_prettyTime","data","_interopRequireDefault","require","LongProcessLogger","constructor","logPublisher","extensionName","processDescription","totalItems","shouldConsole","_defineProperty2","default","process","hrtime","start","logProgress","itemName","showProcessDescription","currentItem","processDesc","message","getProgress","debug","setStatusLine","end","env","CI","description","duration","startTime","completedOrFailedStr","prettyTime","info","consoleSuccess","consoleFailure","totalItemsStr","consoleTitle","console","exports"],"sources":["long-process-logger.ts"],"sourcesContent":["import prettyTime from 'pretty-time';\nimport type { Logger } from './logger';\n\nexport type ConsoleOnStart = 'normal' | 'title';\n\n/**\n * use it for a long running process. upon creation it logs the `processDescription`.\n * if the process involves iteration over a list of items, such as running tag on a list of\n * components, then pass the `totalItems` as the total components in the list.\n * later, during the iteration, call `logProgress(componentName)`.\n * once done, call `end()`.\n * the status-line will show all messages in the terminal.\n * see README for more data.\n */\nexport class LongProcessLogger {\n private currentItem = 0;\n private startTime = process.hrtime();\n constructor(\n private logPublisher: Logger,\n private extensionName: string,\n private processDescription: string,\n private totalItems?: number,\n shouldConsole?: ConsoleOnStart\n ) {\n this.start(shouldConsole);\n }\n\n logProgress(itemName = '', showProcessDescription = true) {\n this.currentItem += 1;\n const processDesc = showProcessDescription ? `${this.processDescription} ` : '';\n const message = `${processDesc}${this.getProgress()} ${itemName}`;\n this.logPublisher.debug(message);\n this.logPublisher.setStatusLine(message, true);\n }\n\n end(shouldConsole?: 'success' | 'error') {\n if (process.env.CI && !shouldConsole) shouldConsole = 'success';\n const description = this.processDescription;\n const duration = process.hrtime(this.startTime);\n const completedOrFailedStr = !shouldConsole || shouldConsole === 'success' ? 'Completed' : 'Failed';\n const message = `${description}. ${completedOrFailedStr} in ${prettyTime(duration)}`;\n this.logPublisher.info(message);\n if (shouldConsole) {\n if (shouldConsole === 'success') this.logPublisher.consoleSuccess(message);\n else this.logPublisher.consoleFailure(message);\n } else this.logPublisher.setStatusLine(message);\n }\n\n getProgress() {\n return `(${this.currentItem}/${this.totalItems})`;\n }\n\n private start(shouldConsole?: ConsoleOnStart) {\n if (process.env.CI && !shouldConsole) shouldConsole = 'normal';\n const totalItemsStr = this.totalItems ? `(total: ${this.totalItems})` : '';\n const message = `${this.processDescription} ${totalItemsStr}`;\n this.logPublisher.info(message);\n if (shouldConsole) {\n if (shouldConsole === 'title') this.logPublisher.consoleTitle(message);\n else this.logPublisher.console(message);\n } else this.logPublisher.setStatusLine(message);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,SAAAA,YAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,WAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,iBAAiB,CAAC;EAG7BC,WAAWA,CACDC,YAAoB,EACpBC,aAAqB,EACrBC,kBAA0B,EAC1BC,UAAmB,EAC3BC,aAA8B,EAC9B;IAAA,KALQJ,YAAoB,GAApBA,YAAoB;IAAA,KACpBC,aAAqB,GAArBA,aAAqB;IAAA,KACrBC,kBAA0B,GAA1BA,kBAA0B;IAAA,KAC1BC,UAAmB,GAAnBA,UAAmB;IAAA,IAAAE,gBAAA,GAAAC,OAAA,uBANP,CAAC;IAAA,IAAAD,gBAAA,GAAAC,OAAA,qBACHC,OAAO,CAACC,MAAM,CAAC,CAAC;IAQlC,IAAI,CAACC,KAAK,CAACL,aAAa,CAAC;EAC3B;EAEAM,WAAWA,CAACC,QAAQ,GAAG,EAAE,EAAEC,sBAAsB,GAAG,IAAI,EAAE;IACxD,IAAI,CAACC,WAAW,IAAI,CAAC;IACrB,MAAMC,WAAW,GAAGF,sBAAsB,GAAI,GAAE,IAAI,CAACV,kBAAmB,GAAE,GAAG,EAAE;IAC/E,MAAMa,OAAO,GAAI,GAAED,WAAY,GAAE,IAAI,CAACE,WAAW,CAAC,CAAE,IAAGL,QAAS,EAAC;IACjE,IAAI,CAACX,YAAY,CAACiB,KAAK,CAACF,OAAO,CAAC;IAChC,IAAI,CAACf,YAAY,CAACkB,aAAa,CAACH,OAAO,EAAE,IAAI,CAAC;EAChD;EAEAI,GAAGA,CAACf,aAAmC,EAAE;IACvC,IAAIG,OAAO,CAACa,GAAG,CAACC,EAAE,IAAI,CAACjB,aAAa,EAAEA,aAAa,GAAG,SAAS;IAC/D,MAAMkB,WAAW,GAAG,IAAI,CAACpB,kBAAkB;IAC3C,MAAMqB,QAAQ,GAAGhB,OAAO,CAACC,MAAM,CAAC,IAAI,CAACgB,SAAS,CAAC;IAC/C,MAAMC,oBAAoB,GAAG,CAACrB,aAAa,IAAIA,aAAa,KAAK,SAAS,GAAG,WAAW,GAAG,QAAQ;IACnG,MAAMW,OAAO,GAAI,GAAEO,WAAY,KAAIG,oBAAqB,OAAM,IAAAC,qBAAU,EAACH,QAAQ,CAAE,EAAC;IACpF,IAAI,CAACvB,YAAY,CAAC2B,IAAI,CAACZ,OAAO,CAAC;IAC/B,IAAIX,aAAa,EAAE;MACjB,IAAIA,aAAa,KAAK,SAAS,EAAE,IAAI,CAACJ,YAAY,CAAC4B,cAAc,CAACb,OAAO,CAAC,CAAC,KACtE,IAAI,CAACf,YAAY,CAAC6B,cAAc,CAACd,OAAO,CAAC;IAChD,CAAC,MAAM,IAAI,CAACf,YAAY,CAACkB,aAAa,CAACH,OAAO,CAAC;EACjD;EAEAC,WAAWA,CAAA,EAAG;IACZ,OAAQ,IAAG,IAAI,CAACH,WAAY,IAAG,IAAI,CAACV,UAAW,GAAE;EACnD;EAEQM,KAAKA,CAACL,aAA8B,EAAE;IAC5C,IAAIG,OAAO,CAACa,GAAG,CAACC,EAAE,IAAI,CAACjB,aAAa,EAAEA,aAAa,GAAG,QAAQ;IAC9D,MAAM0B,aAAa,GAAG,IAAI,CAAC3B,UAAU,GAAI,WAAU,IAAI,CAACA,UAAW,GAAE,GAAG,EAAE;IAC1E,MAAMY,OAAO,GAAI,GAAE,IAAI,CAACb,kBAAmB,IAAG4B,aAAc,EAAC;IAC7D,IAAI,CAAC9B,YAAY,CAAC2B,IAAI,CAACZ,OAAO,CAAC;IAC/B,IAAIX,aAAa,EAAE;MACjB,IAAIA,aAAa,KAAK,OAAO,EAAE,IAAI,CAACJ,YAAY,CAAC+B,YAAY,CAAChB,OAAO,CAAC,CAAC,KAClE,IAAI,CAACf,YAAY,CAACgC,OAAO,CAACjB,OAAO,CAAC;IACzC,CAAC,MAAM,IAAI,CAACf,YAAY,CAACkB,aAAa,CAACH,OAAO,CAAC;EACjD;AACF;AAACkB,OAAA,CAAAnC,iBAAA,GAAAA,iBAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.
|
|
2
|
-
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.
|
|
1
|
+
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.847/dist/logger.composition.js';
|
|
2
|
+
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.847/dist/logger.docs.mdx';
|
|
3
3
|
|
|
4
4
|
export const compositions = [compositions_0];
|
|
5
5
|
export const overview = [overview_0];
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teambit/logger",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.847",
|
|
4
4
|
"homepage": "https://bit.cloud/teambit/harmony/logger",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"componentId": {
|
|
7
7
|
"scope": "teambit.harmony",
|
|
8
8
|
"name": "logger",
|
|
9
|
-
"version": "0.0.
|
|
9
|
+
"version": "0.0.847"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"chalk": "2.4.2",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"core-js": "^3.0.0",
|
|
15
15
|
"@babel/runtime": "7.20.0",
|
|
16
16
|
"@teambit/harmony": "0.4.6",
|
|
17
|
-
"@teambit/cli": "0.0.
|
|
17
|
+
"@teambit/cli": "0.0.754"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@types/react": "^17.0.8",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"@teambit/harmony.aspect-docs.logger": "0.0.154"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"@teambit/legacy": "1.0.
|
|
29
|
+
"@teambit/legacy": "1.0.536",
|
|
30
30
|
"react": "^16.8.0 || ^17.0.0",
|
|
31
31
|
"react-dom": "^16.8.0 || ^17.0.0"
|
|
32
32
|
},
|
|
Binary file
|