createConsoleLogger.js 5.6 KB

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