Merge pull request #79 from heyjul3s/feat/hextorgba

hexToRGBA

packages/hextorgb/README.md

@@ -1,11 +1,3 @@
 # `@artifak/hextorgb`
 
-A utility function to convert hexadecimal colour values to RGB or RGBA string.
-
-## Usage
-
-```
-const hextorgb = require('@artifak/hextorgb');
-
-// TODO: DEMONSTRATE API
-```
+A utility function to convert hexadecimal colour values to RGB string.

packages/hextorgb/__tests__/hextorgb.test.ts

@@ -1,6 +1,6 @@
 import {
-  hexToRGBA,
   hexToRGB,
+  getRGBvalues,
   splitHexToRGB,
   formatHexValue,
   expandShorthandHex,
@@ -68,33 +68,33 @@ describe('@artifak/hextorgb', () => {
     });
   });
 
-  describe('hexToRGB', () => {
+  describe('getRGBvalues', () => {
     it('returns an object with RGB values', () => {
-      expect(hexToRGB('#DF3EA1')).toMatchObject({
+      expect(getRGBvalues('#DF3EA1')).toMatchObject({
         r: 223,
         g: 62,
         b: 161
       });
     });
 
     it('returns UNDEFINED with invalid hex string values', () => {
-      expect(hexToRGB('Hello World')).toEqual(void 0);
+      expect(getRGBvalues('Hello World')).toEqual(void 0);
     });
   });
 
-  describe('hexToRGBA', () => {
-    it('returns a string RGBA value with valid hex and alpha values', () => {
-      expect(hexToRGBA('#DF3EA1', 0.5)).toEqual('rgba(223, 62, 161, 0.5)');
-      expect(hexToRGBA('#df3ea1', 0.5)).toEqual('rgba(223, 62, 161, 0.5)');
+  describe('hexToRGB', () => {
+    it('returns a string RGB value with valid hex and alpha values', () => {
+      expect(hexToRGB('#DF3EA1')).toEqual('rgb(223, 62, 161)');
+      expect(hexToRGB('#df3ea1')).toEqual('rgb(223, 62, 161)');
     });
 
     it('returns a string RGBA value with valid hex and default alpha values', () => {
-      expect(hexToRGBA('#DF3EA1')).toEqual('rgba(223, 62, 161, 1)');
-      expect(hexToRGBA('#df3ea1')).toEqual('rgba(223, 62, 161, 1)');
+      expect(hexToRGB('#DF3EA1')).toEqual('rgb(223, 62, 161)');
+      expect(hexToRGB('#df3ea1')).toEqual('rgb(223, 62, 161)');
     });
 
     it('returns UNDEFINED with invalid non-hexadecimal color string value', () => {
-      expect(hexToRGBA('Lorem Ipsum Dolor Sit Amet', 0.5)).toEqual(void 0);
+      expect(hexToRGB('Lorem Ipsum Dolor Sit Amet')).toEqual(void 0);
     });
   });
 });

packages/hextorgb/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@artifak/hextorgb",
   "version": "1.0.0",
-  "description": "Utility function to convert style hex colour codes to RGB or RGBA strings.",
-  "keywords": [],
+  "description": "Utility function to convert style hex colour codes to RGB string.",
+  "keywords": [
+    "color",
+    "RGB",
+    "hexadecimal",
+    "utilities"
+  ],
   "author": "Julian Low",
   "license": "MIT",
   "sideEffects": false,

packages/hextorgb/src/hextorgb.ts

@@ -1,14 +1,14 @@
 import { RGBColor } from './typings';
 
-export function hexToRGBA(hex: string, alpha = 1): string | void {
-  const color = hexToRGB(hex);
+export function hexToRGB(hex: string): string | void {
+  const color = getRGBvalues(hex);
 
   if (!!color) {
-    return `rgba(${color.r}, ${color.g}, ${color.b}, ${alpha})`;
+    return `rgb(${color.r}, ${color.g}, ${color.b})`;
   }
 }
 
-export function hexToRGB(hex: string): RGBColor | void {
+export function getRGBvalues(hex: string): RGBColor | void {
   const hexValue = formatHexValue(hex);
 
   if (!!hexValue) {

packages/hextorgb/src/index.ts

@@ -1,2 +1,2 @@
-export { hexToRGB, hexToRGBA } from './hextorgb';
+export { hexToRGB, getRGBvalues } from './hextorgb';
 export { RGBColor } from './typings';

packages/hextorgba/README.md

@@ -0,0 +1,3 @@
+# `@artifak/hextorgba`
+
+A utility function to convert hexadecimal colour values to RGBA string.

packages/hextorgba/__tests__/hextorgba.test.ts

@@ -0,0 +1,17 @@
+import { hexToRGBA } from '../src/hextorgba';
+
+describe('@artifak/hextorgba', () => {
+  it('returns a string RGBA value with valid hex and alpha values', () => {
+    expect(hexToRGBA('#DF3EA1', 0.5)).toEqual('rgba(223, 62, 161, 0.5)');
+    expect(hexToRGBA('#df3ea1', 0.5)).toEqual('rgba(223, 62, 161, 0.5)');
+  });
+
+  it('returns a string RGBA value with valid hex and default alpha values', () => {
+    expect(hexToRGBA('#DF3EA1')).toEqual('rgba(223, 62, 161, 1)');
+    expect(hexToRGBA('#df3ea1')).toEqual('rgba(223, 62, 161, 1)');
+  });
+
+  it('returns UNDEFINED with invalid non-hexadecimal color string value', () => {
+    expect(hexToRGBA('Lorem Ipsum Dolor Sit Amet', 0.5)).toEqual(void 0);
+  });
+});

packages/hextorgba/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@artifak/hextorgba",
+  "version": "1.0.0",
+  "description": "Utility function to convert style hex colour codes to RGBA string.",
+  "keywords": [
+    "color",
+    "RGBA",
+    "hexadecimal",
+    "utilities"
+  ],
+  "author": "Julian Low",
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "dist/hextorgba.cjs.js",
+  "module": "dist/hextorgba.esm.js",
+  "src": "src/index.ts",
+  "types": "dist/src/index.d.ts",
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/heyjul3s/artifak.git"
+  },
+  "scripts": {
+    "build": "rimraf dist && builder",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "bugs": {
+    "url": "https://github.com/heyjul3s/artifak/issues"
+  },
+  "homepage": "https://github.com/heyjul3s/artifak#readme",
+  "devDependencies": {
+    "@artifak/bundler": "^1.1.3"
+  },
+  "dependencies": {
+    "@artifak/hextorgb": "^1.0.0"
+  }
+}

packages/hextorgba/src/hextorgba.ts

@@ -0,0 +1,9 @@
+import { getRGBvalues } from '@artifak/hextorgb';
+
+export function hexToRGBA(hex: string, alpha = 1): string | void {
+  const color = getRGBvalues(hex);
+
+  if (!!color) {
+    return `rgba(${color.r}, ${color.g}, ${color.b}, ${alpha})`;
+  }
+}

packages/hextorgba/src/index.ts

@@ -0,0 +1,2 @@
+export { hexToRGBA } from './hextorgba';
+export { getRGBvalues } from '@artifak/hextorgb';

packages/hextorgba/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "."
+  },
+  "references": [],
+  "include": ["src"]
+}