reviewer-0058cb/chalk
1
0
Fork 0
forked from orbit-oss/chalk
Code Pull requests Activity

Deprecate chalk.constructor() in favor of new chalk.Instance() (#322)

Browse source
This commit is contained in:
Tom Sherman 2019-03-12 12:53:03 +00:00 • committed by Sindre Sorhus
parent 60959e05cf
commit de2f4cd606
11 changed files with 110 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

14
test/_flow.js
View file

@ -2,12 +2,12 @@
import chalk from '..';
// $ExpectError (Can't have typo in option name)
chalk.constructor({levl: 1});
chalk.constructor({level: 1});
new chalk.Instance({levl: 1});
new chalk.Instance({level: 1});
// $ExpectError (Option must have proper type)
new chalk.constructor({enabled: 'true'});
new chalk.constructor({enabled: true});
new chalk.Instance({enabled: 'true'});
new chalk.Instance({enabled: true});
// $ExpectError (Can't have typo in chalk method)
chalk.rd('foo');
@ -22,8 +22,8 @@ chalk.red.bgBlu.underline('foo');
chalk.red.bgBlue.underline('foo');
// $ExpectError (Level must be 0, 1, 2, or 3)
const badCtx = chalk.constructor({level: 4});
const ctx = chalk.constructor({level: 3});
const badCtx = chalk.Instance({level: 4});
const ctx = chalk.Instance({level: 3});
// $ExpectError (Can't have typo in method name)
ctx.gry('foo');
@ -41,7 +41,7 @@ chalk.enabled = true;
chalk.level = 10;
chalk.level = 1;
const chalkInstance = new chalk.constructor();
const chalkInstance = new chalk.Instance();
// $ExpectError (Can't have typo in method name)
chalkInstance.blu('foo');

14
test/chalk.js
View file

@ -83,17 +83,17 @@ test('line breaks should open and close colors', t => {
});
test('properly convert RGB to 16 colors on basic color terminals', t => {
t.is(new chalk.constructor({level: 1}).hex('#FF0000')('hello'), '\u001B[91mhello\u001B[39m');
t.is(new chalk.constructor({level: 1}).bgHex('#FF0000')('hello'), '\u001B[101mhello\u001B[49m');
t.is(new chalk.Instance({level: 1}).hex('#FF0000')('hello'), '\u001B[91mhello\u001B[39m');
t.is(new chalk.Instance({level: 1}).bgHex('#FF0000')('hello'), '\u001B[101mhello\u001B[49m');
});
test('properly convert RGB to 256 colors on basic color terminals', t => {
t.is(new chalk.constructor({level: 2}).hex('#FF0000')('hello'), '\u001B[38;5;196mhello\u001B[39m');
t.is(new chalk.constructor({level: 2}).bgHex('#FF0000')('hello'), '\u001B[48;5;196mhello\u001B[49m');
t.is(new chalk.constructor({level: 3}).bgHex('#FF0000')('hello'), '\u001B[48;2;255;0;0mhello\u001B[49m');
t.is(new chalk.Instance({level: 2}).hex('#FF0000')('hello'), '\u001B[38;5;196mhello\u001B[39m');
t.is(new chalk.Instance({level: 2}).bgHex('#FF0000')('hello'), '\u001B[48;5;196mhello\u001B[49m');
t.is(new chalk.Instance({level: 3}).bgHex('#FF0000')('hello'), '\u001B[48;2;255;0;0mhello\u001B[49m');
});
test('don\'t emit RGB codes if level is 0', t => {
t.is(new chalk.constructor({level: 0}).hex('#FF0000')('hello'), 'hello');
t.is(new chalk.constructor({level: 0}).bgHex('#FF0000')('hello'), 'hello');
t.is(new chalk.Instance({level: 0}).hex('#FF0000')('hello'), 'hello');
t.is(new chalk.Instance({level: 0}).bgHex('#FF0000')('hello'), 'hello');
});

33
test/constructor.js
View file

@ -1,34 +1,15 @@
import test from 'ava';
// Spoof supports-color
require('./_supports-color')(__dirname);
const chalk = require('..');
test('create an isolated context where colors can be disabled (by level)', t => {
const instance = new chalk.constructor({level: 0, enabled: true});
t.is(instance.red('foo'), 'foo');
t.is(chalk.red('foo'), '\u001B[31mfoo\u001B[39m');
instance.level = 2;
t.is(instance.red('foo'), '\u001B[31mfoo\u001B[39m');
});
test('Chalk.constructor should throw an expected error', t => {
const expectedError = t.throws(() => {
chalk.constructor();
});
test('create an isolated context where colors can be disabled (by enabled flag)', t => {
const instance = new chalk.constructor({enabled: false});
t.is(instance.red('foo'), 'foo');
t.is(chalk.red('foo'), '\u001B[31mfoo\u001B[39m');
instance.enabled = true;
t.is(instance.red('foo'), '\u001B[31mfoo\u001B[39m');
});
test('the `level` option should be a number from 0 to 3', t => {
/* eslint-disable no-new */
t.throws(() => {
new chalk.constructor({level: 10});
}, /should be an integer from 0 to 3/);
t.is(expectedError.message, '`chalk.constructor()` is deprecated. Use `new chalk.Instance()` instead.');
t.throws(() => {
new chalk.constructor({level: -1});
}, /should be an integer from 0 to 3/);
/* eslint-enable no-new */
new chalk.constructor(); // eslint-disable-line no-new
});
});

34
test/instance.js Normal file
View file

@ -0,0 +1,34 @@
import test from 'ava';
// Spoof supports-color
require('./_supports-color')(__dirname);
const chalk = require('..');
test('create an isolated context where colors can be disabled (by level)', t => {
const instance = new chalk.Instance({level: 0, enabled: true});
t.is(instance.red('foo'), 'foo');
t.is(chalk.red('foo'), '\u001B[31mfoo\u001B[39m');
instance.level = 2;
t.is(instance.red('foo'), '\u001B[31mfoo\u001B[39m');
});
test('create an isolated context where colors can be disabled (by enabled flag)', t => {
const instance = new chalk.Instance({enabled: false});
t.is(instance.red('foo'), 'foo');
t.is(chalk.red('foo'), '\u001B[31mfoo\u001B[39m');
instance.enabled = true;
t.is(instance.red('foo'), '\u001B[31mfoo\u001B[39m');
});
test('the `level` option should be a number from 0 to 3', t => {
/* eslint-disable no-new */
t.throws(() => {
new chalk.Instance({level: 10});
}, /should be an integer from 0 to 3/);
t.throws(() => {
new chalk.Instance({level: -1});
}, /should be an integer from 0 to 3/);
/* eslint-enable no-new */
});

40
test/template-literal.js
View file

@ -7,23 +7,23 @@ require('./_supports-color')(__dirname);
const chalk = require('..');
test('return an empty string for an empty literal', t => {
const instance = chalk.constructor();
const instance = new chalk.Instance();
t.is(instance``, '');
});
test('return a regular string for a literal with no templates', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`hello`, 'hello');
});
test('correctly perform template parsing', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`{bold Hello, {cyan World!} This is a} test. {green Woo!}`,
instance.bold('Hello,', instance.cyan('World!'), 'This is a') + ' test. ' + instance.green('Woo!'));
});
test('correctly perform template substitutions', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
const name = 'Sindre';
const exclamation = 'Neat';
t.is(instance`{bold Hello, {cyan.inverse ${name}!} This is a} test. {green ${exclamation}!}`,
@ -31,7 +31,7 @@ test('correctly perform template substitutions', t => {
});
test('correctly parse and evaluate color-convert functions', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
t.is(instance`{bold.rgb(144,10,178).inverse Hello, {~inverse there!}}`,
'\u001B[1m\u001B[38;2;144;10;178m\u001B[7mHello, ' +
'\u001B[27m\u001B[39m\u001B[22m\u001B[1m' +
@ -44,13 +44,13 @@ test('correctly parse and evaluate color-convert functions', t => {
});
test('properly handle escapes', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
t.is(instance`{bold hello \{in brackets\}}`,
'\u001B[1mhello {in brackets}\u001B[22m');
});
test('throw if there is an unclosed block', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
try {
console.log(instance`{bold this shouldn't appear ever\}`);
t.fail();
@ -67,7 +67,7 @@ test('throw if there is an unclosed block', t => {
});
test('throw if there is an invalid style', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
try {
console.log(instance`{abadstylethatdoesntexist this shouldn't appear ever}`);
t.fail();
@ -77,7 +77,7 @@ test('throw if there is an invalid style', t => {
});
test('properly style multiline color blocks', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
t.is(
instance`{bold
Hello! This is a
@ -97,49 +97,49 @@ test('properly style multiline color blocks', t => {
});
test('escape interpolated values', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`Hello {bold hi}`, 'Hello hi');
t.is(instance`Hello ${'{bold hi}'}`, 'Hello {bold hi}');
});
test('allow custom colors (themes) on custom contexts', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
instance.rose = instance.hex('#F6D9D9');
t.is(instance`Hello, {rose Rose}.`, 'Hello, \u001B[38;2;246;217;217mRose\u001B[39m.');
});
test('correctly parse newline literals (bug #184)', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`Hello
{red there}`, 'Hello\nthere');
});
test('correctly parse newline escapes (bug #177)', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`Hello\nthere!`, 'Hello\nthere!');
});
test('correctly parse escape in parameters (bug #177 comment 318622809)', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
const str = '\\';
t.is(instance`{blue ${str}}`, '\\');
});
test('correctly parses unicode/hex escapes', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`\u0078ylophones are fo\x78y! {magenta.inverse \u0078ylophones are fo\x78y!}`,
'xylophones are foxy! xylophones are foxy!');
});
test('correctly parses string arguments', t => {
const instance = chalk.constructor({level: 3});
const instance = new chalk.Instance({level: 3});
t.is(instance`{keyword('black').bold can haz cheezburger}`, '\u001B[38;2;0;0;0m\u001B[1mcan haz cheezburger\u001B[22m\u001B[39m');
t.is(instance`{keyword('blac\x6B').bold can haz cheezburger}`, '\u001B[38;2;0;0;0m\u001B[1mcan haz cheezburger\u001B[22m\u001B[39m');
t.is(instance`{keyword('blac\u006B').bold can haz cheezburger}`, '\u001B[38;2;0;0;0m\u001B[1mcan haz cheezburger\u001B[22m\u001B[39m');
});
test('throws if a bad argument is encountered', t => {
const instance = chalk.constructor({level: 3}); // Keep level at least 1 in case we optimize for disabled chalk instances
const instance = new chalk.Instance({level: 3}); // Keep level at least 1 in case we optimize for disabled chalk instances
try {
console.log(instance`{keyword(????) hi}`);
t.fail();
@ -149,7 +149,7 @@ test('throws if a bad argument is encountered', t => {
});
test('throws if an extra unescaped } is found', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
try {
console.log(instance`{red hi!}}`);
t.fail();
@ -159,12 +159,12 @@ test('throws if an extra unescaped } is found', t => {
});
test('should not parse upper-case escapes', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`\N\n\T\t\X07\x07\U000A\u000A\U000a\u000a`, 'N\nT\tX07\x07U000A\u000AU000a\u000A');
});
test('should properly handle undefined template interpolated values', t => {
const instance = chalk.constructor({level: 0});
const instance = new chalk.Instance({level: 0});
t.is(instance`hello ${undefined}`, 'hello undefined');
t.is(instance`hello ${null}`, 'hello null');
});

8
test/visible.js
View file

@ -6,25 +6,25 @@ require('./_supports-color')(__dirname);
const chalk = require('..');
test('visible: normal output when enabled', t => {
const instance = new chalk.constructor({level: 3, enabled: true});
const instance = new chalk.Instance({level: 3, enabled: true});
t.is(instance.visible.red('foo'), '\u001B[31mfoo\u001B[39m');
t.is(instance.red.visible('foo'), '\u001B[31mfoo\u001B[39m');
});
test('visible: no output when disabled', t => {
const instance = new chalk.constructor({level: 3, enabled: false});
const instance = new chalk.Instance({level: 3, enabled: false});
t.is(instance.red.visible('foo'), '');
t.is(instance.visible.red('foo'), '');
});
test('visible: no output when level is too low', t => {
const instance = new chalk.constructor({level: 0, enabled: true});
const instance = new chalk.Instance({level: 0, enabled: true});
t.is(instance.visible.red('foo'), '');
t.is(instance.red.visible('foo'), '');
});
test('test switching back and forth between enabled and disabled', t => {
const instance = new chalk.constructor({level: 3, enabled: true});
const instance = new chalk.Instance({level: 3, enabled: true});
t.is(instance.red('foo'), '\u001B[31mfoo\u001B[39m');
t.is(instance.visible.red('foo'), '\u001B[31mfoo\u001B[39m');
t.is(instance.red.visible('foo'), '\u001B[31mfoo\u001B[39m');