logger.js 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. "use strict";
  2. var messages = require("./connect-utils");
  3. var utils = require("./utils");
  4. var _ = require("./lodash.custom");
  5. var template = "[{blue:%s}] ";
  6. var logger = require("eazy-logger").Logger({
  7. useLevelPrefixes: false
  8. });
  9. module.exports.logger = logger;
  10. /**
  11. * @param name
  12. * @returns {*}
  13. */
  14. module.exports.getLogger = function (name) {
  15. return logger.clone(function (config) {
  16. config.prefix = config.prefix + template.replace("%s", name);
  17. return config;
  18. });
  19. };
  20. /**
  21. * Logging Callbacks
  22. */
  23. module.exports.callbacks = {
  24. /**
  25. * Log when file-watching has started
  26. * @param {BrowserSync} bs
  27. * @param data
  28. */
  29. "file:watching": function (bs, data) {
  30. if (Object.keys(data).length) {
  31. logger.info("Watching files...");
  32. }
  33. },
  34. /**
  35. * Log when a file changes
  36. * @param {BrowserSync} bs
  37. * @param data
  38. */
  39. "file:reload": function (bs, data) {
  40. if (canLogFileChange(bs, data)) {
  41. if (data.path[0] === "*") {
  42. return logger.info("{cyan:Reloading files that match: {magenta:%s", data.path);
  43. }
  44. logger.info("{cyan:File event [" + data.event + "] : {magenta:%s", data.path);
  45. }
  46. },
  47. /**
  48. *
  49. */
  50. "service:exit": function () {
  51. logger.debug("Exiting...");
  52. },
  53. /**
  54. *
  55. */
  56. "browser:reload": function (bs, data) {
  57. if (data === void 0) { data = {}; }
  58. if (canLogFileChange(bs)) {
  59. if (data.files && data.files.length > 1) {
  60. return logger.info("{cyan:Reloading Browsers... (buffered " + data.files.length + " events)");
  61. }
  62. logger.info("{cyan:Reloading Browsers...");
  63. }
  64. },
  65. /**
  66. *
  67. */
  68. "browser:error": function () {
  69. logger.error("Couldn't open browser (if you are using BrowserSync in a headless environment, you might want to set the {cyan:open} option to {cyan:false})");
  70. },
  71. /**
  72. * @param {BrowserSync} bs
  73. * @param data
  74. */
  75. "stream:changed": function (bs, data) {
  76. if (canLogFileChange(bs)) {
  77. var changed = data.changed;
  78. logger.info("{cyan:%s %s changed} ({magenta:%s})", changed.length, changed.length > 1 ? "files" : "file", changed.join(", "));
  79. }
  80. },
  81. /**
  82. * Client connected logging
  83. * @param {BrowserSync} bs
  84. * @param data
  85. */
  86. "client:connected": function (bs, data) {
  87. var uaString = utils.getUaString(data.ua);
  88. var msg = "{cyan:Browser Connected: {magenta:%s, version: %s}";
  89. var method = "info";
  90. if (!bs.options.get("logConnections")) {
  91. method = "debug";
  92. }
  93. logger.log(method, msg, uaString.name, uaString.version);
  94. },
  95. /**
  96. * Main logging when the service is running
  97. * @param {BrowserSync} bs
  98. * @param data
  99. */
  100. "service:running": function (bs, data) {
  101. var type = data.type;
  102. if (bs.options.get('json')) {
  103. return console.log(JSON.stringify({
  104. "service:running": {
  105. "options": bs.options.toJS()
  106. }
  107. }));
  108. }
  109. if (type === "server") {
  110. var baseDir = bs.options.getIn(["server", "baseDir"]);
  111. logUrls(bs.options.get("urls").toJS());
  112. if (baseDir) {
  113. if (utils.isList(baseDir)) {
  114. baseDir.forEach(serveFiles);
  115. }
  116. else {
  117. serveFiles(baseDir);
  118. }
  119. }
  120. }
  121. if (type === "proxy") {
  122. logger.info("Proxying: {cyan:%s}", bs.options.getIn(["proxy", "target"]));
  123. logUrls(bs.options.get("urls").toJS());
  124. }
  125. if (type === "snippet") {
  126. if (bs.options.get("logSnippet")) {
  127. logger.info("{bold:Copy the following snippet into your website, " +
  128. "just before the closing {cyan:</body>} tag");
  129. logger.unprefixed("info", messages.scriptTags(bs.options));
  130. }
  131. logUrls(bs.options
  132. .get("urls")
  133. .filter(function (value, key) {
  134. return key.slice(0, 2) === "ui";
  135. })
  136. .toJS());
  137. }
  138. function serveFiles(base) {
  139. logger.info("Serving files from: {magenta:%s}", base);
  140. }
  141. }
  142. };
  143. /**
  144. * Plugin interface for BrowserSync
  145. * @param {EventEmitter} emitter
  146. * @param {BrowserSync} bs
  147. * @returns {Object}
  148. */
  149. module.exports.plugin = function (emitter, bs) {
  150. var logPrefix = bs.options.get("logPrefix");
  151. var logLevel = bs.options.get("logLevel");
  152. // Should set logger level here!
  153. logger.setLevel(logLevel);
  154. if (logPrefix) {
  155. if (_.isFunction(logPrefix)) {
  156. logger.setPrefix(logPrefix);
  157. }
  158. else {
  159. logger.setPrefix(template.replace("%s", logPrefix));
  160. }
  161. }
  162. _.each(exports.callbacks, function (func, event) {
  163. emitter.on(event, func.bind(this, bs));
  164. });
  165. return logger;
  166. };
  167. /**
  168. *
  169. * @param urls
  170. */
  171. function logUrls(urls) {
  172. var keys = Object.keys(urls);
  173. var longestName = 0;
  174. var longesturl = 0;
  175. var offset = 2;
  176. if (!keys.length) {
  177. return;
  178. }
  179. var names = keys.map(function (key) {
  180. if (key.length > longestName) {
  181. longestName = key.length;
  182. }
  183. if (urls[key].length > longesturl) {
  184. longesturl = urls[key].length;
  185. }
  186. return key;
  187. });
  188. var underline = getChars(longestName + offset + longesturl + 1, "-");
  189. var underlined = false;
  190. logger.info("{bold:Access URLs:");
  191. logger.unprefixed("info", "{grey: %s", underline);
  192. keys.forEach(function (key, i) {
  193. var keyname = getKeyName(key);
  194. logger.unprefixed("info", " %s: {magenta:%s}", getPadding(key.length, longestName + offset) + keyname, urls[key]);
  195. if (!underlined && names[i + 1] && names[i + 1].indexOf("ui") > -1) {
  196. underlined = true;
  197. logger.unprefixed("info", "{grey: %s}", underline);
  198. }
  199. });
  200. logger.unprefixed("info", "{grey: %s}", underline);
  201. }
  202. /**
  203. * @param {Number} len
  204. * @param {Number} max
  205. * @returns {string}
  206. */
  207. function getPadding(len, max) {
  208. return new Array(max - (len + 1)).join(" ");
  209. }
  210. /**
  211. * @param {Number} len
  212. * @param {String} char
  213. * @returns {string}
  214. */
  215. function getChars(len, char) {
  216. return new Array(len).join(char);
  217. }
  218. /**
  219. * Transform url-key names into something more presentable
  220. * @param key
  221. * @returns {string}
  222. */
  223. function getKeyName(key) {
  224. if (key.indexOf("ui") > -1) {
  225. if (key === "ui") {
  226. return "UI";
  227. }
  228. if (key === "ui-external") {
  229. return "UI External";
  230. }
  231. }
  232. return key.substr(0, 1).toUpperCase() + key.substring(1);
  233. }
  234. /**
  235. * Determine if file changes should be logged
  236. * @param bs
  237. * @param data
  238. * @returns {boolean}
  239. */
  240. function canLogFileChange(bs, data) {
  241. if (data && data.log === false) {
  242. return false;
  243. }
  244. return bs.options.get("logFileChanges");
  245. }
  246. //# sourceMappingURL=logger.js.map