Rename color aliases to notations (#79)

Notations is a better name for this as that it what they actually are: different notations of the same color value.

Author: bartveneman

src/analyzer/values/colors.js

@@ -53,17 +53,18 @@ function extractColorsFromDeclaration(declaration) {
 const addCount = color => {
   return {
     ...color,
-    count: color.aliases.reduce((acc, curr) => {
-      return acc + curr.count
+    count: color.notations.reduce((total, {count}) => {
+      return total + count
     }, 0)
   }
 }
 
-const addShortestNotation = color => {
+const addMostCommonNotation = color => {
   return {
     ...color,
-    value: [...color.aliases]
+    value: [...color.notations]
       .sort((a, b) => {
+        // If counts are the same, get the shortest notation
         if (a.count === b.count) {
           return a.value.length - b.value.length
         }
@@ -74,23 +75,23 @@ const addShortestNotation = color => {
   }
 }
 
-const addAliases = (acc, curr) => {
+const addNotations = (acc, curr) => {
   if (!acc[curr.normalized]) {
     acc[curr.normalized] = {
-      aliases: []
+      notations: []
     }
   }
 
   acc[curr.normalized] = {
-    aliases: [...acc[curr.normalized].aliases, curr]
+    notations: [...acc[curr.normalized].notations, curr]
   }
 
   return acc
 }
 
 const filterDuplicateColors = color => {
   // Filter out the actual duplicate colors
-  return color.aliases.length > 1
+  return color.notations.length > 1
 }
 
 const validateColor = color => {
@@ -101,7 +102,7 @@ const normalizeColors = color => {
   // Add a normalized value
 
   // Avoid using TinyColor's toHslString() because it rounds
-  // the numbers and incorrectly reports aliases
+  // the numbers and incorrectly reports duplicates
   const {h, s, l, a} = tinycolor(color.value).toHsl()
   const normalized = a === 0 ? 0 : `h${h}s${s}l${l}a${a}`
 
@@ -115,23 +116,23 @@ const rmTmpProps = color => {
   // Remove temporary props that were needed for analysis
   return {
     ...color,
-    aliases: color.aliases.map(alias => {
-      const {normalized, ...restAlias} = alias
-      return restAlias
+    notations: color.notations.map(notation => {
+      const {normalized, ...colorProps} = notation
+      return colorProps
     })
   }
 }
 
-const withAliases = colors =>
+const withDuplicateNotations = colors =>
   Object.values(
     colors
       .filter(validateColor)
       .map(normalizeColors)
-      .reduce(addAliases, {})
+      .reduce(addNotations, {})
   )
     .filter(filterDuplicateColors)
     .map(addCount)
-    .map(addShortestNotation) // @TODO: use most often appearing color here
+    .map(addMostCommonNotation)
     .map(rmTmpProps)
 
 module.exports = declarations => {
@@ -148,6 +149,6 @@ module.exports = declarations => {
     total: all.length,
     unique,
     totalUnique,
-    duplicates: withAliases(unique)
+    duplicates: withDuplicateNotations(unique)
   }
 }

test/analyzer/values/output.json

@@ -276,7 +276,7 @@
       {
         "count": 2,
         "value": "rgba(0,0,0,0)",
-        "aliases": [
+        "notations": [
           {
             "value": "hsla(0,0%,0%,0)",
             "count": 1
@@ -290,7 +290,7 @@
       {
         "value": "rgba(100, 200, 10, .5)",
         "count": 2,
-        "aliases": [
+        "notations": [
           {
             "count": 1,
             "value": "rgba(100, 200, 10, .5)"
@@ -304,7 +304,7 @@
       {
         "value": "hsl(270,60%,70%)",
         "count": 3,
-        "aliases": [
+        "notations": [
           {
             "count": 1,
             "value": "hsl(270,60%,70%)"
@@ -322,7 +322,7 @@
       {
         "value": "hsl(270 60% 50% / .15)",
         "count": 4,
-        "aliases": [
+        "notations": [
           {
             "count": 1,
             "value": "hsl(270, 60%, 50%, 15%)"
@@ -344,7 +344,7 @@
       {
         "value": "#fff",
         "count": 4,
-        "aliases": [
+        "notations": [
           {
             "count": 1,
             "value": "hsl(360, 100%, 100%)"
@@ -366,7 +366,7 @@
       {
         "count": 8,
         "value": "black",
-        "aliases": [
+        "notations": [
           {
             "value": "hsl(0,0,0)",
             "count": 1