v1.6.0

Updated NPM deps. Improved readme docs. Improved auto color selection with brightness range support. Improved unit tests and code coverage. Added various environment variables for globally defining default config settings. Added explicit ns() method to create a namespaced logger. Added namespace prefix when snooping on other loggers.
cb1kenobi · Jul 14, 2017 · cacaf8e · cacaf8e
1 parent 14822e0
commit cacaf8e
Show file tree

Hide file tree

Showing 263 changed files with 530 additions and 59 deletions.
diff --git a/.npmignore b/.npmignore
@@ -10,6 +10,7 @@ docs
 gulpfile.js
 node_modules
 npm-debug.log
+scripts
 yarn-error.log
 src
 test
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 [![Deps][david-image]][david-url]
 [![Dev Deps][david-dev-image]][david-dev-url]
 
-Laid back logging.
+Laid back debug logging.
 
 ## Installation
 
@@ -21,6 +21,7 @@ Laid back logging.
  * Pipe messages to one or more streams
  * Namespacing
  * Filter messages using the `DEBUG` (or `SNOOPLOGG`) environment variable
+ * Automatic color selection with brightness range
  * Includes helper libraries for your convenience
    * [chalk](https://www.npmjs.com/pacakge/chalk)
    * [figures](https://www.npmjs.com/package/figures) (exported as `symbols`)
@@ -128,7 +129,32 @@ Creates a namespaced logger as well as defines the global namespaced logger.
 
 Outputs a message using the standard `console.log()` format syntax.
 
-*More docs to come in the future!*
+#### `snooplogg.config(options)`
+
+Allows you to set various instance specific options.
+
+* `colors` - (Array) An array of color names to choose from when auto-selecting a color,
+  specifically for rendering the namespace.
+* `minBrightness` - (Number) The minimum brightness to auto-select a color. Value must be between 0
+  and 255 as well as less than or equal to the `maxBrightness`. Defaults to `0`.
+* `maxBrightness` - (Number) The maximum brightness to auto-select a color. Value must be between 0
+  and 255 as well as greater than or equal to the `minBrightness`. Defaults to `255`.
+* `theme` - (String) The name of the default theme to use. Defaults to `standard`.
+* `maxBufferSize` - (Number) The maximum number of log lines to buffer. Used to flush prior messages
+  to new pipes.
+
+Returns the original `SnoopLogg` instance.
+
+### Global Defaults
+
+SnoopLogg allows you to set defaults using environment variables that apply to all SnoopLogg
+instances.
+
+* `SNOOPLOGG_COLOR_LIST` - A comma-separated list of supported color names.
+* `SNOOPLOGG_DEFAULT_THEME` - Sets the `theme`.
+* `SNOOPLOGG_MAX_BUFFER_SIZE` - Sets the `maxBufferSize`.
+* `SNOOPLOGG_MAX_BRIGHTNESS` - Sets the `maxBrightness`.
+* `SNOOPLOGG_MIN_BRIGHTNESS` - Sets the `minBrightness`.
 
 ## License
 

diff --git a/lookup/0.br b/lookup/0.br
diff --git a/lookup/1.br b/lookup/1.br
diff --git a/lookup/10.br b/lookup/10.br
diff --git a/lookup/100.br b/lookup/100.br
diff --git a/lookup/101.br b/lookup/101.br
diff --git a/lookup/102.br b/lookup/102.br
diff --git a/lookup/103.br b/lookup/103.br
diff --git a/lookup/104.br b/lookup/104.br
diff --git a/lookup/105.br b/lookup/105.br
diff --git a/lookup/106.br b/lookup/106.br
diff --git a/lookup/107.br b/lookup/107.br
diff --git a/lookup/108.br b/lookup/108.br
diff --git a/lookup/109.br b/lookup/109.br
diff --git a/lookup/11.br b/lookup/11.br
diff --git a/lookup/110.br b/lookup/110.br
diff --git a/lookup/111.br b/lookup/111.br
diff --git a/lookup/112.br b/lookup/112.br
diff --git a/lookup/113.br b/lookup/113.br
diff --git a/lookup/114.br b/lookup/114.br
diff --git a/lookup/115.br b/lookup/115.br
diff --git a/lookup/116.br b/lookup/116.br
diff --git a/lookup/117.br b/lookup/117.br
diff --git a/lookup/118.br b/lookup/118.br
diff --git a/lookup/119.br b/lookup/119.br
diff --git a/lookup/12.br b/lookup/12.br
diff --git a/lookup/120.br b/lookup/120.br
diff --git a/lookup/121.br b/lookup/121.br
diff --git a/lookup/122.br b/lookup/122.br
diff --git a/lookup/123.br b/lookup/123.br
diff --git a/lookup/124.br b/lookup/124.br
diff --git a/lookup/125.br b/lookup/125.br
diff --git a/lookup/126.br b/lookup/126.br
diff --git a/lookup/127.br b/lookup/127.br
diff --git a/lookup/128.br b/lookup/128.br
diff --git a/lookup/129.br b/lookup/129.br
diff --git a/lookup/13.br b/lookup/13.br
diff --git a/lookup/130.br b/lookup/130.br
diff --git a/lookup/131.br b/lookup/131.br
diff --git a/lookup/132.br b/lookup/132.br
diff --git a/lookup/133.br b/lookup/133.br
diff --git a/lookup/134.br b/lookup/134.br
diff --git a/lookup/135.br b/lookup/135.br
diff --git a/lookup/136.br b/lookup/136.br
diff --git a/lookup/137.br b/lookup/137.br
diff --git a/lookup/138.br b/lookup/138.br
diff --git a/lookup/139.br b/lookup/139.br
diff --git a/lookup/14.br b/lookup/14.br
diff --git a/lookup/140.br b/lookup/140.br
diff --git a/lookup/141.br b/lookup/141.br
diff --git a/lookup/142.br b/lookup/142.br
diff --git a/lookup/143.br b/lookup/143.br
diff --git a/lookup/144.br b/lookup/144.br
diff --git a/lookup/145.br b/lookup/145.br
diff --git a/lookup/146.br b/lookup/146.br
diff --git a/lookup/147.br b/lookup/147.br
diff --git a/lookup/148.br b/lookup/148.br
diff --git a/lookup/149.br b/lookup/149.br
diff --git a/lookup/15.br b/lookup/15.br
diff --git a/lookup/150.br b/lookup/150.br
diff --git a/lookup/151.br b/lookup/151.br
diff --git a/lookup/152.br b/lookup/152.br
diff --git a/lookup/153.br b/lookup/153.br
diff --git a/lookup/154.br b/lookup/154.br
diff --git a/lookup/155.br b/lookup/155.br
diff --git a/lookup/156.br b/lookup/156.br
diff --git a/lookup/157.br b/lookup/157.br
diff --git a/lookup/158.br b/lookup/158.br
diff --git a/lookup/159.br b/lookup/159.br
diff --git a/lookup/16.br b/lookup/16.br
diff --git a/lookup/160.br b/lookup/160.br
diff --git a/lookup/161.br b/lookup/161.br
diff --git a/lookup/162.br b/lookup/162.br
diff --git a/lookup/163.br b/lookup/163.br
diff --git a/lookup/164.br b/lookup/164.br
diff --git a/lookup/165.br b/lookup/165.br
diff --git a/lookup/166.br b/lookup/166.br
diff --git a/lookup/167.br b/lookup/167.br
diff --git a/lookup/168.br b/lookup/168.br
diff --git a/lookup/169.br b/lookup/169.br
diff --git a/lookup/17.br b/lookup/17.br
diff --git a/lookup/170.br b/lookup/170.br
diff --git a/lookup/171.br b/lookup/171.br
diff --git a/lookup/172.br b/lookup/172.br
diff --git a/lookup/173.br b/lookup/173.br
diff --git a/lookup/174.br b/lookup/174.br
diff --git a/lookup/175.br b/lookup/175.br
diff --git a/lookup/176.br b/lookup/176.br
diff --git a/lookup/177.br b/lookup/177.br
diff --git a/lookup/178.br b/lookup/178.br
diff --git a/lookup/179.br b/lookup/179.br
diff --git a/lookup/18.br b/lookup/18.br
diff --git a/lookup/180.br b/lookup/180.br
diff --git a/lookup/181.br b/lookup/181.br
diff --git a/lookup/182.br b/lookup/182.br
diff --git a/lookup/183.br b/lookup/183.br
diff --git a/lookup/184.br b/lookup/184.br
diff --git a/lookup/185.br b/lookup/185.br
diff --git a/lookup/186.br b/lookup/186.br
diff --git a/lookup/187.br b/lookup/187.br
diff --git a/lookup/188.br b/lookup/188.br
diff --git a/lookup/189.br b/lookup/189.br
diff --git a/lookup/19.br b/lookup/19.br
diff --git a/lookup/190.br b/lookup/190.br
diff --git a/lookup/191.br b/lookup/191.br
diff --git a/lookup/192.br b/lookup/192.br
diff --git a/lookup/193.br b/lookup/193.br
diff --git a/lookup/194.br b/lookup/194.br
diff --git a/lookup/195.br b/lookup/195.br
diff --git a/lookup/196.br b/lookup/196.br
diff --git a/lookup/197.br b/lookup/197.br
diff --git a/lookup/198.br b/lookup/198.br
diff --git a/lookup/199.br b/lookup/199.br
diff --git a/lookup/2.br b/lookup/2.br
diff --git a/lookup/20.br b/lookup/20.br
diff --git a/lookup/200.br b/lookup/200.br
diff --git a/lookup/201.br b/lookup/201.br
diff --git a/lookup/202.br b/lookup/202.br
diff --git a/lookup/203.br b/lookup/203.br
diff --git a/lookup/204.br b/lookup/204.br
diff --git a/lookup/205.br b/lookup/205.br
diff --git a/lookup/206.br b/lookup/206.br
diff --git a/lookup/207.br b/lookup/207.br
diff --git a/lookup/208.br b/lookup/208.br
diff --git a/lookup/209.br b/lookup/209.br
diff --git a/lookup/21.br b/lookup/21.br
diff --git a/lookup/210.br b/lookup/210.br
diff --git a/lookup/211.br b/lookup/211.br
diff --git a/lookup/212.br b/lookup/212.br
diff --git a/lookup/213.br b/lookup/213.br
diff --git a/lookup/214.br b/lookup/214.br
diff --git a/lookup/215.br b/lookup/215.br
diff --git a/lookup/216.br b/lookup/216.br
diff --git a/lookup/217.br b/lookup/217.br
diff --git a/lookup/218.br b/lookup/218.br
diff --git a/lookup/219.br b/lookup/219.br
diff --git a/lookup/22.br b/lookup/22.br
diff --git a/lookup/220.br b/lookup/220.br
diff --git a/lookup/221.br b/lookup/221.br
diff --git a/lookup/222.br b/lookup/222.br
diff --git a/lookup/223.br b/lookup/223.br
diff --git a/lookup/224.br b/lookup/224.br
diff --git a/lookup/225.br b/lookup/225.br
diff --git a/lookup/226.br b/lookup/226.br
diff --git a/lookup/227.br b/lookup/227.br
diff --git a/lookup/228.br b/lookup/228.br
diff --git a/lookup/229.br b/lookup/229.br
diff --git a/lookup/23.br b/lookup/23.br
diff --git a/lookup/230.br b/lookup/230.br
diff --git a/lookup/231.br b/lookup/231.br
diff --git a/lookup/232.br b/lookup/232.br
diff --git a/lookup/233.br b/lookup/233.br
diff --git a/lookup/234.br b/lookup/234.br
diff --git a/lookup/235.br b/lookup/235.br
diff --git a/lookup/236.br b/lookup/236.br
diff --git a/lookup/237.br b/lookup/237.br
diff --git a/lookup/238.br b/lookup/238.br
diff --git a/lookup/239.br b/lookup/239.br
diff --git a/lookup/24.br b/lookup/24.br
diff --git a/lookup/240.br b/lookup/240.br
diff --git a/lookup/241.br b/lookup/241.br
diff --git a/lookup/242.br b/lookup/242.br
diff --git a/lookup/243.br b/lookup/243.br
diff --git a/lookup/244.br b/lookup/244.br
diff --git a/lookup/245.br b/lookup/245.br
diff --git a/lookup/246.br b/lookup/246.br
diff --git a/lookup/247.br b/lookup/247.br
diff --git a/lookup/248.br b/lookup/248.br
diff --git a/lookup/249.br b/lookup/249.br
diff --git a/lookup/25.br b/lookup/25.br
diff --git a/lookup/250.br b/lookup/250.br
@@ -0,0 +1,5 @@
+LU�,��qL�fE��z�NZ����
+$��R)���t�z�O�ă-Zx����t5���ì��=�Y�J��f���:�`Z�ú5,����aq�֝q`��b���y�{V����kaX�z��ak=�d-mT�I'Q��vp����$*���!�>�5�*,�:4ڧ>��V�eV�a'���sk|uX�~�_��HX�E���礟�ܸh�c�M�_A�/d�����3��)��<!S���w��U����� ��B&���彝w��]�M��H|�5�1��K|:�/�J�3.����&C�6%VA�+d:�x�Kh���v�� �2�m��-t��Vu�M��
+�>.d2G��\B�q;�`U��M��u��U�ὤ	aHi�eI��!!U��"Q֡\҄2��)Krhȴ�xwT(kS�K�0��6eYA���	mӎ�t���*�� ���I�2������q�1Xe@�2���CYg�c;�'Cd,3tQ�*C�H:�u&/i1��x1D�)�
+�)ʸ�v	e���>ֲ���hS&
+�B�0�mm��G,{i�ރU4�)�SAV�B&he��}	mO����M�V1�EN���E�Q�鹤5��^�Yvcd����E2UVt���:�KZ����~t$

diff --git a/lookup/251.br b/lookup/251.br
diff --git a/lookup/252.br b/lookup/252.br
diff --git a/lookup/253.br b/lookup/253.br
diff --git a/lookup/254.br b/lookup/254.br
diff --git a/lookup/255.br b/lookup/255.br
diff --git a/lookup/26.br b/lookup/26.br
diff --git a/lookup/27.br b/lookup/27.br
diff --git a/lookup/28.br b/lookup/28.br
diff --git a/lookup/29.br b/lookup/29.br
diff --git a/lookup/3.br b/lookup/3.br
diff --git a/lookup/30.br b/lookup/30.br
diff --git a/lookup/31.br b/lookup/31.br
diff --git a/lookup/32.br b/lookup/32.br
diff --git a/lookup/33.br b/lookup/33.br
diff --git a/lookup/34.br b/lookup/34.br
diff --git a/lookup/35.br b/lookup/35.br
diff --git a/lookup/36.br b/lookup/36.br
diff --git a/lookup/37.br b/lookup/37.br
diff --git a/lookup/38.br b/lookup/38.br
diff --git a/lookup/39.br b/lookup/39.br
diff --git a/lookup/4.br b/lookup/4.br
diff --git a/lookup/40.br b/lookup/40.br
diff --git a/lookup/41.br b/lookup/41.br
diff --git a/lookup/42.br b/lookup/42.br
diff --git a/lookup/43.br b/lookup/43.br
diff --git a/lookup/44.br b/lookup/44.br
diff --git a/lookup/45.br b/lookup/45.br
diff --git a/lookup/46.br b/lookup/46.br
diff --git a/lookup/47.br b/lookup/47.br
diff --git a/lookup/48.br b/lookup/48.br
diff --git a/lookup/49.br b/lookup/49.br
diff --git a/lookup/5.br b/lookup/5.br
@@ -0,0 +1,6 @@
+�
+���X]vH��#$�]dӘ�`��e:#�<�o��=���Eo�?����I�aa�����=�K6`u��U����o^�6�q���vj�aZ�@i#W�R�"vʎ��	����Z>w�ڈ��$\v�8�R�t�254;
+	�g�'����Bڎ�&M45�0K�ҹR���x�$4"|�5���B�N�xZsf!�Jg�.db��G�Lh���\��v$ӪX�(DRe*.�u�X��$A�	)���M�e;5�0�����+�u����.Y��s���a$�?$��;\M�e�d�,�J�b�'������,���c7�5������/W}�5�0K�ҹx�T�����Нp�-���Ӳ��~�a�t&�B&�xd���p�-��40�UQ�Qp��$]$�ʾ�����/�b;5�0����q�-<���DK�o��,��O���ˮ��YR�ιC���E�-�}�L�}B���0K�s!S�cB#�e9�1���d��6̂f*��t!��x��	�:��x�kZ�6
+Z�2^.Y�"]L[�V���*�m�Se�]$��E����|�f�����	�R>�E,G(�&��	~�a�x���
+��e<�Kh��S�݆Y��Jgt��	�����Po�VS���_�2z�H��,��@_����]���x<�Z��Y�ų,�gYl��!UJo�"�Pʛ09�t`;_�(:Ǐ�)}��Ch(�7�^
+�L�3�t!��в�\���,[/�}%�q_N$��,�/&4�/Dx����wRs�N�ﵖ�����@� U�?�EL?BY�?�ɁԠ��s�Anܯ�~�Z���Ș�B��g<�?�!�>����F0)�%&4���� �H0+�(3	8#:��/�E�E(�&��=���߸:nC]k9x�!'^h�_��M=Z�����^sa��i��2���h�e��2���e\ɢ�9G��:�dU�/[��l��d�E���x9�"Gx8_N�E����%�	��˝P��'x����3\��p�wv�'�1���

diff --git a/lookup/50.br b/lookup/50.br
diff --git a/lookup/51.br b/lookup/51.br
diff --git a/lookup/52.br b/lookup/52.br
diff --git a/lookup/53.br b/lookup/53.br
diff --git a/lookup/54.br b/lookup/54.br
diff --git a/lookup/55.br b/lookup/55.br
diff --git a/lookup/56.br b/lookup/56.br
diff --git a/lookup/57.br b/lookup/57.br
diff --git a/lookup/58.br b/lookup/58.br
diff --git a/lookup/59.br b/lookup/59.br
diff --git a/lookup/6.br b/lookup/6.br
diff --git a/lookup/60.br b/lookup/60.br
diff --git a/lookup/61.br b/lookup/61.br
diff --git a/lookup/62.br b/lookup/62.br
diff --git a/lookup/63.br b/lookup/63.br
diff --git a/lookup/64.br b/lookup/64.br
diff --git a/lookup/65.br b/lookup/65.br
diff --git a/lookup/66.br b/lookup/66.br
diff --git a/lookup/67.br b/lookup/67.br
diff --git a/lookup/68.br b/lookup/68.br
diff --git a/lookup/69.br b/lookup/69.br
diff --git a/lookup/7.br b/lookup/7.br
diff --git a/lookup/70.br b/lookup/70.br
diff --git a/lookup/71.br b/lookup/71.br
diff --git a/lookup/72.br b/lookup/72.br
diff --git a/lookup/73.br b/lookup/73.br
diff --git a/lookup/74.br b/lookup/74.br
diff --git a/lookup/75.br b/lookup/75.br
diff --git a/lookup/76.br b/lookup/76.br
diff --git a/lookup/77.br b/lookup/77.br
diff --git a/lookup/78.br b/lookup/78.br
diff --git a/lookup/79.br b/lookup/79.br
diff --git a/lookup/8.br b/lookup/8.br
diff --git a/lookup/80.br b/lookup/80.br
diff --git a/lookup/81.br b/lookup/81.br
diff --git a/lookup/82.br b/lookup/82.br
diff --git a/lookup/83.br b/lookup/83.br
diff --git a/lookup/84.br b/lookup/84.br
diff --git a/lookup/85.br b/lookup/85.br
diff --git a/lookup/86.br b/lookup/86.br
diff --git a/lookup/87.br b/lookup/87.br
diff --git a/lookup/88.br b/lookup/88.br
diff --git a/lookup/89.br b/lookup/89.br
diff --git a/lookup/9.br b/lookup/9.br
diff --git a/lookup/90.br b/lookup/90.br
diff --git a/lookup/91.br b/lookup/91.br
diff --git a/lookup/92.br b/lookup/92.br
diff --git a/lookup/93.br b/lookup/93.br
diff --git a/lookup/94.br b/lookup/94.br
diff --git a/lookup/95.br b/lookup/95.br
diff --git a/lookup/96.br b/lookup/96.br
diff --git a/lookup/97.br b/lookup/97.br
diff --git a/lookup/98.br b/lookup/98.br
diff --git a/lookup/99.br b/lookup/99.br
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "snooplogg",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Your mind on your logs and your logs on your mind",
   "main": "./dist/index.js",
   "author": "Chris Barber <chris@cb1inc.com> (https://github.com/cb1kenobi)",
@@ -24,14 +24,15 @@
     "test": "gulp test"
   },
   "dependencies": {
+    "brotli": "^1.3.2",
     "chalk": "^2.0.1",
     "figures": "^2.0.0",
     "humanize": "^0.0.9",
     "moment": "^2.18.1",
     "nanobuffer": "^1.0.0",
     "pluralize": "^5.0.0",
     "source-map-support": "^0.4.15",
-    "supports-color": "^4.1.0"
+    "supports-color": "^4.2.0"
   },
   "devDependencies": {
     "babel-eslint": "^7.2.3",
@@ -40,7 +41,7 @@
     "babel-plugin-transform-es2015-modules-commonjs": "^6.24.1",
     "babel-plugin-transform-es2015-parameters": "^6.24.1",
     "babel-plugin-transform-object-rest-spread": "^6.23.0",
-    "chai": "^4.0.2",
+    "chai": "^4.1.0",
     "codeclimate-test-reporter": "^0.5.0",
     "coveralls": "^2.13.1",
     "del": "^3.0.0",
@@ -57,7 +58,7 @@
     "gulp-mocha": "^3.0.1",
     "gulp-plumber": "^1.1.0",
     "gulp-sourcemaps": "^2.6.0",
-    "sinon": "^2.3.6",
+    "sinon": "^2.3.8",
     "sinon-chai": "^2.11.0"
   },
   "homepage": "https://github.com/cb1kenobi/snooplogg",

diff --git a/scripts/gen-brightness-lookup.js b/scripts/gen-brightness-lookup.js
@@ -0,0 +1,76 @@
+/**
+ * This script generates lookup tables for the 'auto' style.
+ */
+
+const brotli = require('brotli');
+const del = require('del');
+const fs = require('fs');
+const path = require('path');
+const zlib = require('zlib');
+
+const results = {};
+const start = Date.now();
+let brightness;
+const outputDir = path.resolve(__dirname, '../lookup');
+let totalBefore = 0;
+let totalAfter = 0;
+
+try {
+	fs.statSync(outputDir);
+} catch (e) {
+	console.log('Creating lookup directory...');
+	fs.mkdirSync(outputDir);
+}
+const files = fs.readdirSync(outputDir);
+if (files.length) {
+	console.log('Cleaning lookup directory...');
+	for (const name of files) {
+		fs.unlinkSync(path.join(outputDir, name));
+	}
+}
+
+console.log('Building lookup...');
+for (let b = 0; b <= 255; b++) {
+	for (let g = 0; g <= 255; g++) {
+		for (let r = 0; r <= 255; r++) {
+			brightness = ((r * 299 + g * 587 + b * 114) / 1000) | 0;
+			if (!results[brightness]) {
+				results[brightness] = [];
+			}
+			results[brightness].push(r, g, b);
+		}
+	}
+}
+
+console.log('Writing lookup files...');
+for (brightness of Object.keys(results)) {
+	let colors = results[brightness];
+	let before;
+	let after;
+
+	do {
+		before = Buffer.from(colors);
+		after = brotli.compress(before);
+		if (!after) {
+			// when brightness=255, there's only 1 color (3 bytes) and it's not enough bytes to make brotli happy
+			colors = colors.concat(colors.slice(0, 3));
+		}
+	} while (!after);
+
+	const blen = before.length;
+	const alen = after.length;
+
+	totalBefore += blen;
+	totalAfter += alen;
+
+	console.log('%s\t%s => %s\t(%s\%)', brightness, blen, alen, Math.round((blen - alen) / blen * 1000) / 10);
+
+	fs.writeFileSync(
+		`${outputDir}/${brightness}.br`,
+		after,
+		{ encoding: 'binary' }
+	);
+}
+
+console.log('Finished in %s ms', Date.now() - start);
+console.log('%s bytes => %s bytes', totalBefore, totalAfter);