v1.5.0 - theme support (#9)

* refactor: little refactor, preparing for theme implementation

* feat(themes): initial themes implementation

* improved theming, added tests and docs

* docs: updated themes.md added badge examples

* fix: little code styling

* docs: added theme options to badge signature

* refactor: renamed inverse to swap

* tests: added color tests

* docs: moved images into images folder

* refactor: improved creation of theme helper methods

* docs: improved themes docs

* feat(themes): added option to register new themes, and refactored a bit

* docs: updated theme docs

* tests: added more tests, and coverage badges

* docs: added table of contents

* docs: removed color list, as it's already in cli-color docs

* docs: added theme overrides explanation

* chore(release): 1.5.0

Author: nombrekeff

.tests/badge.test.js

@@ -40,6 +40,11 @@ test('Should work with null label and message bg', () => {
     expect(createEmptyBadge).not.toThrow();
 })
 
+test('Should work with incorrect xterm color', () => {
+    const createEmptyBadge = () => badge('test', 'label', { labelBg: -1, messageBg: 260 });
+    expect(createEmptyBadge).not.toThrow();
+})
+
 test('Should work with null label and message color', () => {
     const createEmptyBadge = () => badge('test', 'label', { labelColor: null, messageColor: null });
     expect(createEmptyBadge).not.toThrow();
@@ -86,7 +91,69 @@ test('Should work with forceLink', () => {
     expect(createEmptyBadge).not.toThrow();
 })
 
-test('Should return correctly formatted badge', () => {
-    const testBadge = badge('test', 'label', { labelBg: 32 });
-    expect(testBadge).toEqual(' test  label  ');
+test('Should work with theme', () => {
+    const createEmptyBadge = () => badge('test', 'label', { theme: 'green' });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Should work with theme', () => {
+    const createEmptyBadge = () => badge('test', 'label', { theme: 'green', invertTheme: true });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('badge.theme should work', () => {
+    const createEmptyBadge = () => badge.theme('red')('test', 'label');
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('badge.theme should work', () => {
+    const createEmptyBadge = () => badge.theme('red').swapped('test', 'label');
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('override label should work', () => {
+    badge.addTheme('replaceLbl', { label: 'hello' });
+    expect(
+        badge('lbl', 'msg', { theme: 'replaceLbl' })
+    ).toEqual("\u001b[100m\u001b[37m hello \u001b[39m\u001b[49m\u001b[44m\u001b[37m msg \u001b[39m\u001b[49m ");
+})
+
+
+test('override message should work', () => {
+    badge.addTheme('replaceLbl', { message: 'hello' });
+    expect(
+        badge('lbl', 'msg', { theme: 'replaceLbl' })
+    ).toEqual("\u001b[100m\u001b[37m lbl \u001b[39m\u001b[49m\u001b[44m\u001b[37m hello \u001b[39m\u001b[49m ");
+})
+
+// Xterm tests
+
+test('Label bg xterm [32]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { labelBg: 32 });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Message bg xterm [32]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { messageBg: 32 });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Label color xterm [32]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { labelColor: 32 });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Message color xterm [32]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { messageColor: 32 });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Label bg xterm [null]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { labelBg: null });
+    expect(createEmptyBadge).not.toThrow();
+})
+
+test('Label bg xterm [-1]', () => {
+    const createEmptyBadge = () => badge('test', 'label', { labelBg: -1 });
+    expect(createEmptyBadge).not.toThrow();
 })

.tests/bg-labels.test.js

@@ -0,0 +1,16 @@
+
+const { badge } = require('../index');
+const badgesTestData = require('./util/all-badges.js');
+
+function testLabelBg(color, expected) {
+    return () => {
+        const testBadge = badge('lbl', 'msg', { labelBg: color });
+        expect(testBadge).toEqual(expected);
+    };
+}
+
+const bgLabelsData = badgesTestData.bgLabels;
+
+for (let lblData of bgLabelsData) {
+    test('Bg label [green]', testLabelBg(lblData.color, lblData.badge));
+}

.tests/bg-messages.test.js

@@ -0,0 +1,15 @@
+const { badge } = require('../index');
+const badgesTestData = require('./util/all-badges.js');
+
+function testMessageBg(color, expected) {
+  return () => {
+    const testBadge = badge('lbl', 'msg', { messageBg: color });
+    expect(testBadge).toEqual(expected);
+  };
+}
+
+const bgMessagesData = badgesTestData.bgMessages;
+
+for (let msgData of bgMessagesData) {
+  test('Bg message [green]', testMessageBg(msgData.color, msgData.badge));
+}

.tests/color-labels.test.js

@@ -0,0 +1,16 @@
+
+const { badge } = require('../index');
+const badgesTestData = require('./util/all-badges.js');
+
+function testLabelColor(color, expected) {
+    return () => {
+        const testBadge = badge('lbl', 'msg', { labelColor: color });
+        expect(testBadge).toEqual(expected);
+    };
+}
+
+const colorLabelsData = badgesTestData.colorLabels;
+
+for (let lblData of colorLabelsData) {
+    test('Color label [green]', testLabelColor(lblData.color, lblData.badge));
+}

.tests/color-messages.test.js

@@ -0,0 +1,16 @@
+
+const { badge } = require('../index');
+const badgesTestData = require('./util/all-badges.js');
+
+function testMessageColor(color, expected) {
+    return () => {
+        const testBadge = badge('lbl', 'msg', { messageColor: color });
+        expect(testBadge).toEqual(expected);
+    };
+}
+
+const colorMessagesData = badgesTestData.colorMessages;
+
+for (let msgData of colorMessagesData) {
+    test('Color message [green]', testMessageColor(msgData.color, msgData.badge));
+}