createConsoleLogger.js 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { LogType } = require("./Logger");
  7. /** @typedef {import("../../declarations/WebpackOptions").FilterItemTypes} FilterItemTypes */
  8. /** @typedef {import("../../declarations/WebpackOptions").FilterTypes} FilterTypes */
  9. /** @typedef {import("./Logger").LogTypeEnum} LogTypeEnum */
  10. /** @typedef {function(string): boolean} FilterFunction */
  11. /** @typedef {function(string, LogTypeEnum, EXPECTED_ANY[]=): void} LoggingFunction */
  12. /**
  13. * @typedef {object} LoggerConsole
  14. * @property {function(): void} clear
  15. * @property {function(): void} trace
  16. * @property {(...args: EXPECTED_ANY[]) => void} info
  17. * @property {(...args: EXPECTED_ANY[]) => void} log
  18. * @property {(...args: EXPECTED_ANY[]) => void} warn
  19. * @property {(...args: EXPECTED_ANY[]) => void} error
  20. * @property {(...args: EXPECTED_ANY[]) => void=} debug
  21. * @property {(...args: EXPECTED_ANY[]) => void=} group
  22. * @property {(...args: EXPECTED_ANY[]) => void=} groupCollapsed
  23. * @property {(...args: EXPECTED_ANY[]) => void=} groupEnd
  24. * @property {(...args: EXPECTED_ANY[]) => void=} status
  25. * @property {(...args: EXPECTED_ANY[]) => void=} profile
  26. * @property {(...args: EXPECTED_ANY[]) => void=} profileEnd
  27. * @property {(...args: EXPECTED_ANY[]) => void=} logTime
  28. */
  29. /**
  30. * @typedef {object} LoggerOptions
  31. * @property {false|true|"none"|"error"|"warn"|"info"|"log"|"verbose"} level loglevel
  32. * @property {FilterTypes|boolean} debug filter for debug logging
  33. * @property {LoggerConsole} console the console to log to
  34. */
  35. /**
  36. * @param {FilterItemTypes} item an input item
  37. * @returns {FilterFunction | undefined} filter function
  38. */
  39. const filterToFunction = item => {
  40. if (typeof item === "string") {
  41. const regExp = new RegExp(
  42. `[\\\\/]${item.replace(/[-[\]{}()*+?.\\^$|]/g, "\\$&")}([\\\\/]|$|!|\\?)`
  43. );
  44. return ident => regExp.test(ident);
  45. }
  46. if (item && typeof item === "object" && typeof item.test === "function") {
  47. return ident => item.test(ident);
  48. }
  49. if (typeof item === "function") {
  50. return item;
  51. }
  52. if (typeof item === "boolean") {
  53. return () => item;
  54. }
  55. };
  56. /**
  57. * @enum {number}
  58. */
  59. const LogLevel = {
  60. none: 6,
  61. false: 6,
  62. error: 5,
  63. warn: 4,
  64. info: 3,
  65. log: 2,
  66. true: 2,
  67. verbose: 1
  68. };
  69. /**
  70. * @param {LoggerOptions} options options object
  71. * @returns {LoggingFunction} logging function
  72. */
  73. module.exports = ({ level = "info", debug = false, console }) => {
  74. const debugFilters =
  75. /** @type {FilterFunction[]} */
  76. (
  77. typeof debug === "boolean"
  78. ? [() => debug]
  79. : /** @type {FilterItemTypes[]} */ ([])
  80. .concat(debug)
  81. .map(filterToFunction)
  82. );
  83. /** @type {number} */
  84. const loglevel = LogLevel[`${level}`] || 0;
  85. /**
  86. * @param {string} name name of the logger
  87. * @param {LogTypeEnum} type type of the log entry
  88. * @param {EXPECTED_ANY[]=} args arguments of the log entry
  89. * @returns {void}
  90. */
  91. const logger = (name, type, args) => {
  92. const labeledArgs = () => {
  93. if (Array.isArray(args)) {
  94. if (args.length > 0 && typeof args[0] === "string") {
  95. return [`[${name}] ${args[0]}`, ...args.slice(1)];
  96. }
  97. return [`[${name}]`, ...args];
  98. }
  99. return [];
  100. };
  101. const debug = debugFilters.some(f => f(name));
  102. switch (type) {
  103. case LogType.debug:
  104. if (!debug) return;
  105. if (typeof console.debug === "function") {
  106. console.debug(...labeledArgs());
  107. } else {
  108. console.log(...labeledArgs());
  109. }
  110. break;
  111. case LogType.log:
  112. if (!debug && loglevel > LogLevel.log) return;
  113. console.log(...labeledArgs());
  114. break;
  115. case LogType.info:
  116. if (!debug && loglevel > LogLevel.info) return;
  117. console.info(...labeledArgs());
  118. break;
  119. case LogType.warn:
  120. if (!debug && loglevel > LogLevel.warn) return;
  121. console.warn(...labeledArgs());
  122. break;
  123. case LogType.error:
  124. if (!debug && loglevel > LogLevel.error) return;
  125. console.error(...labeledArgs());
  126. break;
  127. case LogType.trace:
  128. if (!debug) return;
  129. console.trace();
  130. break;
  131. case LogType.groupCollapsed:
  132. if (!debug && loglevel > LogLevel.log) return;
  133. if (!debug && loglevel > LogLevel.verbose) {
  134. if (typeof console.groupCollapsed === "function") {
  135. console.groupCollapsed(...labeledArgs());
  136. } else {
  137. console.log(...labeledArgs());
  138. }
  139. break;
  140. }
  141. // falls through
  142. case LogType.group:
  143. if (!debug && loglevel > LogLevel.log) return;
  144. if (typeof console.group === "function") {
  145. console.group(...labeledArgs());
  146. } else {
  147. console.log(...labeledArgs());
  148. }
  149. break;
  150. case LogType.groupEnd:
  151. if (!debug && loglevel > LogLevel.log) return;
  152. if (typeof console.groupEnd === "function") {
  153. console.groupEnd();
  154. }
  155. break;
  156. case LogType.time: {
  157. if (!debug && loglevel > LogLevel.log) return;
  158. const [label, start, end] =
  159. /** @type {[string, number, number]} */
  160. (args);
  161. const ms = start * 1000 + end / 1000000;
  162. const msg = `[${name}] ${label}: ${ms} ms`;
  163. if (typeof console.logTime === "function") {
  164. console.logTime(msg);
  165. } else {
  166. console.log(msg);
  167. }
  168. break;
  169. }
  170. case LogType.profile:
  171. if (typeof console.profile === "function") {
  172. console.profile(...labeledArgs());
  173. }
  174. break;
  175. case LogType.profileEnd:
  176. if (typeof console.profileEnd === "function") {
  177. console.profileEnd(...labeledArgs());
  178. }
  179. break;
  180. case LogType.clear:
  181. if (!debug && loglevel > LogLevel.log) return;
  182. if (typeof console.clear === "function") {
  183. console.clear();
  184. }
  185. break;
  186. case LogType.status:
  187. if (!debug && loglevel > LogLevel.info) return;
  188. if (typeof console.status === "function") {
  189. if (!args || args.length === 0) {
  190. console.status();
  191. } else {
  192. console.status(...labeledArgs());
  193. }
  194. } else if (args && args.length !== 0) {
  195. console.info(...labeledArgs());
  196. }
  197. break;
  198. default:
  199. throw new Error(`Unexpected LogType ${type}`);
  200. }
  201. };
  202. return logger;
  203. };