orbit-oss/chalk
5
4
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added wrapper support

Browse source 
The wrapper marks the unprintable characters from each style tag.
This is very useful when debugging or outputing it in different terminals. You can use it to identify the unprintable characters or even to escape them.

Also added tests for it.
Added a description about it to the readme dile.
wq
This commit is contained in:
Felipe 2018-02-04 15:10:22 -02:00
parent 6554030550
commit 503159805f
5 changed files with 65 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
index.js
View file

@ -22,6 +22,10 @@ function applyOptions(obj, options) {
const scLevel = supportsColor ? supportsColor.level : 0;
obj.level = options.level === undefined ? scLevel : options.level;
obj.enabled = 'enabled' in options ? options.enabled : obj.level > 0;
// By default, wrappers are empty strings
const defaultWrapper = {pre: '', post: ''};
obj.wrapper = typeof options.wrapper === 'object' ? Object.assign({}, defaultWrapper, options.wrapper) : defaultWrapper;
}
function Chalk(options) {
@ -149,6 +153,9 @@ function build(_styles, _empty, key) {
// See below for fix regarding invisible grey/dim combination on Windows
builder.hasGrey = this.hasGrey || key === 'gray' || key === 'grey';
// Setting the wrapper in case it is being used
builder.wrapper = this.wrapper;
// `__proto__` is used because we must return a function, but there is
// no way to create a function with a different prototype
builder.__proto__ = proto; // eslint-disable-line no-proto
@ -189,12 +196,15 @@ function applyStyle() {
// Replace any instances already present with a re-opening code
// otherwise only the part of the string until said closing code
// will be colored, and the rest will simply be 'plain'.
str = code.open + str.replace(code.closeRe, code.open) + code.close;
const open = this.wrapper.pre + code.open + this.wrapper.post;
const close = this.wrapper.pre + code.close + this.wrapper.post;
str = open + str.replace(code.closeRe, code.open) + close;
// Close the styling before a linebreak and reopen
// after next line to fix a bleed issue on macOS
// https://github.com/chalk/chalk/pull/92
str = str.replace(/\r?\n/g, `${code.close}$&${code.open}`);
str = str.replace(/\r?\n/g, `${close}$&${open}`);
}
// Reset the original `dim` if we changed it to work around the Windows dimmed gray issue