Skip to content

Add support for NO_COLOR environment variable (Without Env Manager) #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EyLuismi wants to merge 1 commit into
base: master
Choose a base branch
from
+235 −1
Open

Add support for NO_COLOR environment variable (Without Env Manager) #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions colorize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ class Colorizer {
message = level;
}

if (this.isColorDisabledByEnvVar()) {
return message;
}

//
// If the color for the level is just a string
// then attempt to colorize the message with it.
Expand Down Expand Up @@ -104,6 +108,21 @@ class Colorizer {

return info;
}

isColorDisabledByEnvVar() {
// eslint-disable-next-line no-process-env
const NO_COLOR = process.env.NO_COLOR;
/**
* If the environment variable NO_COLOR is truthy, the style of the output
* is automatically disabled.
*/
const COLOR_DISABLED = NO_COLOR &&
NO_COLOR !== '0' &&
NO_COLOR !== 'false' &&
NO_COLOR !== 'undefined';

return COLOR_DISABLED;
}
}

/*
Expand Down
5 changes: 5 additions & 0 deletions test/cli.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ const { LEVEL, MESSAGE } = require('triple-beam');
describe('cli', () => {
before(setupLevels);

beforeEach(() => {
// eslint-disable-next-line no-process-env
process.env.NO_COLOR = undefined;
});

it('cli() (default) sets info[MESSAGE]', assumeFormatted(
cli(),
infoify({ level: 'info', message: 'whatever' }),
Expand Down
166 changes: 166 additions & 0 deletions test/colorize.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable no-process-env */
'use strict';

const assume = require('assume');
Expand All @@ -12,9 +13,14 @@ const {
setupLevels
} = require('./helpers');

// eslint-disable-next-line max-statements
describe('colorize', () => {
before(setupLevels);

beforeEach(() => {
process.env.NO_COLOR = undefined;
});

it('colorize() (default)', assumeFormatted(
colorize(),
infoify({ level: 'info', message: 'whatever' }),
Expand All @@ -26,6 +32,20 @@ describe('colorize', () => {
}
));

it('colorize() (default) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize(),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
}
);
});

it('colorize({ level: true })', assumeFormatted(
colorize({ level: true }),
infoify({ level: 'info', message: 'whatever' }),
Expand All @@ -37,6 +57,20 @@ describe('colorize', () => {
}
));

it('colorize({ level: true }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize({ level: true }),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
}
);
});

it('colorize{ message: true })', assumeFormatted(
colorize({ message: true }),
infoify({ level: 'info', message: 'whatever' }),
Expand All @@ -48,6 +82,20 @@ describe('colorize', () => {
}
));

it('colorize{ message: true }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize({ message: true }),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
}
);
});

it('colorize({ level: true, message: true })', assumeFormatted(
colorize({ level: true, message: true }),
infoify({ level: 'info', message: 'whatever' }),
Expand All @@ -59,6 +107,20 @@ describe('colorize', () => {
}
));

it('colorize({ level: true, message: true }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize({ level: true, message: true }),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
}
);
});

it('colorize({ all: true })', assumeFormatted(
colorize({ all: true }),
infoify({ level: 'info', message: 'whatever' }),
Expand All @@ -70,6 +132,20 @@ describe('colorize', () => {
}
));

it('colorize({ all: true }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize({ all: true }),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
}
);
});

it('colorize({ all: true }) [custom message]', assumeFormatted(
colorize({ all: true }),
{
Expand All @@ -88,6 +164,27 @@ describe('colorize', () => {
}
));

it('colorize({ all: true }) [custom message] when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
colorize({ all: true }),
{
level: 'info',
[LEVEL]: 'info',
message: 'whatever',
[MESSAGE]: '[info] whatever custom'
},
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info[LEVEL]).equals('info');
assume(info.level).equals('info');
assume(info.message).equals('whatever');
assume(info[MESSAGE]).equals('[info] whatever custom');
}
);
});

it('colorizes when LEVEL !== level', assumeFormatted(
colorize(),
{ [LEVEL]: 'info', level: 'INFO', message: 'whatever' },
Expand All @@ -97,6 +194,20 @@ describe('colorize', () => {
assume(info.level).equals(colors.green('INFO'));
}
));

it('colorizes when LEVEL !== level when NO_COLOR is enabled', () => {
process.env.NO_COLOR = 'true';

assumeFormatted(
colorize(),
{ [LEVEL]: 'info', level: 'INFO', message: 'whatever' },
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');
assume(info.level).equals('INFO');
}
);
});
});

describe('Colorizer', () => {
Expand All @@ -117,19 +228,46 @@ describe('Colorizer', () => {
);
});

it('Colorizer.addColors({ string: string }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
Colorizer.addColors({ weird: 'cyan' });

assume(Colorizer.allColors).deep.equals(
Object.assign({}, expected, { weird: 'cyan' })
);
});

it('Colorizer.addColors({ string: [Array] })', () => {
Colorizer.addColors({ multiple: ['red', 'bold'] });
assume(Colorizer.allColors.multiple).is.an('array');
assume(Colorizer.allColors.multiple).deep.equals(['red', 'bold']);
});

it('Colorizer.addColors({ string: [Array] }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
Colorizer.addColors({ multiple: ['red', 'bold'] });
assume(Colorizer.allColors.multiple).is.an('array');
assume(Colorizer.allColors.multiple).deep.equals(['red', 'bold']);
});

// eslint-disable-next-line no-useless-escape
it('Colorizer.addColors({ string: "(\w+)/s(\w+)" })', () => {
Colorizer.addColors({ delimited: 'blue underline' });
assume(Colorizer.allColors.delimited).deep.equals(['blue', 'underline']);
});

// eslint-disable-next-line no-useless-escape
it('Colorizer.addColors({ string: "(\w+)/s(\w+)" }) when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
Colorizer.addColors({ delimited: 'blue underline' });
assume(Colorizer.allColors.delimited).deep.equals(['blue', 'underline']);
});

describe('#colorize(LEVEL, level, message)', () => {
beforeEach(() => {
process.env.NO_COLOR = undefined;
});

const instance = new Colorizer();

it('colorize(level) [single color]', () => {
Expand All @@ -152,4 +290,32 @@ describe('Colorizer', () => {
);
});
});

describe('#colorize(LEVEL, level, message) when NO_COLOR env var is enabled', () => {
beforeEach(() => {
process.env.NO_COLOR = 'true';
});

const instance = new Colorizer();

it('colorize(level) [single color]', () => {
assume(instance.colorize('weird', 'weird')).equals('weird');
});

it('colorize(level) [multiple colors]', () => {
assume(instance.colorize('multiple', 'multiple')).equals(
'multiple'
);
});

it('colorize(level, message) [single color]', () => {
assume(instance.colorize('weird', 'weird', 'message')).equals('message');
});

it('colorize(level, message) [multiple colors]', () => {
assume(instance.colorize('multiple', 'multiple', 'message')).equals(
'message'
);
});
});
});
46 changes: 45 additions & 1 deletion test/uncolorize.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable no-process-env */
'use strict';

const assume = require('assume');
Expand Down Expand Up @@ -42,6 +43,10 @@ function addAndRemoveColors(opts = {}) {
describe('uncolorize', () => {
before(setupLevels);

beforeEach(() => {
process.env.NO_COLOR = undefined;
});

it('uncolorize() (default) removes all colors', assumeFormatted(
addAndRemoveColors(),
infoify({ level: 'info', message: 'whatever' }),
Expand Down Expand Up @@ -83,6 +88,29 @@ describe('uncolorize', () => {
}
));

it('same uncolorize() (default) preserves mutable level formatting when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';

assumeFormatted(
combine(
format(info => {
info.level = info.level.toUpperCase();
return info;
})(),
colorize(),
uncolorize()
),
{ [LEVEL]: 'info', level: 'info', message: 'whatever' },
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');

assume(info.level).equals('INFO');
assume(info.message).equals('whatever');
}
);
});

it('uncolorize() not crashing with Symbol()', assumeFormatted(
combine(
format(info => {
Expand Down Expand Up @@ -115,6 +143,23 @@ describe('uncolorize', () => {
}
));

it(
'same uncolorize({ level: false }) removes color from { message, [MESSAGE] } when NO_COLOR env var is enabled', () => {
process.env.NO_COLOR = 'true';
assumeFormatted(
addAndRemoveColors({ level: false }, true),
infoify({ level: 'info', message: 'whatever' }),
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');

assume(info.level).equals('info');
assume(info.message).equals('whatever');
assume(info[MESSAGE]).equals('info: whatever');
}
);
});

it('uncolorize({ message: false }) removes color from { level, [MESSAGE] }', assumeFormatted(
addAndRemoveColors({ message: false }),
infoify({ level: 'info', message: 'whatever' }),
Expand Down Expand Up @@ -147,7 +192,6 @@ describe('uncolorize', () => {
info => {
assume(info.level).is.a('string');
assume(info.message).is.a('string');

assume(info.level).equals(colors.green('info'));
assume(info.message).equals(colors.green('whatever'));
assume(info[MESSAGE]).equals('info: whatever');
Expand Down