Added CMYK Conversion

Author: PhoneDroid

Documentation/Conversions.md

@@ -28,3 +28,18 @@ All channels are integers in the range of  `0 - 255`
 | **Parameter** | ( R , G , B ) | ( R , G , B , A )
 
 <br>
+<br>
+
+## CMYK ( A )
+
+All channels are decimals of  `0 - 100`  <br>
+except for the alpha channel  `0 - 255`
+
+<br>
+
+|   | CMYK | CMYKA |
+|:-:|:----:|:-----:|
+| **Array**     | ( [ C , M , Y , K ] ) | ( [ C , M , Y , K , A ] )
+| **Parameter** | ( C , M , Y , K ) | ( C , M , Y , K , A )
+
+<br>

Documentation/Sources/CMYK.md

@@ -0,0 +1,44 @@
+
+# CMYK
+
+*Convert CMYK colors to HSL.*
+
+```JavaScript
+import { fromCMYK } from 'HSL'
+```
+
+<br>
+
+## Parameter
+
+*Supply the channels directly.*
+
+```JavaScript
+const cmyk = fromCMYK( C , M , Y , K );
+```
+
+<br>
+
+## Array
+
+*Pass the channels as an array.*
+
+```JavaScript
+const cmyk = fromCMYK([ C , M , Y , K ]);
+```
+
+<br>
+
+## Alpha
+
+*Optionally include an Alpha channel.*
+
+```JavaScript
+const cmyka = fromCMYK([ C , M , Y , K , A ]);
+```
+
+```JavaScript
+const cmyka = fromCMYK( C , M , Y , K , A );
+```
+
+<br>

Documentation/Sources/RGB.md

@@ -0,0 +1,44 @@
+
+# RGB
+
+*Convert RGB colors to HSL.*
+
+```JavaScript
+import { fromRGB } from 'HSL'
+```
+
+<br>
+
+## Parameter
+
+*Supply the channels directly.*
+
+```JavaScript
+const hsl = fromRGB( R , G , B );
+```
+
+<br>
+
+## Array
+
+*Pass the channels as an array.*
+
+```JavaScript
+const hsl = fromRGB([ R , G , B ]);
+```
+
+<br>
+
+## Alpha
+
+*Optionally include an Alpha channel.*
+
+```JavaScript
+const hsla = fromRGB([ R , G , B , A ]);
+```
+
+```JavaScript
+const hsla = fromRGB( R , G , B , A );
+```
+
+<br>

Documentation/Usage.md

@@ -1,8 +1,23 @@
 
+<br>
+
+<div align = center>
+
 # Usage
 
 *How to this module.*
 
+<br>
+<br>
+
+
+
+[![Button RGB]][RGB]   
+[![Button CMYK]][CMYK]
+
+</div>
+
+<br>
 <br>
 
 ## Import
@@ -25,49 +40,16 @@ import * as HSL from 'https://deno.land/x/hsl/mod.ts'
 }
 ```
 
-<br>
 <br>
 
-## RGB
 
-*Convert RGB colors to HSL.*
+<!----------------------------------------------------------------------------->
 
-```JavaScript
-import { fromRGB } from 'HSL'
-```
+[CMYK]: Sources/CMYK.md
+[RGB]: Sources/RGB.md
 
-<br>
 
-### As Parameter
-
-*Supply the channels directly.*
-
-```JavaScript
-const hsl = fromRGB( R , G , B );
-```
+<!---------------------------------[ Buttons ]--------------------------------->
 
-<br>
-
-### As Array
-
-*Pass the channels as an array.*
-
-```JavaScript
-const hsl = fromRGB([ R , G , B ]);
-```
-
-<br>
-
-### With Alpha
-
-*Optionally include an Alpha channel.*
-
-```JavaScript
-const hsla = fromRGB([ R , G , B , A ]);
-```
-
-```JavaScript
-const hsla = fromRGB( R , G , B , A );
-```
-
-<br>
+[Button CMYK]: https://img.shields.io/badge/CMYK-04ACE6?style=for-the-badge
+[Button RGB]: https://img.shields.io/badge/RGB-37814A?style=for-the-badge

Source/Sources/CMYK.js

@@ -0,0 +1,38 @@
+
+import fromRGB from './RGB.js'
+
+
+function toHSL(channels){
+    
+    const [ C , M , Y , K ] = channels
+        .map((channel) => channel / 100)
+        .map((channel) => 1 - channel)
+    
+    
+    return fromRGB([
+        255 * C * K ,
+        255 * M * K ,
+        255 * Y * K
+    ])
+}
+
+
+/*
+ *  [ C , M , Y , K , (A) ] -> [ H , S , L , (A) ]
+ */
+
+export default function fromCMYK(colors){
+    
+
+    if(colors.length === 1 || (typeof colors[2] !== 'number'))
+        colors = colors[0];
+
+    const hsl = toHSL(colors);
+
+    const alpha = colors[4];
+
+    if(alpha)
+        hsl.push(alpha);
+
+    return hsl;
+}

Source/RGB.js renamed to Source/Sources/RGB.js

@@ -76,15 +76,15 @@ function toHSL(input){
 
 export default function fromRGB(colors){
 
-  if(colors.length === 1 || (typeof colors[2] !== 'number'))
-    colors = colors[0];
+    if(colors.length === 1 || (typeof colors[2] !== 'number'))
+        colors = colors[0];
 
-  const hsl = toHSL(colors);
+    const hsl = toHSL(colors);
 
-  const alpha = colors[3];
+    const alpha = colors[3];
 
-  if(alpha)
-    hsl.push(alpha);
+    if(alpha)
+        hsl.push(alpha);
 
-  return hsl;
+    return hsl;
 }

Source/mod.ts

@@ -1,13 +1,25 @@
 
-import convertRGB from './RGB.js'
+import CMYK from './Sources/CMYK.js'
+import RGB from './Sources/RGB.js'
 
 
 /**
- *  @brief Converts an RGB color to HSL
- *  @param rgb Either ( R , G , B ) or ([ R , G , B ])
+ *  @brief Converts a RGB color to HSL
+ *  @param color Either ( R , G , B ) or ([ R , G , B ])
  *  @note Alpha channel can be included and won't be altered.
  */
 
-export function fromRGB ( ... rgb : number [] | number[][] ) : number [] {
-    return convertRGB ( rgb ) as number [];
+export function fromRGB ( ... color : number [] | number[][] ) : number [] {
+    return RGB( color ) as number [];
+}
+
+
+/**
+ *  @brief Converts a CMYK color to HSL
+ *  @param color Either ( C , M , Y , B ) or ([ R , G , B ])
+ *  @note Alpha channel can be included and won't be altered.
+ */
+
+export function fromCMYK ( ... color : number [] | number[][] ) : number [] {
+    return CMYK( color ) as number [];
 }

Tests/AssertColor.js

@@ -1,9 +1,14 @@
 
 
+import { fromCMYK , fromRGB } from 'HSL'
 import { assertEquals } from 'Assert'
-import { fromRGB } from 'HSL'
 
 
-export function assertRGBIsHSL(rgb,hsl){
-    assertEquals(fromRGB(rgb),hsl);
+export function assertRGBIsHSL(input,output){
+    assertEquals(fromRGB(input),output);
+}
+
+
+export function assertCMYKIsHSL(input,output){
+    assertEquals(fromCMYK(input),output);
 }

Tests/Sources/CMYK.js

@@ -0,0 +1,33 @@
+
+import { assertCMYKIsHSL } from 'AssertColor'
+
+const { test } = Deno;
+
+
+test('CMYK Array Conversion',() => {
+    
+    //  Black
+    
+    assertCMYKIsHSL([ 0 , 0 , 0 , 100 ],[ 0 , 0 , 0 ]);
+
+    
+    //  White
+    
+    assertCMYKIsHSL([ 0 , 0 , 0 , 0 ],[ 0 , 0 , 100 ]);
+    
+    
+    //  Red
+    
+    assertCMYKIsHSL([ 0 , 100 , 100 , 0 ],[ 0 , 100 , 50 ]);
+    
+    
+    //  Green
+    
+    assertCMYKIsHSL([ 100 , 0 , 100 , 0 ],[ 120 , 100 , 50 ]);
+    
+    
+    //  Blue
+    
+    assertCMYKIsHSL([ 100 , 100 , 0 , 0 ],[ 240 , 100 , 50 ]);
+
+})