Merge branch 'dev'

Author: bokub

README.md

@@ -60,12 +60,38 @@ console.log(coolString);
 const gradient = require('gradient-string');
 
 // Use the rainbow gradient
-gradient.rainbow('I love gradient-strings!')
+console.log(gradient.rainbow('I love gradient-strings!'))
 ```
 
 ### Available built-in gradients
+
 [![Built-in gradients](http://bit.ly/2uFygrL)](http://bit.ly/2ufX07r)
 
+## Multi line gradients
+
+In some cases, you may want to apply the same horizontal gradient on each line of a long text (or a piece of ASCII art).
+
+You can use the `multiline()` method of a gradient to ensure that the colors are vertically aligned.
+
+```javascript
+const gradient = require('gradient-string');
+
+// Use the same gradient on every line
+let duck = gradient('orange', 'yellow').multiline([
+    "  __",
+    "<(o )___",
+    " ( ._> /",
+    "  `---'",
+].join('\n'));
+console.log(duck);
+
+// Works with aliases
+gradient.atlas.multiline('Multi line\nstring');
+
+// Works with advanced options
+gradient('cyan', 'pink').multiline('Multi line\nstring', {interpolation: 'hsv'});
+```
+
 ## Advanced gradients
 
 <details>

examples/demo.js

@@ -5,11 +5,7 @@ const log = console.log;
 const str = '   	Lorem ipsum dolor sit amet, consectetur adipiscing elit';
 const title = Buffer.from('DQogICAgICAgICAgICAgICAgICAgICAgXyBfICAgICAgICAgICAgXyAgICAgICAgICAgIF8gICAgICAgIF8gICAgICAgICAgICAgDQogICBfXyBfIF8gX18gX18gXyAgX198IChfKSBfX18gXyBfXyB8IHxfICAgICAgX19ffCB8XyBfIF9fKF8pXyBfXyAgIF9fIF8gDQogIC8gX2AgfCAnX18vIF9gIHwvIF9gIHwgfC8gXyBcICdfIFx8IF9ffF9fX18vIF9ffCBfX3wgJ19ffCB8ICdfIFwgLyBfYCB8DQogfCAoX3wgfCB8IHwgKF98IHwgKF98IHwgfCAgX18vIHwgfCB8IHx8X19fX19cX18gXCB8X3wgfCAgfCB8IHwgfCB8IChffCB8DQogIFxfXywgfF98ICBcX18sX3xcX18sX3xffFxfX198X3wgfF98XF9ffCAgICB8X19fL1xfX3xffCAgfF98X3wgfF98XF9fLCB8DQogIHxfX18vICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgfF9fXy8gDQo=', 'base64').toString();
 
-for (const l of title.split('\n')) {
-	log(gradient.pastel(l.replace(/\s/g, 'i')).replace(/i/g, ' '));
-}
-
-log('');
+log(gradient.pastel.multiline(title) + '\n');
 
 for (const t of ['atlas', 'pastel', 'morning', 'cristal', 'rainbow']) {
 	log(gradient[t](str) + '\n');

index.js

@@ -7,20 +7,42 @@ const forbiddenChars = /\s/g;
 
 function InitGradient() {
 	const grad = tinygradient.apply(this, arguments);
-	return (str, opts) => applyGradient(str ? str.toString() : '', grad, opts);
+	const ret = (str, opts) => applyGradient(str ? str.toString() : '', grad, opts);
+	ret.multiline = (str, opts) => multilineGradient(str ? str.toString() : '', grad, opts);
+	return ret;
 }
 
+const getColors = (gradient, options, count) => options.interpolation.toLowerCase() === 'hsv' ?
+	gradient.hsv(count, options.hsvSpin.toLowerCase()) : gradient.rgb(count);
+
 function applyGradient(str, gradient, opts) {
 	const options = validateOptions(opts);
 	const colorsCount = Math.max(str.replace(forbiddenChars, '').length, gradient.stops.length);
-	const colors = options.interpolation.toLowerCase() === 'hsv' ? gradient.hsv(colorsCount, options.hsvSpin.toLowerCase()) : gradient.rgb(colorsCount);
+	const colors = getColors(gradient, options, colorsCount);
 	let result = '';
 	for (const s of str) {
 		result += s.match(forbiddenChars) ? s : chalk.hex(colors.shift().toHex())(s);
 	}
 	return result;
 }
 
+function multilineGradient(str, gradient, opts) {
+	const options = validateOptions(opts);
+	const lines = str.split('\n');
+	const maxLength = Math.max(gradient.stops.length, ...(lines.map(l => l.length)));
+	const colors = getColors(gradient, options, maxLength);
+	const results = [];
+	for (const line of lines) {
+		const lineColors = colors.slice(0);
+		let lineResult = '';
+		for (const l of line) {
+			lineResult += chalk.hex(lineColors.shift().toHex())(l);
+		}
+		results.push(lineResult);
+	}
+	return results.join('\n');
+}
+
 function validateOptions(opts) {
 	const options = Object.assign({interpolation: 'rgb', hsvSpin: 'short'}, opts);
 	if (opts !== undefined && typeof opts !== 'object') {
@@ -37,18 +59,24 @@ function validateOptions(opts) {
 	return options;
 }
 
-module.exports = InitGradient;
+const aliases = {
+	atlas: {colors: ['#feac5e', '#c779d0', '#4bc0c8'], options: {}},
+	cristal: {colors: ['#bdfff3', '#4ac29a'], options: {}},
+	teen: {colors: ['#77a1d3', '#79cbca', '#e684ae'], options: {}},
+	mind: {colors: ['#473b7b', '#3584a7', '#30d2be'], options: {}},
+	morning: {colors: ['#ff5f6d', '#ffc371'], options: {interpolation: 'hsv'}},
+	vice: {colors: ['#5ee7df', '#b490ca'], options: {interpolation: 'hsv'}},
+	passion: {colors: ['#f43b47', '#453a94'], options: {}},
+	fruit: {colors: ['#ff4e50', '#f9d423'], options: {}},
+	instagram: {colors: ['#833ab4', '#fd1d1d', '#fcb045'], options: {}},
+	retro: {colors: ['#3f51b1', '#5a55ae', '#7b5fac', '#8f6aae', '#a86aa4', '#cc6b8e', '#f18271', '#f3a469', '#f7c978'], options: {}},
+	summer: {colors: ['#fdbb2d', '#22c1c3'], options: {}},
+	rainbow: {colors: ['#ff0000', '#ff0100'], options: {interpolation: 'hsv', hsvSpin: 'long'}},
+	pastel: {colors: ['#74ebd5', '#74ecd5'], options: {interpolation: 'hsv', hsvSpin: 'long'}}
+};
 
-module.exports.atlas = str => new InitGradient('#feac5e', '#c779d0', '#4bc0c8')(str);
-module.exports.cristal = str => new InitGradient('#bdfff3', '#4ac29a')(str);
-module.exports.teen = str => new InitGradient('#77a1d3', '#79cbca', '#e684ae')(str);
-module.exports.mind = str => new InitGradient('#473b7b', '#3584a7', '#30d2be')(str);
-module.exports.morning = str => new InitGradient('#ff5f6d', '#ffc371')(str, {interpolation: 'hsv'});
-module.exports.vice = str => new InitGradient('#5ee7df', '#b490ca')(str, {interpolation: 'hsv'});
-module.exports.passion = str => new InitGradient('#f43b47', '#453a94')(str);
-module.exports.fruit = str => new InitGradient('#ff4e50', '#f9d423')(str);
-module.exports.instagram = str => new InitGradient('#833ab4', '#fd1d1d', '#fcb045')(str);
-module.exports.retro = str => new InitGradient('#3f51b1', '#5a55ae', '#7b5fac', '#8f6aae', '#a86aa4', '#cc6b8e', '#f18271', '#f3a469', '#f7c978')(str);
-module.exports.summer = str => new InitGradient('#fdbb2d', '#22c1c3')(str);
-module.exports.rainbow = str => new InitGradient('#ff0000', '#ff0100')(str, {interpolation: 'hsv', hsvSpin: 'long'});
-module.exports.pastel = str => new InitGradient('#74ebd5', '#74ecd5')(str, {interpolation: 'hsv', hsvSpin: 'long'});
+module.exports = InitGradient;
+for (const a in aliases) { // eslint-disable-line guard-for-in
+	module.exports[a] = str => new InitGradient(aliases[a].colors)(str, aliases[a].options);
+	module.exports[a].multiline = str => new InitGradient(aliases[a].colors).multiline(str, aliases[a].options);
+}

package.json

@@ -1,11 +1,11 @@
 {
   "name": "gradient-string",
   "description": "Beautiful gradients in terminal stdout",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "author": "Boris K",
   "bugs": "https://github.com/bokub/gradient-string/issues",
   "dependencies": {
-    "chalk": "^2.1.0",
+    "chalk": "^2.2.0",
     "tinygradient": "^0.3.1"
   },
   "devDependencies": {

test.js

@@ -36,6 +36,22 @@ test('works fine', t => {
 		'\u001b[91ma\u001b[39m\u001b[34mb\u001b[39m\u001b[32mc\u001b[39m'); // Red -> blue -> green (long arc)
 });
 
+test('supports aliases', t => {
+	t.is(g.cristal('Hello world'), g('#bdfff3', '#4ac29a')('Hello world'));
+	t.is(g.pastel('Hello world'), g('#74ebd5', '#74ecd5')('Hello world', {interpolation: 'hsv', hsvSpin: 'long'}));
+});
+
+test('multiline option works the same way on one line strings', t => {
+	t.is(g('blue', 'white', 'red').multiline('abc'), g('blue', 'white', 'red')('abc'));
+	t.is(g('red', 'green').multiline('abc', {interpolation: 'hsv'}), g('red', 'green')('abc', {interpolation: 'hsv'}));
+});
+
+test('multiline option works fine', t => {
+	t.is(g('orange', 'purple').multiline('hello\nworld'), g('orange', 'purple')('hello') + '\n' + g('orange', 'purple')('world'));
+	t.is(g.atlas.multiline('abc\n\ndef'), g.atlas('abc') + '\n\n' + g.atlas('def'));
+	t.not(g.rainbow.multiline('hi\nworld'), g.rainbow('hi') + '\n' + g.rainbow('world'));
+});
+
 test('case insensitive options', t => {
 	t.is(g('red', 'green')('abc', {interpolation: 'hsv', hsvSpin: 'long'}), g('red', 'green')('abc', {interpolation: 'HSV', hsvSpin: 'Long'}));
 });